Interface CLI_Factory

public interface CLI_Factory

A factory for ChordLeadSheetItems.

Method Summary

Modifier and Type	Method	Description
CLI_BarAnnotation	createBarAnnotation(String annotation, int bar)	Create a CLI_BarAnnotation at specified bar.
default CLI_ChordSymbol	createChordSymbol(String chordSymbol, int bar, float beat)
CLI_ChordSymbol	createChordSymbol(String chordSymbol, Position pos)	Create a CLI_ChordSymbol from a string specification.
default CLI_ChordSymbol	createChordSymbol(ExtChordSymbol ecs, int bar, float beat)
CLI_ChordSymbol	createChordSymbol(ExtChordSymbol ecs, Position pos)	Create a CLI_ChordSymbol.
CLI_Section	createSection(String sectionName, TimeSignature ts, int barIndex, ChordLeadSheet cls)	Create a Section.
static CLI_Factory	getDefault()
CLI_ChordSymbol	getSampleChordSymbol()
CLI_Section	getSampleSection()

Method Details

getDefault

static CLI_Factory getDefault()

createSection

CLI_Section createSection(String sectionName,
 TimeSignature ts,
 int barIndex,
 ChordLeadSheet cls)

Create a Section.

Parameters:

sectionName -

ts -

barIndex -

cls - Can be null. If not null, adapt sectionName if required to avoid name clash with another section in cls.

Returns:

createChordSymbol

CLI_ChordSymbol createChordSymbol(ExtChordSymbol ecs,
 Position pos)

Create a CLI_ChordSymbol.

Parameters:

ecs -

pos -

Returns:

createChordSymbol

default CLI_ChordSymbol createChordSymbol(ExtChordSymbol ecs,
 int bar,
 float beat)

createChordSymbol

CLI_ChordSymbol createChordSymbol(String chordSymbol,
 Position pos)
                           throws ParseException

Create a CLI_ChordSymbol from a string specification.

Use default values for non specified attributes.

Parameters:

chordSymbol - E.g. "C" or "Bb7#5"

pos -

Returns:

Throws:

ParseException - If chord symbol specification is invalid

createChordSymbol

default CLI_ChordSymbol createChordSymbol(String chordSymbol,
 int bar,
 float beat)
                                   throws ParseException

Throws:

ParseException

createBarAnnotation

CLI_BarAnnotation createBarAnnotation(String annotation,
 int bar)

Create a CLI_BarAnnotation at specified bar.

Parameters:

annotation -

bar -

Returns:

getSampleSection

CLI_Section getSampleSection()

getSampleChordSymbol

CLI_ChordSymbol getSampleChordSymbol()