vona.dae.util

Class DAEObject

java.lang.Object

vona.dae.util.DAEObject

public class DAEObject
extends java.lang.Object

Base class for all JAXB generated classes.

Author:

Marsette A. Vona, III

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,DAEObject>	idIndex Index mapping XML ID to the corresponding element.
DAEObject	parent Reference to the parent of this object in the COLLADA document, if any.
protected java.util.Map<java.lang.String,java.lang.Object>	properties properties map
private static java.lang.String	svnid
protected static java.lang.String[][]	XML_SPECIALS
protected int	xmlLineNumber memo for getXMLLineNumber()

Constructor Summary

Constructors

Constructor and Description
DAEObject()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterUnmarshal(javax.xml.bind.Unmarshaller u, java.lang.Object parent) Called by JAXB unmarshal after all properties have been unmarshalled for this object (except IDREF).
DAEObject	dereferenceInstance() If isInstanceRef(), try to resolve the referenced entity.
protected static java.lang.String	etterName(java.lang.reflect.Field field, boolean plural, java.lang.String prefix) Common impl of getterName(Field, boolean), setterName(Field, boolean).
java.util.List<DAEObject>	getDAEChildElements() Get a list of all XML child elements.
DAEObject	getDAERoot() Get the root element of the enclosing COLLADA document by following parent pointers.
java.lang.Object	getFieldValue(java.lang.reflect.Field field) getFieldValue(Field, boolean), not plural
java.lang.Object	getFieldValue(java.lang.reflect.Field field, boolean plural) Get the value of the Java field with the given name.
java.lang.Object	getFieldValue(java.lang.String fieldName) covers getFieldValue(String, boolean), not plural
java.lang.Object	getFieldValue(java.lang.String fieldName, boolean plural) covers getFieldValue(Field, boolean)
java.lang.Object	getFieldValueSafely(java.lang.reflect.Field field) getFieldValueSafely(Field, boolean), not plural
java.lang.Object	getFieldValueSafely(java.lang.reflect.Field field, boolean plural) getFieldValue(Field, boolean) but also return null on introspection error.
java.lang.String	getLocatorMessage() Try to get a message fragment describing the XML document source location of this element, if known.
java.lang.Object	getProperty(java.lang.String key) get the value of a user property
DAEObject	getScopedChild(java.lang.String sid) Look for a child element of this DAE object which has an attribute named "sid" whose value matches the passed sid.
java.lang.String	getSidSafely() Get the COLLADA sid (scoped identifier) attribute of this elment if any, else null.
static java.lang.String	getterName(java.lang.reflect.Field field) getterName(Field, boolean), not plural
static java.lang.String	getterName(java.lang.reflect.Field field, boolean plural) Compute the default JAXB generated get-method name for field.
int	getXMLLineNumber() Attempt to get the XML line number corresponding to this object.
java.lang.String	getXMLStringAttributeSafely(java.lang.String name) Get the String value of the named XML attribute if any, else null.
boolean	hasIDIndex() Check if the root element of the COLLADA document containing this object has been indexed.
boolean	hasProperty(java.lang.String key) check if a user property is set
boolean	isInstanceRef() Try to determine if this COLLADA entity is an instance reference, such as "instance_node".
int	reIndexIDs() (re)Index the cached XML ID to element mapping for the COLLADA document containing this element.
protected int	reIndexIDs(java.util.Map<java.lang.String,DAEObject> index) recursive impl of reIndexIDs()
DAEObject	resolveIDRef(java.lang.String idref) Resolve an XML IDREF within the enclosing COLLADA document.
DAEObject	resolveSidRef(java.lang.String sidref) Resolve sidref globally in the enclosing COLLADA document.
DAEObject	resolveSidRefFromHere(java.lang.String sidref) resolveSidRefFromHere(String, int), always process all segments.
DAEObject	resolveSidRefFromHere(java.lang.String sidref, int maxSegments) Walk down the DAE element tree using getScopedChild(java.lang.String), resolving sidref as if its first path element corresponded to this element.
java.lang.Object	setProperty(java.lang.String key, java.lang.Object value) Set the value of a user property.
static java.lang.String	setterName(java.lang.reflect.Field field) setterName(Field, boolean), not plural
static java.lang.String	setterName(java.lang.reflect.Field field, boolean plural) Compute the default JAXB generated set-method name for field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

svnid

private static final java.lang.String svnid

See Also:

Constant Field Values

parent

public DAEObject parent

Reference to the parent of this object in the COLLADA document, if any.

This is automatically set by JAXB unmarshal in afterUnmarshal(javax.xml.bind.Unmarshaller, java.lang.Object).

Publicly writeable since it will need to be externally set (if needed) on objects that are consed or re-parented.

idIndex

protected java.util.Map<java.lang.String,DAEObject> idIndex

Index mapping XML ID to the corresponding element.

Normally this is only non-null on the root element of the COLLADA document. See reIndexIDs().

properties

protected java.util.Map<java.lang.String,java.lang.Object> properties

properties map

xmlLineNumber

protected int xmlLineNumber

memo for getXMLLineNumber()

XML_SPECIALS

protected static final java.lang.String[][] XML_SPECIALS

Constructor Detail

DAEObject

public DAEObject()

Method Detail

getFieldValue

public java.lang.Object getFieldValue(java.lang.reflect.Field field,
                             boolean plural)

Get the value of the Java field with the given name.

Throws:

java.lang.IllegalStateException - if there was an introspection error

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName,
                             boolean plural)

covers getFieldValue(Field, boolean)

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)

covers getFieldValue(String, boolean), not plural

getterName

public static java.lang.String getterName(java.lang.reflect.Field field,
                          boolean plural)

Compute the default JAXB generated get-method name for field.

getterName

public static java.lang.String getterName(java.lang.reflect.Field field)

getterName(Field, boolean), not plural

setterName

public static java.lang.String setterName(java.lang.reflect.Field field,
                          boolean plural)

Compute the default JAXB generated set-method name for field.

setterName

public static java.lang.String setterName(java.lang.reflect.Field field)

setterName(Field, boolean), not plural

etterName

protected static java.lang.String etterName(java.lang.reflect.Field field,
                         boolean plural,
                         java.lang.String prefix)

Common impl of getterName(Field, boolean), setterName(Field, boolean).

getFieldValue

public java.lang.Object getFieldValue(java.lang.reflect.Field field)

getFieldValue(Field, boolean), not plural

getFieldValueSafely

public java.lang.Object getFieldValueSafely(java.lang.reflect.Field field,
                                   boolean plural)

getFieldValue(Field, boolean) but also return null on introspection error.

getFieldValueSafely

public java.lang.Object getFieldValueSafely(java.lang.reflect.Field field)

getFieldValueSafely(Field, boolean), not plural

getXMLStringAttributeSafely

public java.lang.String getXMLStringAttributeSafely(java.lang.String name)

Get the String value of the named XML attribute if any, else null.

getSidSafely

public java.lang.String getSidSafely()

Get the COLLADA sid (scoped identifier) attribute of this elment if any, else null.

getDAERoot

public DAEObject getDAERoot()

Get the root element of the enclosing COLLADA document by following parent pointers.

getDAEChildElements

public java.util.List<DAEObject> getDAEChildElements()

Get a list of all XML child elements.

getScopedChild

public DAEObject getScopedChild(java.lang.String sid)

Look for a child element of this DAE object which has an attribute named "sid" whose value matches the passed sid.

According to the COLLADA spec, it is an error for more than one child element to have equal sid attributes. Should this occur anyway, one of the matched children will be returned, but in an unspecified order.

Returns:

the child element with scoped identifier sid, or null if not found

Throws:

java.lang.IllegalStateException - if there was an introspection error while traversing the document tree

isInstanceRef

public boolean isInstanceRef()

Try to determine if this COLLADA entity is an instance reference, such as "instance_node".

dereferenceInstance

public DAEObject dereferenceInstance()

If isInstanceRef(), try to resolve the referenced entity.

Current impl is limited to local URL fragments that can be resolved by resolveIDRef(java.lang.String).

Throws:

java.lang.IllegalStateException - if not isInstanceRef(), no "url" or "target" string attribute, or if the reference could not be resolved by resolveIDRef(java.lang.String)

hasIDIndex

public boolean hasIDIndex()

Check if the root element of the COLLADA document containing this object has been indexed.

Also see reIndexIDs().

reIndexIDs

public int reIndexIDs()

(re)Index the cached XML ID to element mapping for the COLLADA document containing this element.

This is automatically called when JAXB calls afterUnmarshal(javax.xml.bind.Unmarshaller, java.lang.Object) for the root element.

All parent pointers from here to the document root must be set.

Returns:

the number of mapped IDs

Throws:

java.lang.IllegalStateException - if there is an ID collision or if there was an introspection error while traversing the document tree

reIndexIDs

protected int reIndexIDs(java.util.Map<java.lang.String,DAEObject> index)

recursive impl of reIndexIDs()

resolveIDRef

public DAEObject resolveIDRef(java.lang.String idref)

Resolve an XML IDREF within the enclosing COLLADA document.

The resolution is based on the most recent index, see reIndexIDs().

All parent pointers from here to the document root must be set.

Parameters:

idref - the IDREF, the prefix '#' and the first '/' and any following suffix are ignored, null ok

Returns:

the resolved element or null if not found

Throws:

java.lang.NullPointerException - if the document has not yet been indexed

resolveSidRef

public DAEObject resolveSidRef(java.lang.String sidref)

Resolve sidref globally in the enclosing COLLADA document.

This is a combination of resolveIDRef(java.lang.String) on the first path element and resolveSidRefFromHere(java.lang.String, int) on the rest.

All parent pointers from here to the document root must be set.

Returns:

the resolved element or null if resolution failed

resolveSidRefFromHere

public DAEObject resolveSidRefFromHere(java.lang.String sidref,
                              int maxSegments)

Walk down the DAE element tree using getScopedChild(java.lang.String), resolving sidref as if its first path element corresponded to this element.

The optional "structure member selection syntax" for the final path element is not currently supported. If the final path element contains '(' the resolution will fail. Any '.' it may contain is treated no diferently than any other character of the sid (sids can legally contain '.').

Resolving the child of any encountered instance reference (see isInstanceRef()) is handled specially. First, the lexical child is searched. If not found, this method attempts to dereferenceInstance() and then search the child in the referenced instance.

Parameters:

maxSegments - only resolve at most this number of path segments, zero or negative to process all segments

Returns:

the resolved element or null if resolution failed

Throws:

java.lang.IllegalStateException - if dereferenceInstance() encountered a problem

resolveSidRefFromHere

public DAEObject resolveSidRefFromHere(java.lang.String sidref)

resolveSidRefFromHere(String, int), always process all segments.

afterUnmarshal

public void afterUnmarshal(javax.xml.bind.Unmarshaller u,
                  java.lang.Object parent)

Called by JAXB unmarshal after all properties have been unmarshalled for this object (except IDREF).

Default impl sets parent and reIndexIDs() for the root element.

getXMLLineNumber

public int getXMLLineNumber()

Attempt to get the XML line number corresponding to this object.

Memoized.

Returns:

the line number or -1 if unknown

getLocatorMessage

public java.lang.String getLocatorMessage()

Try to get a message fragment describing the XML document source location of this element, if known.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           java.lang.Object value)

Set the value of a user property.

Returns:

the previously set value, if any

getProperty

public java.lang.Object getProperty(java.lang.String key)

get the value of a user property

hasProperty

public boolean hasProperty(java.lang.String key)

check if a user property is set