net.charlesames.music.musicxml
Class PartInScore

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

public class PartInScore
extends Part

The PartInScore class implements the MusicXML <part> 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 PartInScore	fromXmlNode(org.w3c.dom.Element element, ScorePartwise container) Create a new ScorePartwise instance and fill it with loaded data.
ScorePartwise	getContainer() Get the parent object.
MeasureInPart	getMeasure(int number) Locate or create the measure with the indicated number.
java.util.SortedMap<java.lang.Integer,MeasureInPart>	getMeasures() Get all measures.
ScorePart	getScorePart() Getter for the ScorePart property.
void	putXmlData(org.w3c.dom.Element element)
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

getContainer

public ScorePartwise getContainer()

Description copied from class: MusicXmlEntity

Get the parent object.

Overrides:

getContainer in class MusicXmlEntity

Returns:

The parent object.

getScorePart

public ScorePart getScorePart()

Getter for the ScorePart property.

Returns:

The current ScorePart value.

getMeasures

public java.util.SortedMap<java.lang.Integer,MeasureInPart> getMeasures()

Get all measures.

Returns:

A collection of MeasureInPart instances, indexed by measure number.

getMeasure

public MeasureInPart getMeasure(int number)

Locate or create the measure with the indicated number.

Parameters:

number - The measure number. If this number is already used, then the existing MeasureInPart instance is returned; otherwise, a new measure is created.

Returns:

A MeasureInPart 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)

fromXmlNode

public static PartInScore fromXmlNode(org.w3c.dom.Element element,
                                      ScorePartwise container)

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

Parameters:

element - The XML element that provides the ScorePartwise data

container - The ScorePartwise which will contain the new ScorePartwise instance.

Returns:

The newly created ScorePartwise instance.

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 Part

Parameters:

other - The other object.

Returns:

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