net.charlesames.music.musicxml
Class Metronome

java.lang.Object
  net.charlesames.utility.common.Disposable
      net.charlesames.music.musicxml.MusicXmlEntity
          net.charlesames.music.musicxml.DirectionType
              net.charlesames.music.musicxml.Metronome

public class Metronome
extends DirectionType

The Identification class implements the MusicXML <metronome> direction type.

Author:

Charles Ames

Method Summary

boolean	equals(MusicXmlEntity other) Test if this MusicXML entity has the same content as another object.
static Metronome	fromXmlNode(org.w3c.dom.Element element, Direction container) Create a new Metronome instance and fill it with loaded data.
java.lang.String	getBeatUnit() Getter for the BeatUnit property.
int	getBeatUnitDots() Getter for the BeatUnitDots property.
static Metronome	getInstance(Direction container) Create a new Metronome instance.
YesNo	getParentheses() Getter for the Parentheses property.
int	getPerMinute() Getter for the PerMinute property.
void	putXmlData(org.w3c.dom.Element element)
void	setBeatUnit(java.lang.String beatUnit) Setter for the BeatUnit property.
void	setBeatUnitDots(int beatUnitDots) Setter for the BeatUnitDots property.
void	setParentheses(YesNo parentheses) Setter for the Parentheses property.
void	setPerMinute(int perMinute) Setter for the PerMinute 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.DirectionType

dispose, getContent, getDefaultY, getFontFamily, getFontSize, getFontStyle, getFontWeight, getRelativeX, setContent, setDefaultY, setFontFamily, setFontSize, setFontStyle, setFontWeight, setRelativeX

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

getInstance

public static Metronome getInstance(Direction container)

Create a new Metronome instance.

Parameters:

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

Returns:

The newly created Metronome instance.

getParentheses

public YesNo getParentheses()

Getter for the Parentheses property.

Returns:

The current Parentheses value.

setParentheses

public void setParentheses(YesNo parentheses)

Setter for the Parentheses property.

Parameters:

parentheses - The intended Parentheses value.

getBeatUnit

public java.lang.String getBeatUnit()

Getter for the BeatUnit property.

Returns:

The current BeatUnit value.

setBeatUnit

public void setBeatUnit(java.lang.String beatUnit)

Setter for the BeatUnit property.

Parameters:

beatUnit - The intended BeatUnit value.

getBeatUnitDots

public int getBeatUnitDots()

Getter for the BeatUnitDots property.

Returns:

The current BeatUnitDots value.

setBeatUnitDots

public void setBeatUnitDots(int beatUnitDots)

Setter for the BeatUnitDots property.

Parameters:

beatUnitDots - The intended BeatUnitDots value.

getPerMinute

public int getPerMinute()

Getter for the PerMinute property.

Returns:

The current PerMinute value.

setPerMinute

public void setPerMinute(int perMinute)

Setter for the PerMinute property.

Parameters:

perMinute - The intended PerMinute value.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the Metronome data

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

Returns:

The newly created Metronome 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 DirectionType

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 DirectionType

Parameters:

other - The other object.

Returns:

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