Package org.jjazz.songstructure.api

Class SongStructureFactory

java.lang.Object

org.jjazz.songstructure.api.SongStructureFactory

public abstract class SongStructureFactory
extends Object

Constructor Summary

Constructors

Constructor	Description
SongStructureFactory()

Method Summary

Modifier and Type	Method	Description
abstract SongStructure	createEmptySgs()
abstract SongStructure	createSgs(ChordLeadSheet cls, boolean keepSgsUpdated)	Create a SongStructure with cls as parentChordLeadSheet.
abstract SongStructure	createSimpleSgs()	A simple SGS with just 1 SongPart of 4 bars and the RhythmDatabase default rhythm.
static SongStructureFactory	getDefault()

Methods inherited from class java.lang.Object

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

Constructor Details

SongStructureFactory

public SongStructureFactory()

Method Details

getDefault

public static SongStructureFactory getDefault()

createEmptySgs

public abstract SongStructure createEmptySgs()

createSimpleSgs

public abstract SongStructure createSimpleSgs()

A simple SGS with just 1 SongPart of 4 bars and the RhythmDatabase default rhythm.

Returns:

createSgs

public abstract SongStructure createSgs(ChordLeadSheet cls,
 boolean keepSgsUpdated)
                                 throws UnsupportedEditException

Create a SongStructure with cls as parentChordLeadSheet.

One SongPart is created for each cls section.
SongStructure can listen to cls changes (sections add/remove/move, resize) to remain updated.

Parameters:

cls - The model to rely on to build the SongParts.

keepSgsUpdated - If true sgs will remain in sync with cls changes.

Returns:

Throws:

UnsupportedEditException