com.soundhelix.component.songnameengine.impl

Class CFGSongNameEngine

java.lang.Object

com.soundhelix.component.songnameengine.impl.AbstractSongNameEngine

com.soundhelix.component.songnameengine.impl.CFGSongNameEngine

All Implemented Interfaces:

Component, RandomSeedable, SongNameEngine, XMLConfigurable

public class CFGSongNameEngine
extends AbstractSongNameEngine

Implements a flexible song name engine based on a context-free grammar.

Author:

Thomas Schuerger (thomas@schuerger.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CFGSongNameEngine.RandomStrings Container for random strings.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	startVariable The start variable.
protected char	stringSeparator The separator.
protected static Pattern	VARIABLE_PATTERN The pattern for variable replacement.
protected Map<String,CFGSongNameEngine.RandomStrings>	variableMap The variable map.

Fields inherited from class com.soundhelix.component.songnameengine.impl.AbstractSongNameEngine

randomSeed

Constructor Summary

Constructors

Constructor and Description
CFGSongNameEngine()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(SongContext songContext, Node node) Configures the instance using the specified XML node.
String	createSongName() Generates and returns a song name.
Map<String,CFGSongNameEngine.RandomStrings>	getVariableMap()
static String	replaceVariables(String string, Map<String,CFGSongNameEngine.RandomStrings> variableMap, Random random) Recursively replaces all variables in the given string by a randomly chosen value from the corresponding variable map values.
void	setVariableMap(Map<String,CFGSongNameEngine.RandomStrings> variableMap)

Methods inherited from class com.soundhelix.component.songnameengine.impl.AbstractSongNameEngine

getRandomSeed, setRandomSeed

Methods inherited from class java.lang.Object

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

Field Detail

VARIABLE_PATTERN

protected static final Pattern VARIABLE_PATTERN

The pattern for variable replacement.

variableMap

protected Map<String,CFGSongNameEngine.RandomStrings> variableMap

The variable map.

startVariable

protected String startVariable

The start variable.

stringSeparator

protected char stringSeparator

The separator.

Constructor Detail

CFGSongNameEngine

public CFGSongNameEngine()

Method Detail

createSongName

public String createSongName()

Description copied from interface: SongNameEngine

Generates and returns a song name.

Returns:

a song name

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

replaceVariables

public static String replaceVariables(String string,
                      Map<String,CFGSongNameEngine.RandomStrings> variableMap,
                      Random random)

Recursively replaces all variables in the given string by a randomly chosen value from the corresponding variable map values.

Parameters:

string - the string to perform replacements in

variableMap - the variable map

random - the random generator to use

Returns:

the string with all variables replaced

getVariableMap

public Map<String,CFGSongNameEngine.RandomStrings> getVariableMap()

setVariableMap

public void setVariableMap(Map<String,CFGSongNameEngine.RandomStrings> variableMap)