Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.virtuosotechnologies.asaph.standardmodel
Class StdVariation  view StdVariation download StdVariation.java

java.lang.Object
  extended bycom.virtuosotechnologies.lib.base.LinkedObject
      extended bycom.virtuosotechnologies.asaph.standardmodel.BaseSongMember
          extended bycom.virtuosotechnologies.asaph.standardmodel.StdVariation
All Implemented Interfaces:
com.virtuosotechnologies.asaph.model.SongMember, com.virtuosotechnologies.asaph.model.Variation

class StdVariation
extends BaseSongMember
implements com.virtuosotechnologies.asaph.model.Variation

Standard implementation of Variation


Nested Class Summary
(package private)  class StdVariation.ParseHandler
           
 
Field Summary
private  com.virtuosotechnologies.lib.util.StringID id_
           
private  StdSimpleString name_
           
 
Fields inherited from class com.virtuosotechnologies.lib.base.LinkedObject
 
Constructor Summary
(package private) StdVariation(StdSong parent, java.lang.String name, com.virtuosotechnologies.lib.util.StringID id)
           
 
Method Summary
 com.virtuosotechnologies.asaph.model.SimpleString getName()
          Get a SimpleString containing the name of the variation.
 java.lang.String getSerializableID()
          Get a string ID that can be used to serialize references to this Variation.
 com.virtuosotechnologies.asaph.model.Song getSong()
          Returns the Song containing this SongMember.
(package private)  void internalClearDefunct()
           
(package private)  BaseSongMember internalGetParent()
           
(package private)  void internalReportUndoableEdit(javax.swing.event.UndoableEditListener undoListener, javax.swing.undo.UndoableEdit edit)
           
(package private)  void internalSetDefunct()
           
 boolean isDefunct()
          Returns true if this object is defunct-- that is, if it or any of its ancestors has been removed.
(package private)  void unparse(com.virtuosotechnologies.lib.xml.XMLUnparser unparser)
           
 
Methods inherited from class com.virtuosotechnologies.lib.base.LinkedObject
getNext, getPrevious, linkThisAfter, linkThisBefore, unlinkThis
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.virtuosotechnologies.asaph.model.SongMember
getSong, isDefunct
 

Field Detail

name_

private StdSimpleString name_

id_

private com.virtuosotechnologies.lib.util.StringID id_
Constructor Detail

StdVariation

StdVariation(StdSong parent,
             java.lang.String name,
             com.virtuosotechnologies.lib.util.StringID id)
Method Detail

unparse

void unparse(com.virtuosotechnologies.lib.xml.XMLUnparser unparser)
       throws java.io.IOException

getName

public com.virtuosotechnologies.asaph.model.SimpleString getName()
Get a SimpleString containing the name of the variation. Every Variation will have a name, even if it is the empty string.

Specified by:
getName in interface com.virtuosotechnologies.asaph.model.Variation

getSerializableID

public java.lang.String getSerializableID()
Get a string ID that can be used to serialize references to this Variation. The ID is guaranteed to be unique among Variations within the owning Song, and will remain the same for the same Variation across different executions of the tool. However, two Variations from different Songs may have the same string ID, and the same string ID may be shared between SongBlocks, Variations and ChordSets within the same Song.

Specified by:
getSerializableID in interface com.virtuosotechnologies.asaph.model.Variation

internalSetDefunct

void internalSetDefunct()

internalClearDefunct

void internalClearDefunct()

internalReportUndoableEdit

void internalReportUndoableEdit(javax.swing.event.UndoableEditListener undoListener,
                                javax.swing.undo.UndoableEdit edit)

internalGetParent

BaseSongMember internalGetParent()

isDefunct

public boolean isDefunct()
Returns true if this object is defunct-- that is, if it or any of its ancestors has been removed. If this returns true, the behavior of any other methods on this object is undefined.

Specified by:
isDefunct in interface com.virtuosotechnologies.asaph.model.SongMember

getSong

public com.virtuosotechnologies.asaph.model.Song getSong()
Returns the Song containing this SongMember. If this member is defunct, this will return the song that contained this member before the member was defuncted.

Specified by:
getSong in interface com.virtuosotechnologies.asaph.model.SongMember