Class SizedPhrase

java.lang.Object

org.jjazz.phrase.api.Phrase

org.jjazz.phrase.api.SizedPhrase

All Implemented Interfaces:

Serializable, Iterable<NoteEvent>, Collection<NoteEvent>, NavigableSet<NoteEvent>, SequencedCollection<NoteEvent>, SequencedSet<NoteEvent>, Set<NoteEvent>, SortedSet<NoteEvent>

public class SizedPhrase
extends Phrase

A Phrase which has a size (beat range) and a time signature.

Added NoteEvents must be fully contained in the beat range, otherwise an IllegalArgumentException is thrown.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jjazz.phrase.api.Phrase

Phrase.XStreamConfig

Field Summary

Fields inherited from class org.jjazz.phrase.api.Phrase

PARENT_NOTE, PROP_NOTES_ADDED, PROP_NOTES_ADDED_ADJUSTING, PROP_NOTES_MOVED, PROP_NOTES_MOVED_ADJUSTING, PROP_NOTES_REMOVED, PROP_NOTES_REMOVED_ADJUSTING, PROP_NOTES_REPLACED, PROP_NOTES_REPLACED_ADJUSTING

Constructor Summary

Constructors

Constructor	Description
SizedPhrase(int channel, FloatRange beatRange, TimeSignature ts, boolean isDrums)	Create a sized phrase with no notes.
SizedPhrase(SizedPhrase sp)

Method Summary

Modifier and Type	Method	Description
boolean	canAddNote(NoteEvent ne)	Overridden to check NoteEvent is within the beat range (including the upper bound).
SizedPhrase	clone()	A deep clone: returned phrase contains clones of the original NoteEvents.
FloatRange	getNotesBeatRange()	Get the beat range corresponding to this phrase.
int	getSizeInBars()
TimeSignature	getTimeSignature()
static SizedPhrase	loadAsString(String s)	Create a SizedPhrase from the specified string.
static String	saveAsString(SizedPhrase sp)	Save the specified SizedPhrase as a string.
void	shiftAllEvents(float shiftInBeats, boolean handleNegativePositions)	Shift the associated BeatRange and all events.
String	toString()

Methods inherited from class org.jjazz.phrase.api.Phrase

add, add, add, add, addAll, addAll, addPropertyChangeListener, addUndoableEditListener, ceiling, clear, comparator, contains, containsAll, descendingIterator, descendingSet, dump, equals, equalsAsIntervals, equalsAsNoteNearPosition, first, floor, getCeilNote, getChannel, getFloorNote, getLastEventPosition, getNotes, getNotes, getProcessedPhrase, getProcessedPhrasePitch, getProcessedPhraseVelocity, headSet, headSet, higher, isAdjustingEvent, isDrums, isEmpty, iterator, last, lower, move, move, moveAll, pollFirst, pollLast, processNotes, processPitch, processVelocity, remove, remove, removeAll, removeAll, removePropertyChangeListener, removeUndoableEditListener, replace, replace, replaceAll, retainAll, saveAsString, size, subSet, subSet, subSet, tailSet, tailSet, toArray, toArray, toStringOneNotePerLine, toStringSimple

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.NavigableSet

removeFirst, removeLast, reversed

Methods inherited from interface java.util.Set

hashCode

Methods inherited from interface java.util.SortedSet

addFirst, addLast, getFirst, getLast, spliterator

Constructor Details

SizedPhrase

public SizedPhrase(int channel,
 FloatRange beatRange,
 TimeSignature ts,
 boolean isDrums)

Create a sized phrase with no notes.

Parameters:

channel -

beatRange -

ts -

isDrums -

SizedPhrase

public SizedPhrase(SizedPhrase sp)

Method Details

canAddNote

public boolean canAddNote(NoteEvent ne)

Overridden to check NoteEvent is within the beat range (including the upper bound).

Parameters:

ne -

Returns:

clone

public SizedPhrase clone()

Description copied from class: Phrase

A deep clone: returned phrase contains clones of the original NoteEvents.

Overrides:

clone in class Phrase

Returns:

getNotesBeatRange

public FloatRange getNotesBeatRange()

Get the beat range corresponding to this phrase.

Overrides Phrase.getNotesBeatRange() because the beat range is fixed for a SizedPhrase.

Overrides:

getNotesBeatRange in class Phrase

Returns:

getTimeSignature

public TimeSignature getTimeSignature()

Returns:

The timeSignature used in this phrase.

getSizeInBars

public int getSizeInBars()

shiftAllEvents

public void shiftAllEvents(float shiftInBeats,
 boolean handleNegativePositions)

Shift the associated BeatRange and all events.

Overrides:

shiftAllEvents in class Phrase

Parameters:

shiftInBeats -

handleNegativePositions - If true reset negative note positions to 0

saveAsString

public static String saveAsString(SizedPhrase sp)

Save the specified SizedPhrase as a string.

Example "[8|12.0|16.0|4/4|NoteEventStr0|NoteEventStr1]" means a melodic Phrase for channel 8, beatRange=12-16, in 4/4, with 2 NoteEvents.
Example "[drums_9|12.0|16.0|4/4|NoteEventStr0|NoteEventStr1]" means a drums Phrase for channel 9.

Parameters:

sp -

Returns:

See Also:

• loadAsString(java.lang.String)

loadAsString

public static SizedPhrase loadAsString(String s)
                                throws ParseException

Create a SizedPhrase from the specified string.

Parameters:

s -

Returns:

Throws:

ParseException - If s is not a valid string.

See Also:

• saveAsString(org.jjazz.phrase.api.SizedPhrase)

toString

public String toString()

Overrides:

toString in class Phrase