net.charlesames.music.musicxml
Class MeasurePrint

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

public class MeasurePrint
extends MusicXmlEntity

The MeasurePrint class implements the MusicXML <measure-print> element.

Author:

Charles Ames

Method Summary

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 MeasurePrint	fromXmlNode(org.w3c.dom.Element element, Measure container) Create a new MeasurePrint instance and fill it with loaded data.
MeasureInPart	getContainer() Get the parent object.
static MeasurePrint	getInstance(Measure container) Create a new MeasurePrint instance.
java.lang.String	getMeasureNumbering() Getter for the MeasureNumbering property.
SystemLayout	getSystemLayout() Getter for the SystemLayout property.
void	putXmlData(org.w3c.dom.Element element)
void	setMeasureNumbering(java.lang.String measureNumbering) Setter for the MeasureNumbering property.
void	setSystemLayout(SystemLayout systemLayout) Setter for the SystemLayout 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.MusicXmlEntity

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.

Specified by:

dispose in class Disposable

getInstance

public static MeasurePrint getInstance(Measure container)

Create a new MeasurePrint instance.

Parameters:

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

Returns:

The newly created MeasurePrint instance.

getContainer

public MeasureInPart getContainer()

Description copied from class: MusicXmlEntity

Get the parent object.

Overrides:

getContainer in class MusicXmlEntity

Returns:

The parent object.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the MeasurePrint data

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

Returns:

The newly created MeasurePrint instance.

getMeasureNumbering

public java.lang.String getMeasureNumbering()

Getter for the MeasureNumbering property.

Returns:

The current MeasureNumbering value.

setMeasureNumbering

public void setMeasureNumbering(java.lang.String measureNumbering)

Setter for the MeasureNumbering property.

Parameters:

measureNumbering - The intended MeasureNumbering value.

getSystemLayout

public SystemLayout getSystemLayout()

Getter for the SystemLayout property.

Returns:

The current SystemLayout value.

setSystemLayout

public void setSystemLayout(SystemLayout systemLayout)

Setter for the SystemLayout property.

Parameters:

systemLayout - The intended SystemLayout value.

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)

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 MusicXmlEntity

Parameters:

other - The other object.

Returns:

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