XMT-O Reference Software

xmto2xmta.tree
Class transformation

java.lang.Object
  |
  +--xmto2xmta.tree.TreeElement
        |
        +--xmto2xmta.tree.ConvertElement
              |
              +--xmto2xmta.tree.XmediaChildrenElement
                    |
                    +--xmto2xmta.tree.transformation
All Implemented Interfaces:
Animatable

public class transformation
extends XmediaChildrenElement
implements Animatable

Class to handle the conversion of the transformation 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 debug_
          Whether debug information is to be printed to the console.
private  java.util.ResourceBundle transformationRes_
           
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.ResourceBundle xmto2XmtaRes_
           
private  java.lang.String xmtoAttrOrder_
           
private  java.lang.String xmtoAttrVisibility_
           
 
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
transformation(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 getXmtoAttrOrder()
           
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.
 java.lang.String toString()
           
 
Methods inherited from class xmto2xmta.tree.ConvertElement
addToParNode, addToParOd, addToParRoutes, createChildren, fireErrorEvent, fireErrorEvent, fireErrorEvent, getConvertIndexTable, getIndex, getXmtaDoc, getXmtaIds, getXmto2Xmta, getXmtoAttrId, getXmtoElement, getXmtoIds, insertIntoXmtaTree, remove, validateSyntax
 
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).

xmtaAttrWhichChoice_

private java.lang.String xmtaAttrWhichChoice_

xmtoAttrVisibility_

private java.lang.String xmtoAttrVisibility_

xmtoAttrOrder_

private java.lang.String xmtoAttrOrder_

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_

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_

transformationRes_

private java.util.ResourceBundle transformationRes_
Constructor Detail

transformation

public transformation(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 transformation it is not possible to have the elasId since the parent is always a timing element. The transformation can not occur as a direct child of the defs 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()

getXmtoAttrOrder

public java.lang.String getXmtoAttrOrder()

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 ConvertElement
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

toString

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

XMT-O Reference Software