net.charlesames.music.ensemble
Class UnpitchedIndication

java.lang.Object
  net.charlesames.utility.common.Disposable
      net.charlesames.utility.entity.Entity
          net.charlesames.utility.entity.WriteableEntity
              net.charlesames.music.ensemble.EnsembleEntity
                  net.charlesames.music.ensemble.UnpitchedIndication

All Implemented Interfaces:

EntityContainer

public class UnpitchedIndication
extends EnsembleEntity

An EnsembleEntity which wraps a MusicXML Indication.

Author:

Charles Ames

Nested Class Summary

Nested classes/interfaces inherited from class net.charlesames.music.ensemble.EnsembleEntity

EnsembleEntity.AttributeTable

Constructor Summary

UnpitchedIndication(UnpitchedSound container, Indication indication)

Method Summary

static XmlSpec	createXmlSpec() Create an XML specification for the UnpitchedSound class.
boolean	equals(EnsembleEntity other) Check if this entity has the same class and content as another entity.
static UnpitchedIndication	fromXmlNode(org.w3c.dom.Element element, UnpitchedSound sound) Create a new UnpitchedIndication instance and fill it with loaded data.
UnpitchedSound	getContainer() Getter for the Container property.
Indication	getIndication() Get the MusicXML Indication wrapped by this EnsembleEntity.

Methods inherited from class net.charlesames.music.ensemble.EnsembleEntity

buildDescription, copyToClipboard, createIndentCell, createXmlSpec, describeFeature, getEnsemble, logError, predecessor, toString

Methods inherited from class net.charlesames.utility.entity.WriteableEntity

check, clearXmlSpecs, createXmlSpec, getTagName, getXmlData, getXmlSpec, getXmlSpec, initializeXsd, isPersistent, logError, logError, makeDirty, putXmlData, save, setID, setName, setPersistent, setStatus, toXmlNode

Methods inherited from class net.charlesames.utility.entity.Entity

decrementReferenceCount, dereferenceHandle, dispose, equals, getHandle, getID, getName, getPath, getReferenceCount, getStatus, getText, hasContainer, incrementReferenceCount, isModifiable, methodHasOverride, predecessor, resequenceEntities, setContainer, setModifiable, shiftEntitiesDown, shiftEntityDown, shiftEntityUp, successor, wipe

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UnpitchedIndication

public UnpitchedIndication(UnpitchedSound container,
                           Indication indication)

Parameters:

container - Constructor for UnpitchedIndication instances.

indication - A MusicXML Indication.

Method Detail

getIndication

public Indication getIndication()

Get the MusicXML Indication wrapped by this EnsembleEntity.

Returns:

The MusicXML Indication wrapped by this EnsembleEntity.

getContainer

public UnpitchedSound getContainer()

Description copied from class: Entity

Getter for the Container property.

Overrides:

getContainer in class EnsembleEntity

Returns:

The assigned Container value.

fromXmlNode

public static UnpitchedIndication fromXmlNode(org.w3c.dom.Element element,
                                              UnpitchedSound sound)

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

Parameters:

element - The XML element that provides the {code UnpitchedIndication} data

sound - The {link UnpitchedSound} which will contain the new {code UnpitchedSound}.

Returns:

The newly created {code UnpitchedIndication} instance.

createXmlSpec

public static XmlSpec createXmlSpec()

Create an XML specification for the UnpitchedSound class.

Returns:

The newly created XmlSpec instance.

Throws:

java.lang.RuntimeException - when an XmlSpec instance already exists for the UnpitchedSound class.

equals

public boolean equals(EnsembleEntity other)

Description copied from class: EnsembleEntity

Check if this entity has the same class and content as another entity.

Overrides:

equals in class EnsembleEntity

Parameters:

other - The other entity.

Returns:

True if the two entities have the same class and content; false otherwise.