net.charlesames.music.ensemble
Class NoteListInstrumentContour

java.lang.Object
  extended by net.charlesames.utility.common.Disposable
      extended by net.charlesames.utility.entity.Entity
          extended by net.charlesames.utility.entity.WriteableEntity
              extended by net.charlesames.music.ensemble.EnsembleEntity
                  extended by net.charlesames.music.ensemble.NoteListInstrumentContour
All Implemented Interfaces:
EntityContainer

Deprecated.

public class NoteListInstrumentContour
extends EnsembleEntity

The NoteListInstrumentContour class implements a cross reference between a NoteListInstrument and an EnsembleContour.

Author:
Charles Ames

Nested Class Summary
 
Nested classes/interfaces inherited from class net.charlesames.music.ensemble.EnsembleEntity
EnsembleEntity.AttributeTable
 
Method Summary
static XmlSpec createXmlSpec()
          Deprecated. Create an XML specification for the NoteListInstrumentContour class.
 boolean equals(EnsembleEntity other)
          Deprecated. Check if this entity has the same class and content as another entity.
static NoteListInstrumentContour fromXmlNode(org.w3c.dom.Element element, NoteListInstrument instrument)
          Deprecated. Create a new {code NoteListInstrumentContour} instance and fill it with loaded data.
 NoteListInstrument getContainer()
          Deprecated. Get the NoteListInstrument to which this contour reference applies.
 EnsembleContour getContour()
          Deprecated. Get the EnsembleContour instance.
 int getIndex()
          Deprecated. Get the contour index;
 void resolve()
          Deprecated. Resolve the EnsembleContour instance.
 void wipe()
          Deprecated. Release resources for garbage collection.
 
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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

wipe

public void wipe()
Deprecated. 
Release resources for garbage collection.

Overrides:
wipe in class Entity

getContainer

public NoteListInstrument getContainer()
Deprecated. 
Get the NoteListInstrument to which this contour reference applies.

Overrides:
getContainer in class EnsembleEntity
Returns:
The NoteListInstrument to which this contour reference applies.

getIndex

public int getIndex()
Deprecated. 
Get the contour index;

Returns:
The contour index.

getContour

public EnsembleContour getContour()
Deprecated. 
Get the EnsembleContour instance.

Returns:
The EnsembleContour instance. Null if unresolved.

resolve

public void resolve()
Deprecated. 
Resolve the EnsembleContour instance.


fromXmlNode

public static NoteListInstrumentContour fromXmlNode(org.w3c.dom.Element element,
                                                    NoteListInstrument instrument)
Deprecated. 
Create a new {code NoteListInstrumentContour} instance and fill it with loaded data.

Parameters:
element - The XML element that provides the {code NoteListInstrumentContour} data
instrument - The {link NoteListInstrument} which will contain the new {code NoteListInstrumentContour}.
Returns:
The newly created {code NoteListInstrumentContour} instance.

createXmlSpec

public static XmlSpec createXmlSpec()
Deprecated. 
Create an XML specification for the NoteListInstrumentContour class.

Returns:
The newly created XmlSpec instance.
Throws:
java.lang.RuntimeException - when an XmlSpec instance already exists for the NoteListInstrumentContour class.

equals

public boolean equals(EnsembleEntity other)
Deprecated. 
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.