net.charlesames.music.ensemble
Class NoteListParameter

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.NoteListParameter

All Implemented Interfaces:

EntityContainer

public class NoteListParameter
extends EnsembleEntity

NoteListParameter objects direct score information to be written to fields in MUSIC-N note lists.

Author:

Charles Ames

Nested Class Summary

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

EnsembleEntity.AttributeTable

Constructor Summary

NoteListParameter(NoteListInstrument container, int id, java.lang.String name)
Constructor for NoteListParameter instances

Method Summary

static XmlSpec	createXmlSpec() Create an XML specification for the NoteListParameter class.
boolean	equals(EnsembleEntity other) Check if this entity has the same class and content as another entity.
static NoteListParameter	fromXmlNode(org.w3c.dom.Element element, NoteListInstrument container) Create a new NoteListParameter instance and fill it with loaded data.
NoteListInstrument	getContainer() Getter for the Container property.
java.lang.String	getPath() Return a description of this entity and its containers.
boolean	setID(int id) Setter for the ID property.
boolean	setName(java.lang.String name) Setter for the Name property.

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, setPersistent, setStatus, toXmlNode

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

decrementReferenceCount, dereferenceHandle, dispose, equals, getHandle, getID, getName, 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

NoteListParameter

public NoteListParameter(NoteListInstrument container,
                         int id,
                         java.lang.String name)

Constructor for NoteListParameter instances

Parameters:

container - The Ensemble, EnsembleChoir, or EnsembleInstrument that contains this parameter.

id - The parameter id.

name - The parameter name.

Method Detail

getContainer

public NoteListInstrument getContainer()

Description copied from class: Entity

Getter for the Container property.

Overrides:

getContainer in class EnsembleEntity

Returns:

The assigned Container value.

setID

public boolean setID(int id)

Description copied from class: Entity

Setter for the ID property.

Overrides:

setID in class WriteableEntity

Parameters:

id - The intended ID value.

Returns:

True if an ID change actually happened; false otherwise.

setName

public boolean setName(java.lang.String name)

Description copied from class: Entity

Setter for the Name property.

Overrides:

setName in class WriteableEntity

Parameters:

name - The intended Name value.

Returns:

True if a Name change actually happened; false otherwise.

getPath

public java.lang.String getPath()

Description copied from class: Entity

Return a description of this entity and its containers.

Specified by:

getPath in interface EntityContainer

Overrides:

getPath in class Entity

Returns:

A description of this entity and its containers.

fromXmlNode

public static NoteListParameter fromXmlNode(org.w3c.dom.Element element,
                                            NoteListInstrument container)

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

Parameters:

element - The XML element that provides the NoteListParameter data

container - The Ensemble, EnsembleChoir, or EnsembleInstrument which will contain the new NoteListParameter.

Returns:

The newly created NoteListParameter instance.

createXmlSpec

public static XmlSpec createXmlSpec()

Create an XML specification for the NoteListParameter class.

Returns:

The newly created XmlSpec instance.

Throws:

java.lang.RuntimeException - when an XmlSpec instance already exists for the NoteListParameter 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.