org.jfugue.extras
Class IntervalPatternTransformer

java.lang.Object
  extended by org.jfugue.PatternTransformer
      extended by org.jfugue.extras.IntervalPatternTransformer
All Implemented Interfaces:
java.util.EventListener, ParserListener

public class IntervalPatternTransformer
extends PatternTransformer

The IntervalPatternTransformer alters music by changing the interval, or step, for each note in the given Pattern. For example, a C5 (note 60) raised 3 steps would turn into a D#5 (note 63). The interval is passed in as a parameter.

For general information on how Pattern Transformers work, refer to the JFugue documentation.

Version:
2.0
Author:
David Koelle

Field Summary
static java.lang.String INTERVAL
          Pass this String to putVariable, along with the interval by which you wish to alter the notes.
 
Fields inherited from class org.jfugue.PatternTransformer
returnPattern
 
Constructor Summary
IntervalPatternTransformer()
          Instantiates a new IntervalPatternTransformer object.
 
Method Summary
 java.lang.String getDescription()
          Indicates what this PatternTransformer does.
 java.lang.String getParameters()
          Returns a string declaring what variables IntervalPatternTransformer can use to perform the transformation.
 void noteEvent(Note note)
          Transforms the given note
 void parallelNoteEvent(Note note)
          Transforms the given note
 void sequentialNoteEvent(Note note)
          Transforms the given note
 
Methods inherited from class org.jfugue.PatternTransformer
channelPressureEvent, controllerEvent, getParameter, instrumentEvent, keySignatureEvent, layerEvent, measureEvent, pitchBendEvent, polyphonicPressureEvent, putParameter, tempoEvent, timeEvent, transform, voiceEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INTERVAL

public static final java.lang.String INTERVAL
Pass this String to putVariable, along with the interval by which you wish to alter the notes.

See Also:
Constant Field Values
Constructor Detail

IntervalPatternTransformer

public IntervalPatternTransformer()
Instantiates a new IntervalPatternTransformer object. The default value by which to increase the duration is 1.

Method Detail

getParameters

public java.lang.String getParameters()
Returns a string declaring what variables IntervalPatternTransformer can use to perform the transformation.

IntervalPatternTransformer requires the following:
'interval' - Integer - Number of intervals by which to change each note, can be positive or negative. Default is 1.

Overrides:
getParameters in class PatternTransformer

getDescription

public java.lang.String getDescription()
Description copied from class: PatternTransformer
Indicates what this PatternTransformer does.

Overrides:
getDescription in class PatternTransformer
Returns:
A String giving a quick description of this transformer

noteEvent

public void noteEvent(Note note)
Transforms the given note

Specified by:
noteEvent in interface ParserListener
Overrides:
noteEvent in class PatternTransformer
Parameters:
note - the event that has been parsed
See Also:
Note

sequentialNoteEvent

public void sequentialNoteEvent(Note note)
Transforms the given note

Specified by:
sequentialNoteEvent in interface ParserListener
Overrides:
sequentialNoteEvent in class PatternTransformer
Parameters:
note - the event that has been parsed
See Also:
Note

parallelNoteEvent

public void parallelNoteEvent(Note note)
Transforms the given note

Specified by:
parallelNoteEvent in interface ParserListener
Overrides:
parallelNoteEvent in class PatternTransformer
Parameters:
note - the event that has been parsed
See Also:
Note