net.charlesames.music.musicxml
Class Scaling

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

public class Scaling
extends MusicXmlEntity

The Scaling class implements the MusicXML <scaling> 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 Scaling	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new Scaling instance and fill it with loaded data.
static Scaling	getInstance(MusicXmlEntity container) Create a new Scaling instance.
double	getMillimeters() Getter for the Millimeters property
int	getTenths() Getter for the Tenths property
void	putXmlData(org.w3c.dom.Element element)
void	setMillimeters(double millimeters) Setter for the Millimeters property
void	setTenths(int tenths) Setter for the Tenths 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

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.

Specified by:

dispose in class Disposable

getInstance

public static Scaling getInstance(MusicXmlEntity container)

Create a new Scaling instance.

Parameters:

container - The MusicXmlEntity which will contain the new Scaling instance.

Returns:

The newly created Scaling instance.

getTenths

public int getTenths()

Getter for the Tenths property

Returns:

The current Tenths value.

setTenths

public void setTenths(int tenths)

Setter for the Tenths property

Parameters:

tenths - The intended Tenths value.

getMillimeters

public double getMillimeters()

Getter for the Millimeters property

Returns:

The current Millimeters value.

setMillimeters

public void setMillimeters(double millimeters)

Setter for the Millimeters property

Parameters:

millimeters - The intended Millimeters value.

fromXmlNode

public static Scaling fromXmlNode(org.w3c.dom.Element element,
                                  MusicXmlEntity container)

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

Parameters:

element - The XML element that provides the Scaling data

container - The MusicXmlEntity which will contain the new Scaling instance.

Returns:

The newly created Scaling 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)

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.