com.soundhelix.component.patternengine.impl

Class StringPatternEngine

java.lang.Object

com.soundhelix.component.patternengine.impl.AbstractPatternEngine

com.soundhelix.component.patternengine.impl.StringPatternEngine

All Implemented Interfaces:

Component, PatternEngine, RandomSeedable, XMLConfigurable

Direct Known Subclasses:

CrescendoPatternEngine, RandomFragmentPatternEngine, RandomPatternEngine

public class StringPatternEngine
extends AbstractPatternEngine

Implements a PatternEngine that reads the pattern directly from a string.

Author:

Thomas Schuerger (thomas@schuerger.com)

Field Summary

Fields inherited from class com.soundhelix.component.patternengine.impl.AbstractPatternEngine

logger, randomSeed

Constructor Summary

Constructors

Constructor and Description
StringPatternEngine()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(SongContext songContext, Node node) Configures the instance using the specified XML node.
String	getPatternString()
Pattern	render(SongContext songContext, String wildcardString) Generates a pattern.
void	setPatternString(String patternString)
void	setPatternTicksPerBeat(int patternTicksPerBeat)

Methods inherited from class com.soundhelix.component.patternengine.impl.AbstractPatternEngine

getRandomSeed, setRandomSeed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringPatternEngine

public StringPatternEngine()

Method Detail

render

public Pattern render(SongContext songContext,
             String wildcardString)

Description copied from interface: PatternEngine

Generates a pattern.

Parameters:

songContext - the song context

wildcardString - the string containing the wildcard characters

Returns:

the pattern entry

configure

public void configure(SongContext songContext,
             Node node)
               throws XPathException

Description copied from interface: XMLConfigurable

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

getPatternString

public String getPatternString()

setPatternString

public void setPatternString(String patternString)

setPatternTicksPerBeat

public void setPatternTicksPerBeat(int patternTicksPerBeat)