net.charlesames.music.musicxml
Class Direction

java.lang.Object
  net.charlesames.utility.common.Disposable
      net.charlesames.music.musicxml.MusicXmlEntity
          net.charlesames.music.musicxml.TimedEvent
              net.charlesames.music.musicxml.Direction

public class Direction
extends TimedEvent

The Direction class implements the MusicXML <direction> event.

Author:

Charles Ames

Method Summary

void	addDirectionType(DirectionType directionType) Add a DirectionType entity.
void	dispose() Release resources engaged by this object, thus rendering it amenable to garbage collection.
boolean	equals(MusicXmlEntity other) Test if this MusicXML entity has the same content as another object.
static Direction	fromXmlNode(org.w3c.dom.Element element, Measure container) Create a new Direction instance and fill it with loaded data.
double	getDynamics() Getter for Dynamics property.
static Direction	getInstance(Measure container) Create a new Direction instance.
int	getOffset() Getter for Offset property.
Placement	getPlacement() Getter for Placement property.
Sound	getSound() Getter for the Sound property.
int	getStaff() Getter for Staff property.
int	getTempo() Getter for Tempo property.
int	getVoice() Getter for Voice property.
void	putXmlData(org.w3c.dom.Element element)
void	setDynamics(double dynamics) Setter for Dynamics property.
void	setOffset(int offset) Setter for Offset property.
void	setPlacement(Placement placement) Setter for Placement property.
void	setStaff(int staff) Setter for Staff property.
void	setTempo(int tempo) Setter for Tempo property.
void	setVoice(int voice) Setter for Voice property.
org.w3c.dom.Node	toXmlNode(org.w3c.dom.Node parent) Serialize the content of a MusicXML entity into an XML element.

Methods inherited from class net.charlesames.music.musicxml.TimedEvent

getComment, getDefaultX, getDuration, getTime, isInChord, setComment, setDefaultX, setTime

Methods inherited from class net.charlesames.music.musicxml.MusicXmlEntity

getContainer, makeDirty

Methods inherited from class java.lang.Object

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

Method Detail

dispose

public void dispose()

Description copied from class: Disposable

Release resources engaged by this object, thus rendering it amenable to garbage collection.

Overrides:

dispose in class TimedEvent

getInstance

public static Direction getInstance(Measure container)

Create a new Direction instance.

Parameters:

container - The MeasureInPart which will contain the new Direction instance.

Returns:

The newly created Direction instance.

getPlacement

public Placement getPlacement()

Getter for Placement property.

Returns:

The current Placement value.

setPlacement

public void setPlacement(Placement placement)

Setter for Placement property.

Parameters:

placement - The intended Placement value.

getStaff

public int getStaff()

Getter for Staff property.

Returns:

The current Staff value.

setStaff

public void setStaff(int staff)

Setter for Staff property.

Parameters:

staff - The intended Staff value.

getVoice

public int getVoice()

Getter for Voice property.

Returns:

The current Voice value.

setVoice

public void setVoice(int voice)

Setter for Voice property.

Parameters:

voice - The intended Voice value.

getOffset

public int getOffset()

Getter for Offset property.

Returns:

The current Offset value.

setOffset

public void setOffset(int offset)

Setter for Offset property.

Parameters:

offset - The intended Offset value.

getTempo

public int getTempo()

Getter for Tempo property.

Returns:

The current Tempo value.

setTempo

public void setTempo(int tempo)

Setter for Tempo property.

Parameters:

tempo - The intended Tempo value.

getDynamics

public double getDynamics()

Getter for Dynamics property.

Returns:

The current Dynamics value.

setDynamics

public void setDynamics(double dynamics)

Setter for Dynamics property.

Parameters:

dynamics - The intended Dynamics value.

addDirectionType

public void addDirectionType(DirectionType directionType)

Add a DirectionType entity.

Parameters:

directionType - The new DirectionType.

getSound

public Sound getSound()

Getter for the Sound property.

Returns:

The current Sound entity.

fromXmlNode

public static Direction fromXmlNode(org.w3c.dom.Element element,
                                    Measure container)

Create a new Direction instance and fill it with loaded data.

Parameters:

element - The XML element that provides the Direction data

container - The Measure which will contain the new Direction instance.

Returns:

The newly created Direction instance.

toXmlNode

public org.w3c.dom.Node toXmlNode(org.w3c.dom.Node parent)

Description copied from class: MusicXmlEntity

Serialize the content of a MusicXML entity into an XML element.

Specified by:

toXmlNode in class MusicXmlEntity

Parameters:

parent - The XML element which is to receive the data.

Returns:

The newly created XML element.

putXmlData

public void putXmlData(org.w3c.dom.Element element)

Overrides:

putXmlData in class TimedEvent

equals

public boolean equals(MusicXmlEntity other)

Description copied from class: MusicXmlEntity

Test if this MusicXML entity has the same content as another object.

Overrides:

equals in class TimedEvent

Parameters:

other - The other object.

Returns:

True if both objects have the same content; false otherwise.