XMT-O Reference Software

xmto2xmta.tree
Class ExternalElement

java.lang.Object
  |
  +--xmto2xmta.tree.TreeElement
        |
        +--xmto2xmta.tree.ConvertElement
              |
              +--xmto2xmta.tree.TimingElement
                    |
                    +--xmto2xmta.tree.MediaElement
                          |
                          +--xmto2xmta.tree.ExternalElement
All Implemented Interfaces:
ParContainable, Sensorable
Direct Known Subclasses:
audio, ExternalVisualElement

public abstract class ExternalElement
extends MediaElement

Class to group together the various type media elements whose data is external to the XMT file.

History:


Field Summary
private static boolean debug_
          Whether debug information is to be printed to the console.
private  java.util.ResourceBundle externalElementRes_
           
private static java.lang.String FILE_URL_PREFIX
           
private static java.lang.String ODID_URL_PREFIX
           
private  java.util.Hashtable xmtaEsDescriptorIds_
           
private  java.util.Hashtable xmtaObjectDescriptorIds_
           
private  java.lang.String xmtoAttrSrc_
           
 
Fields inherited from class xmto2xmta.tree.MediaElement
classesLoaded_, enableTouchSensor_, groupClass_, headClass_, xmtaConditionalDeleteIds_, xmtaConditionalDeleteTimerIds_, xmtaConditionalInsertIds_, xmtaConditionalInsertTimerIds_, xmtaGroupIds_, xmtaSwitchIds_, xmtaTimeSensorBeginOffsetIds_, xmtaTimeSensorEndOffsetIds_, xmtaTouchSensorIds_, xmtaTransform2dIds_, xmtaValuatorIds_, xmto2XmtaRes_, xmtoAttrRegion_
 
Fields inherited from class xmto2xmta.tree.TimingElement
timingElementRes_, 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
ExternalElement(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
 java.lang.String getXmtaEsDescriptorId(ELASid elasId)
          Get the id for the Es Descriptor element.
 java.lang.String getXmtaObjectDescriptorId(ELASid elasId)
          Get the id for the Object Descriptor element.
 java.lang.String getXmtoAttrSrc()
           
 java.lang.String getXmtoAttrSrcCanonical()
          Return the canonical path of the file that the src attribute refers to.
protected  boolean handleValidateSyntax(java.lang.String attributeName, java.lang.String attributeValue)
          Handle the attribute by checking its syntax.
static void setDebug(boolean debug)
          Enable debugging information to be printed to the console.
 boolean validateSyntax()
          Validate the syntax of the element.
 
Methods inherited from class xmto2xmta.tree.MediaElement
enableTouchSensor, getXmtaConditionalDeleteId, getXmtaConditionalDeleteTimerId, getXmtaConditionalInsertId, getXmtaConditionalInsertTimerId, getXmtaGroupId, getXmtaSwitchId, getXmtaTimeSensorBeginOffsetId, getXmtaTimeSensorEndOffsetId, getXmtaTouchSensorId, getXmtaTransform2dId, getXmtaValuatorId, getXmtoAttrRegion, loadClasses, touchSensorEnabled
 
Methods inherited from class xmto2xmta.tree.TimingElement
getXmtoAttrBegin, getXmtoAttrDur, getXmtoAttrEnd, getXmtoAttrEndsync, getXmtoAttrFill, getXmtoAttrFillDefault, getXmtoAttrMax, getXmtoAttrMin, getXmtoAttrRepeatCount, getXmtoAttrRepeatDur, getXmtoAttrRepeatRestart, getXmtoAttrRepeatRestartDefault, validateDefsObjectTimingSyntax
 
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
 

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

ODID_URL_PREFIX

private static final java.lang.String ODID_URL_PREFIX

FILE_URL_PREFIX

private static final java.lang.String FILE_URL_PREFIX

xmtoAttrSrc_

private java.lang.String xmtoAttrSrc_

xmtaObjectDescriptorIds_

private java.util.Hashtable xmtaObjectDescriptorIds_

xmtaEsDescriptorIds_

private java.util.Hashtable xmtaEsDescriptorIds_

externalElementRes_

private java.util.ResourceBundle externalElementRes_
Constructor Detail

ExternalElement

public ExternalElement(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

getXmtaEsDescriptorId

public java.lang.String getXmtaEsDescriptorId(ELASid elasId)
Get the id for the Es Descriptor element.

getXmtaObjectDescriptorId

public java.lang.String getXmtaObjectDescriptorId(ELASid elasId)
Get the id for the Object Descriptor element.

getXmtoAttrSrc

public java.lang.String getXmtoAttrSrc()

getXmtoAttrSrcCanonical

public java.lang.String getXmtoAttrSrcCanonical()
Return the canonical path of the file that the src attribute refers to. The file is relative to the document path.

handleValidateSyntax

protected boolean handleValidateSyntax(java.lang.String attributeName,
                                       java.lang.String attributeValue)
Handle the attribute by checking its syntax. This is to catch all syntax errors which the schema can not check for, and thus the DOM parser doesn't find any problems. Call the parent handler to see if it can handle the attribute or not.
Overrides:
handleValidateSyntax in class MediaElement
Parameters:
attributeName - node name of attribute.
attributeValue - node value of attribute.
Returns:
whether this attribute is handled or not.

setDebug

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

validateSyntax

public boolean validateSyntax()
Validate the syntax of the element. This is to catch all syntax errors which the schema can not check for, and thus the DOM parser doesn't find any problems. Mainly check the begin, dur and end values to see they are valid timing attributes. If this is a problem then remove this node from the tree.
Overrides:
validateSyntax in class TimingElement

XMT-O Reference Software