XMT-O Reference Software

xmto2xmta.tree
Class group

java.lang.Object
  |
  +--xmto2xmta.tree.TreeElement
        |
        +--xmto2xmta.tree.ConvertElement
              |
              +--xmto2xmta.tree.TimingElement
                    |
                    +--xmto2xmta.tree.GroupElement
                          |
                          +--xmto2xmta.tree.group
All Implemented Interfaces:
Animatable, DefsObject, ParContainable, Sensorable, ZorderSupport

public class group
extends GroupElement
implements Sensorable, Animatable, DefsObject, ParContainable

Class to handle the conversion of the body element.

History:


Field Summary
private  java.lang.String[] animXmtaAttrFieldDefaultValue_
           
private  int[] animXmtaAttrFieldType_
           
private  java.lang.String[] animXmtaAttrName_
           
private  int[] animXmtoAttrFieldType_
           
private  java.lang.String[] animXmtoAttrName_
          NOTE: order has to be handled differently.
private static boolean classesLoaded_
           
private static boolean debug_
          Whether debug information is to be printed to the console.
private static java.lang.Class headClass_
           
private  boolean isDefsParent_
           
private  boolean isInDefsTree_
           
private  boolean isInDefsTreeInitialized_
           
private  java.lang.String xmtaAttrCenter_
           
private  java.lang.String xmtaAttrRotation_
           
private  java.lang.String xmtaAttrScale_
           
private  java.lang.String xmtaAttrScaleOrientation_
           
private  java.lang.String xmtaAttrTranslation_
           
private  java.lang.String xmtaAttrWhichChoice_
           
private  java.util.Hashtable xmtaGroupIds_
           
private  java.util.Hashtable xmtaLayer2dIds_
           
private  java.util.Hashtable xmtaOrderedGroupIds_
           
private  java.util.Hashtable xmtaSwitchIds_
           
private  java.util.Hashtable xmtaTouchSensorIds_
           
private  java.util.Hashtable xmtaTransform2dIds_
           
private  java.util.ResourceBundle xmto2XmtaRes_
           
private  java.lang.String xmtoAttrOrder_
           
private  java.lang.String xmtoAttrRegion_
           
private  java.lang.String xmtoAttrSize_
           
 
Fields inherited from class xmto2xmta.tree.GroupElement
deletePositions_, getXmtoAttrOrderMethodGroup_, getXmtoAttrOrderMethodTransformation_, getXmtoAttrRegionMethodGroup_, groupClass_, groupElementRes_, positionsDetermined_, transformationClass_, usePositions_
 
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_
 
Fields inherited from interface xmto2xmta.tree.Animatable
TYPE_MFBool, TYPE_MFColor, TYPE_MFFloat, TYPE_MFInt32, TYPE_MFString, TYPE_MFVec2f, TYPE_SFBool, TYPE_SFColor, TYPE_SFFloat, TYPE_SFInt32, TYPE_SFString, TYPE_SFVec2f, TYPE_UNSUPPORTED
 
Constructor Summary
group(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 getAnimConvertValueXmto2Xmta(java.lang.String xmtoAttrName, java.lang.String xmtoValue, int xmtoFieldType, int xmtaFieldType)
          This function converts a xmto attribute value to its xmta equivalent.
 int getAnimXmtaAttrFieldType(java.lang.String xmtoAttrName)
          This function returns the MPEG-4 field type being animated.
 java.lang.String getAnimXmtaAttrInitialValue(java.lang.String xmtoAttrName)
          This function returns the initial value of the field begin animated.
 java.lang.String getAnimXmtaAttrName(java.lang.String xmtoAttrName)
          This function returns the MPEG-4 field being animated.
 java.lang.String getAnimXmtaDefsNodeId(java.lang.String attributeName)
          This function returns the MPEG-4 node whose field is being animated.
 java.lang.String getAnimXmtaNodeId(java.lang.String xmtoAttrName, ELASid elasId)
          This function returns the MPEG-4 node whose field is being animated.
 int getAnimXmtoAttrFieldType(java.lang.String xmtoAttrName)
          This function returns the MPEG-4 field type being animated.
 java.lang.String getXmtaAttrCenter()
           
 java.lang.String getXmtaAttrRotation()
           
 java.lang.String getXmtaAttrScale()
           
 java.lang.String getXmtaAttrScaleOrientation()
           
 java.lang.String getXmtaAttrTranslation()
           
 java.lang.String getXmtaAttrWhichChoice()
           
 java.lang.String getXmtaDefsId()
          Get the defs id of the object.
 java.lang.String getXmtaGroupId(ELASid elasId)
          Get the id for the group element.
 java.lang.String getXmtaLayer2dId(ELASid elasId)
          Get the id for the XMT-A ordered group to which media objects are added.
 java.lang.String getXmtaOrderedGroupId(ELASid elasId)
          Get the id for the XMT-A ordered group to which media objects are added.
 java.lang.String getXmtaSwitchId(ELASid elasId)
          Get the id for the XMT-A ordered group to which media objects are added.
 java.lang.String getXmtaTouchSensorId(ELASid elasId)
          Get the id for the XMT-A ordered group to which media objects are added.
 java.lang.String getXmtaTransform2dId(ELASid elasId)
          Get the id for the XMT-A ordered group to which media objects are added.
 java.lang.String getXmtaTranslation()
           
 java.lang.String getXmtoAttrOrder()
           
 java.lang.String getXmtoAttrRegion()
           
 java.lang.String getXmtoAttrSize()
           
 boolean handleValidateSyntax(java.lang.String attributeName, java.lang.String attributeValue)
          Handle the attribute by checking its syntax.
 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.
private static void loadClasses()
           
static void setDebug(boolean debug)
          Enable debugging information to be printed to the console.
 java.lang.String toString()
           
 
Methods inherited from class xmto2xmta.tree.GroupElement
determineChildrenElements, determineDeleteFieldPositions, determineDeletePositions, determineDeletePositions, determineUsePosition, getDeleteFieldPosition, usePositions
 
Methods inherited from class xmto2xmta.tree.TimingElement
getXmtoAttrBegin, getXmtoAttrDur, getXmtoAttrEnd, getXmtoAttrEndsync, getXmtoAttrFill, getXmtoAttrFillDefault, getXmtoAttrMax, getXmtoAttrMin, getXmtoAttrRepeatCount, getXmtoAttrRepeatDur, getXmtoAttrRepeatRestart, getXmtoAttrRepeatRestartDefault, 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
 
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).

xmtoAttrOrder_

private java.lang.String xmtoAttrOrder_

xmtoAttrRegion_

private java.lang.String xmtoAttrRegion_

xmtoAttrSize_

private java.lang.String xmtoAttrSize_

xmtaAttrWhichChoice_

private java.lang.String xmtaAttrWhichChoice_

xmtaAttrCenter_

private java.lang.String xmtaAttrCenter_

xmtaAttrScale_

private java.lang.String xmtaAttrScale_

xmtaAttrScaleOrientation_

private java.lang.String xmtaAttrScaleOrientation_

xmtaAttrTranslation_

private java.lang.String xmtaAttrTranslation_

xmtaAttrRotation_

private java.lang.String xmtaAttrRotation_

xmtaGroupIds_

private java.util.Hashtable xmtaGroupIds_

xmtaOrderedGroupIds_

private java.util.Hashtable xmtaOrderedGroupIds_

xmtaTouchSensorIds_

private java.util.Hashtable xmtaTouchSensorIds_

xmtaSwitchIds_

private java.util.Hashtable xmtaSwitchIds_

xmtaTransform2dIds_

private java.util.Hashtable xmtaTransform2dIds_

xmtaLayer2dIds_

private java.util.Hashtable xmtaLayer2dIds_

headClass_

private static java.lang.Class headClass_

classesLoaded_

private static boolean classesLoaded_

isInDefsTreeInitialized_

private boolean isInDefsTreeInitialized_

isInDefsTree_

private boolean isInDefsTree_

isDefsParent_

private boolean isDefsParent_

animXmtoAttrName_

private java.lang.String[] animXmtoAttrName_
NOTE: order has to be handled differently. They are not just a field replacement.

animXmtoAttrFieldType_

private int[] animXmtoAttrFieldType_

animXmtaAttrName_

private java.lang.String[] animXmtaAttrName_

animXmtaAttrFieldType_

private int[] animXmtaAttrFieldType_

animXmtaAttrFieldDefaultValue_

private java.lang.String[] animXmtaAttrFieldDefaultValue_

xmto2XmtaRes_

private java.util.ResourceBundle xmto2XmtaRes_
Constructor Detail

group

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

getAnimConvertValueXmto2Xmta

public java.lang.String getAnimConvertValueXmto2Xmta(java.lang.String xmtoAttrName,
                                                     java.lang.String xmtoValue,
                                                     int xmtoFieldType,
                                                     int xmtaFieldType)
This function converts a xmto attribute value to its xmta equivalent. It then returns the converted value.
Specified by:
getAnimConvertValueXmto2Xmta in interface Animatable

getAnimXmtaAttrFieldType

public int getAnimXmtaAttrFieldType(java.lang.String xmtoAttrName)
This function returns the MPEG-4 field type being animated. e.g. SFVec2f, MFVec3f, SFColor, MFColor, ...
Specified by:
getAnimXmtaAttrFieldType in interface Animatable

getAnimXmtaAttrInitialValue

public java.lang.String getAnimXmtaAttrInitialValue(java.lang.String xmtoAttrName)
This function returns the initial value of the field begin animated. This is used in case the attribute is not specified in the animaiton. Generally this is the original value so that after the animation is finished the node field can be returned to its original state. If this value isn't specified then the default value will be used.
Specified by:
getAnimXmtaAttrInitialValue in interface Animatable

getAnimXmtaAttrName

public java.lang.String getAnimXmtaAttrName(java.lang.String xmtoAttrName)
This function returns the MPEG-4 field being animated.
Specified by:
getAnimXmtaAttrName in interface Animatable

getAnimXmtaDefsNodeId

public java.lang.String getAnimXmtaDefsNodeId(java.lang.String attributeName)
This function returns the MPEG-4 node whose field is being animated.

Normally: This method is for when there is no elasId for this instantiation of the object. This can occur for xMediaChildrenObject that are defs objects, but the parent isn't a TimingElement.

In this case where we are a subclass of TimingElement it is not possible not have an elasId since we are a timing element.


getAnimXmtaNodeId

public java.lang.String getAnimXmtaNodeId(java.lang.String xmtoAttrName,
                                          ELASid elasId)
This function returns the MPEG-4 node whose field is being animated.
Specified by:
getAnimXmtaNodeId in interface Animatable

getAnimXmtoAttrFieldType

public int getAnimXmtoAttrFieldType(java.lang.String xmtoAttrName)
This function returns the MPEG-4 field type being animated. e.g. SFVec2f, MFVec3f, SFColor, MFColor, ...
Specified by:
getAnimXmtoAttrFieldType in interface Animatable

getXmtaAttrCenter

public java.lang.String getXmtaAttrCenter()

getXmtaAttrRotation

public java.lang.String getXmtaAttrRotation()

getXmtaAttrScale

public java.lang.String getXmtaAttrScale()

getXmtaAttrScaleOrientation

public java.lang.String getXmtaAttrScaleOrientation()

getXmtaAttrTranslation

public java.lang.String getXmtaAttrTranslation()

getXmtaAttrWhichChoice

public java.lang.String getXmtaAttrWhichChoice()

getXmtaDefsId

public java.lang.String getXmtaDefsId()
Get the defs id of the object.
Specified by:
getXmtaDefsId in interface DefsObject
Returns:
the unique id of this object.

getXmtaGroupId

public java.lang.String getXmtaGroupId(ELASid elasId)
Get the id for the group element.

getXmtaLayer2dId

public java.lang.String getXmtaLayer2dId(ELASid elasId)
Get the id for the XMT-A ordered group to which media objects are added.
Returns:
the id (DEF) of the XMT-A ordered group.

getXmtaOrderedGroupId

public java.lang.String getXmtaOrderedGroupId(ELASid elasId)
Get the id for the XMT-A ordered group to which media objects are added.
Overrides:
getXmtaOrderedGroupId in class GroupElement
Returns:
the id (DEF) of the XMT-A ordered group.

getXmtaSwitchId

public java.lang.String getXmtaSwitchId(ELASid elasId)
Get the id for the XMT-A ordered group to which media objects are added.
Returns:
the id (DEF) of the XMT-A ordered group.

getXmtaTouchSensorId

public java.lang.String getXmtaTouchSensorId(ELASid elasId)
Get the id for the XMT-A ordered group to which media objects are added.
Specified by:
getXmtaTouchSensorId in interface Sensorable
Returns:
the id (DEF) of the XMT-A ordered group.

getXmtaTransform2dId

public java.lang.String getXmtaTransform2dId(ELASid elasId)
Get the id for the XMT-A ordered group to which media objects are added.
Returns:
the id (DEF) of the XMT-A ordered group.

getXmtaTranslation

public java.lang.String getXmtaTranslation()

getXmtoAttrOrder

public java.lang.String getXmtoAttrOrder()

getXmtoAttrRegion

public java.lang.String getXmtoAttrRegion()

getXmtoAttrSize

public java.lang.String getXmtoAttrSize()

handleValidateSyntax

public 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 TimingElement
Parameters:
attributeName - node name of attribute.
attributeValue - node value of attribute.
Returns:
whether this attribute is handled or not.

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.

loadClasses

private static void loadClasses()

setDebug

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

toString

public java.lang.String toString()
Overrides:
toString in class TreeElement

XMT-O Reference Software