net.charlesames.music.ensemble
Class TuningElementInflection

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

All Implemented Interfaces:

EntityContainer

public class TuningElementInflection
extends TuningElement

Author:

Charles Ames

Nested Class Summary

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

EnsembleEntity.AttributeTable

Constructor Summary

TuningElementInflection(TuningMapDiatonic container, Inflection inflection)
Constructor for TuningElementInflection instances.

Method Summary

void	checkCents(int cents) Check the indicated cents value.
static XmlSpec	createXmlSpec() Create an XML specification for the TuningElementInflection class.
boolean	equals(EnsembleEntity other) Check if this entity has the same class and content as another entity.
static TuningElementInflection	fromXmlNode(org.w3c.dom.Element element, TuningMapDiatonic container) Create a new TuningElementInflection instance and fill it with loaded data.
Inflection	getInflection() Get the Inflection 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

TuningElementInflection

public TuningElementInflection(TuningMapDiatonic container,
                               Inflection inflection)

Constructor for TuningElementInflection instances.

Parameters:

container - The TuningMapDiatonic which contains this element.

inflection - The Inflection to which this element maps a cents displacement.

Method Detail

getInflection

public Inflection getInflection()

Get the Inflection for this tuning element.

Returns:

The Inflection for this tuning element.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the TuningElementInflection data

container - The TuningMapDiatonic which will contain the new TuningElementInflection.

Returns:

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

Returns:

The newly created XmlSpec instance.

Throws:

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