Class DefaultRhythmDatabase

java.lang.Object

org.jjazz.rhythmdatabase.api.DefaultRhythmDatabase

All Implemented Interfaces:

RhythmDatabase

public class DefaultRhythmDatabase
extends Object
implements RhythmDatabase

RhythmDatabase default implementation.

Default rhythms are stored as Preferences.

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(ChangeListener l)	Listeners are notified when the rhythm database has changed.
boolean	addRhythm(RhythmProvider rp, RhythmInfo ri)	Add one RhythmInfo to the database for the specified RhythmProvider.
boolean	addRhythmInstance(RhythmProvider rp, Rhythm r)	Add one Rhythm instance to the database for the specified RhythmProvider.
MultipleErrorsReport	addRhythmsFromRhythmProviders(boolean excludeBuiltinRhythms, boolean excludeFileRhythms, boolean forceFileRhythmsRescan)	Poll RhythmProvider instances from the global lookup to add rhythms.
AdaptedRhythm	getAdaptedRhythmInstance(Rhythm r, TimeSignature ts)	Try to provide the rhythm instance which is an adapted version of r for a different time signature.
RhythmInfo	getDefaultRhythm(TimeSignature ts)	Get the default Rhythm for TimeSignature ts.
static RhythmDatabaseFactory	getFactoryInstance()	Get a factory which just provides the DefaultRhythmDatabase instance.
static DefaultRhythmDatabase	getInstance(Preferences prefs)
RhythmInfo	getRhythm(String rhythmId)	Get the RhythmInfo instance from the specified rhythm unique id.
Rhythm	getRhythmInstance(String rId)	Get a rhythm instance from its id.
Rhythm	getRhythmInstance(RhythmInfo ri)	Get a rhythm instance from a RhythmInfo.
RhythmProvider	getRhythmProvider(Rhythm r)
RhythmProvider	getRhythmProvider(RhythmInfo ri)	Get the RhythmProvider for specified RhythmInfo.
List<RhythmProvider>	getRhythmProviders()	The RhythmProviders used by this database.
List<RhythmInfo>	getRhythms(Predicate<RhythmInfo> tester)	Get the rhythms which are tested OK.
List<RhythmInfo>	getRhythms(RhythmProvider rp)	The rhythms associated to the specified RhythmProvider
void	removeChangeListener(ChangeListener l)
void	setDefaultRhythm(TimeSignature ts, RhythmInfo ri)	Set the default rhythm for this TimeSignature.
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jjazz.rhythmdatabase.api.RhythmDatabase

findRhythm, findRhythm, getDefaultStubRhythmInstance, getRhythms, getRhythms, getTimeSignatures, toContentString, toStatsString

Method Details

getInstance

public static DefaultRhythmDatabase getInstance(Preferences prefs)

Parameters:

prefs - The preferences to store the default rhythms (per time signature)

Returns:

getFactoryInstance

public static RhythmDatabaseFactory getFactoryInstance()

Get a factory which just provides the DefaultRhythmDatabase instance.

Returns:

getRhythmInstance

public Rhythm getRhythmInstance(RhythmInfo ri)
                         throws UnavailableRhythmException

Description copied from interface: RhythmDatabase

Get a rhythm instance from a RhythmInfo.

This might result in a lengthy operation (e.g. because of file reading). Rhythm instances are cached.

Specified by:

getRhythmInstance in interface RhythmDatabase

Parameters:

ri -

Returns:

Throws:

UnavailableRhythmException

getRhythm

public RhythmInfo getRhythm(String rhythmId)

Description copied from interface: RhythmDatabase

Get the RhythmInfo instance from the specified rhythm unique id.

RhyhmtInfo instances are cached.

Specified by:

getRhythm in interface RhythmDatabase

Parameters:

rhythmId -

Returns:

Can be null if not found.

getRhythms

public List<RhythmInfo> getRhythms(Predicate<RhythmInfo> tester)

Description copied from interface: RhythmDatabase

Get the rhythms which are tested OK.

Specified by:

getRhythms in interface RhythmDatabase

Parameters:

tester -

Returns:

getRhythmProviders

public List<RhythmProvider> getRhythmProviders()

Description copied from interface: RhythmDatabase

The RhythmProviders used by this database.

Specified by:

getRhythmProviders in interface RhythmDatabase

Returns:

getRhythmInstance

public Rhythm getRhythmInstance(String rId)
                         throws UnavailableRhythmException

Description copied from interface: RhythmDatabase

Get a rhythm instance from its id.

If rId contains 2 instances of the AdaptedRhythm.RHYTHM_ID_DELIMITER, then this id represents an AdaptedRhythm which is created on demand, see AdaptedRhythm.getUniqueId().In that case, the rhythm provider, the original rhythm and the time signature are obtained from rId, and the returned rhythm instance is obtained by calling RhythmProvider.getAdaptedRhythmInstance(Rhythm, TimeSignature).

Rhythm instances can be cached.

Specified by:

getRhythmInstance in interface RhythmDatabase

Parameters:

rId - Unique rhythm id

Returns:

The rhythm whose uniqueId matches rId

Throws:

UnavailableRhythmException

See Also:

• AdaptedRhythm.getUniqueId()
• RhythmProvider.getAdaptedRhythm(org.jjazz.rhythm.api.Rhythm, org.jjazz.harmony.api.TimeSignature)

getAdaptedRhythmInstance

public AdaptedRhythm getAdaptedRhythmInstance(Rhythm r,
 TimeSignature ts)

Description copied from interface: RhythmDatabase

Try to provide the rhythm instance which is an adapted version of r for a different time signature.

If the adapted rhythm could be obtained it is added in the database. AdaptedRhythm instances are cached.

Specified by:

getAdaptedRhythmInstance in interface RhythmDatabase

Parameters:

r -

ts -

Returns:

Can be null if no adapted rhythm is available.

getRhythms

public List<RhythmInfo> getRhythms(RhythmProvider rp)

Description copied from interface: RhythmDatabase

The rhythms associated to the specified RhythmProvider

Specified by:

getRhythms in interface RhythmDatabase

Parameters:

rp -

Returns:

getDefaultRhythm

public RhythmInfo getDefaultRhythm(TimeSignature ts)

Description copied from interface: RhythmDatabase

Get the default Rhythm for TimeSignature ts.

Specified by:

getDefaultRhythm in interface RhythmDatabase

Parameters:

ts - TimeSignature

Returns:

Can not be null, but there is no guarantee that getRhythmInstance() on the returned value will work (e.g. if this RhythmInfo depends on a file which is no more available).

setDefaultRhythm

public void setDefaultRhythm(TimeSignature ts,
 RhythmInfo ri)

Description copied from interface: RhythmDatabase

Set the default rhythm for this TimeSignature.

Specified by:

setDefaultRhythm in interface RhythmDatabase

Parameters:

ts - TimeSignature

ri -

getRhythmProvider

public RhythmProvider getRhythmProvider(Rhythm r)

Specified by:

getRhythmProvider in interface RhythmDatabase

Parameters:

r -

Returns:

The RhythmProvider of the specified rhythm. Null if not found.

getRhythmProvider

public RhythmProvider getRhythmProvider(RhythmInfo ri)

Description copied from interface: RhythmDatabase

Get the RhythmProvider for specified RhythmInfo.

Specified by:

getRhythmProvider in interface RhythmDatabase

Parameters:

ri -

Returns:

The RhythmProvider of the specified RhythmInfo. Can be null.

addRhythm

public boolean addRhythm(RhythmProvider rp,
 RhythmInfo ri)

Description copied from interface: RhythmDatabase

Add one RhythmInfo to the database for the specified RhythmProvider.

Fire a state changed event if RhythmInfo is actually added.

Specified by:

addRhythm in interface RhythmDatabase

Parameters:

rp -

ri -

Returns:

True if rInfo was actually added.

addRhythmInstance

public boolean addRhythmInstance(RhythmProvider rp,
 Rhythm r)

Description copied from interface: RhythmDatabase

Add one Rhythm instance to the database for the specified RhythmProvider.

Fire a state changed event if Rhythm is actually added.

Specified by:

addRhythmInstance in interface RhythmDatabase

Parameters:

rp -

r -

Returns:

True if r was actually added.

toString

public String toString()

Overrides:

toString in class Object

size

public int size()

Specified by:

size in interface RhythmDatabase

Returns:

The number of rhythms in the database.

addChangeListener

public void addChangeListener(ChangeListener l)

Description copied from interface: RhythmDatabase

Listeners are notified when the rhythm database has changed.

Note that listeners might be notified out of the Event Dispatch Thread.

Specified by:

addChangeListener in interface RhythmDatabase

Parameters:

l -

removeChangeListener

public void removeChangeListener(ChangeListener l)

Specified by:

removeChangeListener in interface RhythmDatabase

addRhythmsFromRhythmProviders

public MultipleErrorsReport addRhythmsFromRhythmProviders(boolean excludeBuiltinRhythms,
 boolean excludeFileRhythms,
 boolean forceFileRhythmsRescan)

Poll RhythmProvider instances from the global lookup to add rhythms.

Parameters:

excludeBuiltinRhythms -

excludeFileRhythms -

forceFileRhythmsRescan - Unused when excludedFileRhythms is true

Returns:

See Also:

• RhythmProvider