net.charlesames.music.ensemble
Class TuningElementAccidental

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.TuningElement
                      net.charlesames.music.ensemble.TuningElementAccidental

All Implemented Interfaces:

EntityContainer

public class TuningElementAccidental
extends TuningElement

Author:

Charles Ames

Nested Class Summary

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

EnsembleEntity.AttributeTable

Constructor Summary

TuningElementAccidental(TuningMapDiatonic container, Accidental accidental)
Constructor for TuningElementAccidental instances.

Method Summary

void	checkCents(int cents) Check the indicated cents value.
static XmlSpec	createXmlSpec() Create an XML specification for the TuningElementAccidental class.
boolean	equals(EnsembleEntity other) Check if this entity has the same class and content as another entity.
static TuningElementAccidental	fromXmlNode(org.w3c.dom.Element element, TuningMapDiatonic container) Create a new TuningElementAccidental instance and fill it with loaded data.
Accidental	getAccidental() Get the Accidental for this tuning element.

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

getCents, setCents

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

buildDescription, copyToClipboard, createIndentCell, createXmlSpec, describeFeature, getContainer, 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

TuningElementAccidental

public TuningElementAccidental(TuningMapDiatonic container,
                               Accidental accidental)

Constructor for TuningElementAccidental instances.

Parameters:

container - The TuningMapDiatonic which contains this element.

accidental - The Accidental to which this element maps a cents displacement.

Method Detail

getAccidental

public Accidental getAccidental()

Get the Accidental for this tuning element.

Returns:

The Accidental for this tuning element.

fromXmlNode

public static TuningElementAccidental fromXmlNode(org.w3c.dom.Element element,
                                                  TuningMapDiatonic container)

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

Parameters:

element - The XML element that provides the TuningElementAccidental data

container - The TuningMapDiatonic which will contain the new TuningElementAccidental.

Returns:

The newly created TuningElementAccidental instance.

checkCents

public void checkCents(int cents)

Description copied from class: TuningElement

Check the indicated cents value.

Specified by:

checkCents in class TuningElement

Parameters:

cents - The indicated cents value.

createXmlSpec

public static XmlSpec createXmlSpec()

Create an XML specification for the TuningElementAccidental class.

Returns:

The newly created XmlSpec instance.

Throws:

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

Parameters:

other - The other entity.

Returns:

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