XMT-O Reference Software

xmto2xmta.tree
Class AugmentationElement

java.lang.Object
  |
  +--xmto2xmta.tree.TreeElement
        |
        +--xmto2xmta.tree.ConvertElement
              |
              +--xmto2xmta.tree.TimingElement
                    |
                    +--xmto2xmta.tree.AugmentationElement
All Implemented Interfaces:
DefsObject
Direct Known Subclasses:
backdrop

public abstract class AugmentationElement
extends TimingElement
implements DefsObject

Class to group together the Structure type of elements.

History:


Field Summary
private static boolean debug_
          Whether debug information is to be printed to the console.
private  boolean isDefsParent_
           
private  boolean isInDefsTree_
           
private  boolean isInDefsTreeInitialized_
           
 
Fields inherited from class xmto2xmta.tree.TimingElement
timingElementRes_, xmto2XmtaRes_, xmtoAttrBegin_, xmtoAttrDur_, xmtoAttrEnd_, xmtoAttrEndsync_, xmtoAttrFill_, xmtoAttrFillDefault_, xmtoAttrMax_, xmtoAttrMin_, xmtoAttrRepeatCount_, xmtoAttrRepeatDur_, xmtoAttrRestart_, xmtoAttrRestartDefault_
 
Fields inherited from class xmto2xmta.tree.ConvertElement
convertIndexTable_, index_, xmtaDoc_, xmtaIds_, xmtaParNodes_, xmtaParOds_, xmtaParRoutes_, xmto2Xmta_, xmtoAttrId_, xmtoElement_, xmtoIds_
 
Fields inherited from class xmto2xmta.tree.TreeElement
children, parent_
 
Constructor Summary
AugmentationElement(org.w3c.dom.Element xmtoElement, java.util.Hashtable xmtoIds, java.util.Hashtable xmtaIds, java.util.Hashtable convertIndexTable, org.w3c.dom.Document xmtaDoc, Xmto2Xmta xmto2Xmta)
          constructor.
 
Method Summary
 void initDefsFlags()
          Routine to initialize the defs query flags.
 boolean isDefsParent()
          Determine whether the object is a child of the defs element or not.
 boolean isInDefsTree()
          Determine whether the object is in the defs tree or not.
static void setDebug(boolean debug)
          Enable debugging information to be printed to the console.
 
Methods inherited from class xmto2xmta.tree.TimingElement
getXmtoAttrBegin, getXmtoAttrDur, getXmtoAttrEnd, getXmtoAttrEndsync, getXmtoAttrFill, getXmtoAttrFillDefault, getXmtoAttrMax, getXmtoAttrMin, getXmtoAttrRepeatCount, getXmtoAttrRepeatDur, getXmtoAttrRepeatRestart, getXmtoAttrRepeatRestartDefault, handleValidateSyntax, validateDefsObjectTimingSyntax, validateSyntax
 
Methods inherited from class xmto2xmta.tree.ConvertElement
addToParNode, addToParOd, addToParRoutes, createChildren, fireErrorEvent, fireErrorEvent, fireErrorEvent, getConvertIndexTable, getIndex, getXmtaDoc, getXmtaIds, getXmto2Xmta, getXmtoAttrId, getXmtoElement, getXmtoIds, insertIntoXmtaTree, remove
 
Methods inherited from class xmto2xmta.tree.TreeElement
addChild, getChildren, getParent, removeChild, setParent, toString
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 
Methods inherited from interface xmto2xmta.tree.DefsObject
getXmtaDefsId
 

Field Detail

debug_

private static boolean debug_
Whether debug information is to be printed to the console. default is not have debug information printed (false).

isInDefsTreeInitialized_

private boolean isInDefsTreeInitialized_

isInDefsTree_

private boolean isInDefsTree_

isDefsParent_

private boolean isDefsParent_
Constructor Detail

AugmentationElement

public AugmentationElement(org.w3c.dom.Element xmtoElement,
                           java.util.Hashtable xmtoIds,
                           java.util.Hashtable xmtaIds,
                           java.util.Hashtable convertIndexTable,
                           org.w3c.dom.Document xmtaDoc,
                           Xmto2Xmta xmto2Xmta)
constructor.
Parameters:
xmtoElement - XMT-O element for conversion.
xmtoIds - hashtable to contain XMT-O Conversion elements with the key of their XMT-O id.
xmtaIds - hashtable to contain XMT-A elements with the key of their XMT-A id.
xmtaDoc - DOM Document for the new XMT-A elements.
xmto2Xmta - Converter, used for firing error events.
Method Detail

initDefsFlags

public void initDefsFlags()
Routine to initialize the defs query flags. This is added to provide consistency for all the classes that implement the DefsObject interface.
Specified by:
initDefsFlags in interface DefsObject

isDefsParent

public boolean isDefsParent()
Determine whether the object is a child of the defs element or not. This means that the object is a direct child of the defs element. It isn't a child if it isn't in the defs tree or is a descendent (starting at grandchild) of the defs element.
Specified by:
isDefsParent in interface DefsObject
Returns:
whether the object is a child of the defs element. True if it is a child of the defs element, false otherwise.

isInDefsTree

public boolean isInDefsTree()
Determine whether the object is in the defs tree or not. This means that the object is defined somewhere in the Defs tree. It may be a child or descendent of the defs element.
Specified by:
isInDefsTree in interface DefsObject
Returns:
whether the object is in the defs tree. True if a descendent of the defs element, false otherwise.

setDebug

public static void setDebug(boolean debug)
Enable debugging information to be printed to the console.
Parameters:
debug - sets debug information is printed

XMT-O Reference Software