com.soundhelix.misc

Class SongContext

java.lang.Object

com.soundhelix.misc.SongContext

public class SongContext
extends Object

Defines the context of a song. During song generation, the context is enriched with information. Each of the fields can only be set to at most once. Custom attributes can be set in the song context to pass custom data along between components.

Author:

Thomas Schuerger (thomas@schuerger.com)

Constructor Summary

Constructors

Constructor and Description
SongContext()

Method Summary

Methods

Modifier and Type	Method and Description
ActivityMatrix	getActivityMatrix()
Arrangement	getArrangement()
Object	getAttribute(String name) Returns the attribute with the given name.
Harmony	getHarmony()
Player	getPlayer()
Long	getRandomSeed()
String	getSongName()
Structure	getStructure()
boolean	hasAttribute(String name) Checks if the given attribute has been set.
void	removeAttribute(String name) Removes the given attribute.
void	setActivityMatrix(ActivityMatrix activityMatrix)
void	setArrangement(Arrangement arrangement)
void	setAttribute(String name, Object value) Sets the attribute to the given value.
void	setHarmony(Harmony harmony)
void	setPlayer(Player player)
void	setRandomSeed(Long randomSeed)
void	setSongName(String songName)
void	setStructure(Structure structure)

Methods inherited from class java.lang.Object

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

Constructor Detail

SongContext

public SongContext()

Method Detail

getRandomSeed

public Long getRandomSeed()

setRandomSeed

public void setRandomSeed(Long randomSeed)

getSongName

public String getSongName()

setSongName

public void setSongName(String songName)

getStructure

public Structure getStructure()

setStructure

public void setStructure(Structure structure)

getHarmony

public Harmony getHarmony()

setHarmony

public void setHarmony(Harmony harmony)

getActivityMatrix

public ActivityMatrix getActivityMatrix()

setActivityMatrix

public void setActivityMatrix(ActivityMatrix activityMatrix)

getArrangement

public Arrangement getArrangement()

setArrangement

public void setArrangement(Arrangement arrangement)

getPlayer

public Player getPlayer()

setPlayer

public void setPlayer(Player player)

getAttribute

public Object getAttribute(String name)

Returns the attribute with the given name. If the attribute doesn't exist or it's value is null, null is returned.

Parameters:

name - the attribute name

Returns:

the attribute value

setAttribute

public void setAttribute(String name,
                Object value)

Sets the attribute to the given value. If the attribute is already set, it is replaced with the new value.

Parameters:

name - the attribute name

value - the attribute value

hasAttribute

public boolean hasAttribute(String name)

Checks if the given attribute has been set. Can be used to distinguish null values from non-existing values.

Parameters:

name - the attribute name

Returns:

true if the attribute is set, false otherwise

removeAttribute

public void removeAttribute(String name)

Removes the given attribute. If the attribute is not set, nothing is done.

Parameters:

name - the attribute name