Class CompositeRhythm

java.lang.Object

org.jjazz.yamjjazz.rhythm.api.CompositeRhythm

All Implemented Interfaces:

Comparable<Rhythm>, Rhythm, ConfigurableMusicGeneratorProvider, MusicGeneratorProvider, YamJJazzRhythm

public class CompositeRhythm
extends Object
implements YamJJazzRhythm

A YamJJazzRhythm whose tracks can be replaced by tracks from other rhythms (or possibly from base rhythm).

See Also:

• CompositeMusicGenerator

Field Summary

Fields inherited from interface org.jjazz.rhythm.api.Rhythm

PROP_RESOURCES_LOADED

Constructor Summary

Constructors

Constructor	Description
CompositeRhythm(YamJJazzRhythm baseRhythm)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)
AccType	getAccType(String rpMuteValue)	Get the AccType corresponding to a RP_SYS_Mute value.
String	getAuthor()
YamJJazzRhythm	getBaseRhythm()	The underlying base rhythm of this CompositeRhythm.
int	getComplexityLevel(String rpValue)	Analyze the RP_Variation value produced by buildRhythmParameters() to retrieve the complexity level.
String	getDescription()
RhythmVoice	getDestRhythmVoice(RhythmVoice rvSrc)	Get the destination RhythmVoice of rvSrc.
RhythmFeatures	getFeatures()	The general features of this rhythm.
File	getFile()	Optional file from which this rhythm was loaded.
Set<RhythmVoice>	getMappedSrcRhythmVoices()	Get all the mapped source RhythmVoices.
MusicGenerator	getMusicGenerator()
String	getName()
int	getPreferredTempo()
List<RhythmParameter<?>>	getRhythmParameters()
List<RhythmVoice>	getRhythmVoices()
Style	getStyle()	The Style object associated to this rhythm.
StylePart	getStylePart(String rpValue)	Analyze a RhythmParameter String value produced by buildRhythmParameters() to retrieve the corresponding StylePart.
TimeSignature	getTimeSignature()
String	getUniqueId()	A unique string identifier representing this rhythm.
boolean	isExtendedRhythm()	True if it's an extended rhythm, false if it's a standard Yamaha rhythm.
boolean	isResourcesLoaded()
void	loadResources()	Tell the rhythm it may load any memory-heavy resources.
void	releaseResources()	Ask the rhythm to release any memory-heavy resources.
void	removePropertyChangeListener(PropertyChangeListener l)
void	setDestRhythmVoice(RhythmVoice rvSrc, RhythmVoice rvDest)	Map a RhythmVoice from this rhythm to another RhythmVoice (from this rhythm or another).
void	setMusicGenerator(MusicGenerator mg)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jjazz.rhythm.api.Rhythm

compareTo, getTags, getVersion

Methods inherited from interface org.jjazz.yamjjazz.rhythm.api.YamJJazzRhythm

getRhythmVoice

Constructor Details

CompositeRhythm

public CompositeRhythm(YamJJazzRhythm baseRhythm)

Method Details

getBaseRhythm

public YamJJazzRhythm getBaseRhythm()

The underlying base rhythm of this CompositeRhythm.

Returns:

setDestRhythmVoice

public void setDestRhythmVoice(RhythmVoice rvSrc,
 RhythmVoice rvDest)

Map a RhythmVoice from this rhythm to another RhythmVoice (from this rhythm or another).

Fire a PROP_RHYTHM_VOICE_MAPPING change event.

Parameters:

rvSrc - From this CompositeRhythm

rvDest - If null mapping is removed. Container must be a YamJJazzRhythm.

getDestRhythmVoice

public RhythmVoice getDestRhythmVoice(RhythmVoice rvSrc)

Get the destination RhythmVoice of rvSrc.

Parameters:

rvSrc - From this CompositeRhythm

Returns:

Null if not mapped

getMappedSrcRhythmVoices

public Set<RhythmVoice> getMappedSrcRhythmVoices()

Get all the mapped source RhythmVoices.

Returns:

getFeatures

public RhythmFeatures getFeatures()

Description copied from interface: Rhythm

The general features of this rhythm.

Specified by:

getFeatures in interface Rhythm

Returns:

loadResources

public void loadResources()
                   throws MusicGenerationException

Description copied from interface: Rhythm

Tell the rhythm it may load any memory-heavy resources.

This will fire a PROP_RESOURCES_LOADED change event with newValue=true.

Specified by:

loadResources in interface Rhythm

Throws:

MusicGenerationException

See Also:

• Rhythm.releaseResources()

releaseResources

public void releaseResources()

Description copied from interface: Rhythm

Ask the rhythm to release any memory-heavy resources.

This will fire a PROP_RESOURCES_LOADED change event with newValue=false.

Specified by:

releaseResources in interface Rhythm

See Also:

• Rhythm.loadResources()

isResourcesLoaded

public boolean isResourcesLoaded()

Specified by:

isResourcesLoaded in interface Rhythm

getRhythmVoices

public List<RhythmVoice> getRhythmVoices()

Specified by:

getRhythmVoices in interface Rhythm

Returns:

The voices for which this rhythm can generate music. Each voice must have a unique name.

getRhythmParameters

public List<RhythmParameter<?>> getRhythmParameters()

Specified by:

getRhythmParameters in interface Rhythm

Returns:

The RhythmParameters that influence the way this rhythm generates music.

getFile

public File getFile()

Description copied from interface: Rhythm

Optional file from which this rhythm was loaded.

Specified by:

getFile in interface Rhythm

Returns:

Can't be null, but can be an empty path ("") if no file associated.

getUniqueId

public String getUniqueId()

Description copied from interface: Rhythm

A unique string identifier representing this rhythm.

It will be used by other serialized objects who want to refer this rhythm -typically a Song object.

Specified by:

getUniqueId in interface Rhythm

Returns:

A non-empty String with spaces trimmed.

getDescription

public String getDescription()

Specified by:

getDescription in interface Rhythm

getPreferredTempo

public int getPreferredTempo()

Specified by:

getPreferredTempo in interface Rhythm

getTimeSignature

public TimeSignature getTimeSignature()

Specified by:

getTimeSignature in interface Rhythm

getName

public String getName()

Specified by:

getName in interface Rhythm

getAuthor

public String getAuthor()

Specified by:

getAuthor in interface Rhythm

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface Rhythm

Parameters:

l -

See Also:

• Rhythm.loadResources()
• Rhythm.releaseResources()

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface Rhythm

Parameters:

l -

See Also:

• Rhythm.loadResources()
• Rhythm.releaseResources()

getAccType

public AccType getAccType(String rpMuteValue)

Description copied from interface: YamJJazzRhythm

Get the AccType corresponding to a RP_SYS_Mute value.

Specified by:

getAccType in interface YamJJazzRhythm

Parameters:

rpMuteValue - Can't be null

Returns:

Can be null if rpMuteValue is an empty string.

getComplexityLevel

public int getComplexityLevel(String rpValue)

Description copied from interface: YamJJazzRhythm

Analyze the RP_Variation value produced by buildRhythmParameters() to retrieve the complexity level.

Specified by:

getComplexityLevel in interface YamJJazzRhythm

Parameters:

rpValue - eg "Main A-2"

Returns:

eg 2, or -1 if no match.

getStyle

public Style getStyle()

Description copied from interface: YamJJazzRhythm

The Style object associated to this rhythm.

Specified by:

getStyle in interface YamJJazzRhythm

Returns:

getStylePart

public StylePart getStylePart(String rpValue)

Description copied from interface: YamJJazzRhythm

Analyze a RhythmParameter String value produced by buildRhythmParameters() to retrieve the corresponding StylePart.

Specified by:

getStylePart in interface YamJJazzRhythm

Parameters:

rpValue - eg "Main A-2"

Returns:

Main_A or null if no match

isExtendedRhythm

public boolean isExtendedRhythm()

Description copied from interface: YamJJazzRhythm

True if it's an extended rhythm, false if it's a standard Yamaha rhythm.

Specified by:

isExtendedRhythm in interface YamJJazzRhythm

Returns:

getMusicGenerator

public MusicGenerator getMusicGenerator()

Specified by:

getMusicGenerator in interface MusicGeneratorProvider

setMusicGenerator

public void setMusicGenerator(MusicGenerator mg)

Specified by:

setMusicGenerator in interface ConfigurableMusicGeneratorProvider