net.charlesames.music.musicxml
Class ScoreInstrument

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

public class ScoreInstrument
extends MusicXmlEntity

The ScoreInstrument class implements the MusicXML <score-instrument> 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 ScoreInstrument	fromXmlNode(org.w3c.dom.Element element, ScorePart container) Create a new ScoreInstrument instance and fill it with loaded data.
java.lang.String	getID() Getter for the ID property
java.lang.String	getName() Getter for the Name property
void	putXmlData(org.w3c.dom.Element element)
void	setID(java.lang.String id) Setter for the ID property
void	setName(java.lang.String name) Setter for the Name 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

getID

public java.lang.String getID()

Getter for the ID property

Returns:

The current ID value.

setID

public void setID(java.lang.String id)

Setter for the ID property

Parameters:

id - The intended ID value.

getName

public java.lang.String getName()

Getter for the Name property

Returns:

The current Name value.

setName

public void setName(java.lang.String name)

Setter for the Name property

Parameters:

name - The intended Name value.

fromXmlNode

public static ScoreInstrument fromXmlNode(org.w3c.dom.Element element,
                                          ScorePart container)

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

Parameters:

element - The XML element that provides the ScoreInstrument data

container - The ScorePart which will contain the new ScoreInstrument instance.

Returns:

The newly created ScoreInstrument 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.