com.soundhelix.component

Interface XMLConfigurable

All Known Subinterfaces:

ArrangementEngine, Component, HarmonyEngine, LFO, PatternEngine, Player, SequenceEngine, SongNameEngine

All Known Implementing Classes:

AbstractArrangementEngine, AbstractFreeMultiPatternSequenceEngine, AbstractHarmonyEngine, AbstractLFO, AbstractMultiPatternSequenceEngine, AbstractPatternEngine, AbstractPlayer, AbstractSequenceEngine, AbstractSongNameEngine, ArpeggioSequenceEngine, CFGSongNameEngine, ChordSequenceEngine, CrescendoPatternEngine, DrumSequenceEngine, FreeMultiPatternSequenceEngine, FreePatternSequenceEngine, LFOSequenceLFO, LinearRandomLFO, MelodySequenceEngine, MidiPlayer, MultiPatternSequenceEngine, PadSequenceEngine, PatternHarmonyEngine, PatternSequenceEngine, RandomFragmentPatternEngine, RandomPatternEngine, RectangleLFO, SawtoothLFO, SimpleArrangementEngine, SineLFO, StringPatternEngine, TriangleLFO

public interface XMLConfigurable

Simple interface that adds XML-configurability to a class. XML configuration is based on DOM and XPath.

Author:

Thomas Schuerger (thomas@schuerger.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(SongContext songContext, Node node) Configures the instance using the specified XML node.

Method Detail

configure

void configure(SongContext songContext,
             Node node)
               throws XPathException

Configures the instance using the specified XML node. The method should read all supported configuration tags and should call the corresponding setter methods of the class. All settings of the class that are settable using XML should also be settable by using public methods (for example, if the beats per minute are settable using an XML tag, then the class should also provide a public method setBPM(), which does the same). XML configuration can also be a recursive process, if XML settings contain nodes that require XML configuration themselves, but this is up to the implementation of this method. The method should (but need not) use XPath to access the node's tags. Only the node and its descendant nodes may be used for configuration.

Parameters:

songContext - the song context

node - the parent XML node of the configuration tags

Throws:

XPathException - in case of an XPath problem