net.charlesames.music.musicxml
Class Identification

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

public class Identification
extends MusicXmlEntity

The Identification class implements the MusicXML <identification> element.

Author:

Charles Ames

Method Summary

IdentificationCreator	addCreator(java.lang.String creatorType, java.lang.String content) Add a IdentificationCreator instance with the indicated creatorType and content.
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 Identification	fromXmlNode(org.w3c.dom.Element element, ScorePartwise container) Create a new Identification instance and fill it with loaded data.
MusicXmlScore	getContainer() Get the parent object.
java.util.SortedMap<java.lang.String,IdentificationCreator>	getCreators() Get all creators.
IdentificationEncoding	getEncoding() Getter for the Encoding property.
static Identification	getInstance(MusicXmlScore container) Create a new Identification instance.
java.lang.String	getRights() Getter for the Rights property.
void	putXmlData(org.w3c.dom.Element element)
void	setEncoding(IdentificationEncoding encoding) Setter for the Encoding property.
void	setRights(java.lang.String rights) Setter for the Rights 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 Identification getInstance(MusicXmlScore container)

Create a new Identification instance.

Parameters:

container - The MusicXmlScore which will contain the new Identification instance.

Returns:

The newly created Identification instance.

getRights

public java.lang.String getRights()

Getter for the Rights property.

Returns:

The current Rights value.

setRights

public void setRights(java.lang.String rights)

Setter for the Rights property.

Parameters:

rights - The intended Rights value.

getEncoding

public IdentificationEncoding getEncoding()

Getter for the Encoding property.

Returns:

The current Encoding value.

setEncoding

public void setEncoding(IdentificationEncoding encoding)

Setter for the Encoding property.

Parameters:

encoding - The intended Encoding value.

addCreator

public IdentificationCreator addCreator(java.lang.String creatorType,
                                        java.lang.String content)

Add a IdentificationCreator instance with the indicated creatorType and content.

Parameters:

creatorType - The creator type.

content - The content.

Returns:

The newly created IdentificationCreator instance.

getContainer

public MusicXmlScore getContainer()

Description copied from class: MusicXmlEntity

Get the parent object.

Overrides:

getContainer in class MusicXmlEntity

Returns:

The parent object.

getCreators

public java.util.SortedMap<java.lang.String,IdentificationCreator> getCreators()

Get all creators.

Returns:

A Collection of IdentificationCreator instances, indexed by creator type.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the Identification data

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

Returns:

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