Package xj3d.filter.node

Class CommonEncodable

java.lang.Object

xj3d.filter.node.CommonEncodable

All Implemented Interfaces:

Encodable

Direct Known Subclasses:

CommonScene

public class CommonEncodable
extends Object
implements Encodable

A generic container for X3D content parsed from a file. This representation is minimalistic. The nodes contain only the fields extracted from the file, no 'default' values are initialized. inputOnly and outputOnly fields are not supported. This container is a static representation of an X3D file and is not suited for runtime purposes.

A VRMLFieldReader instance must be set to this before initializing fields. String Field values will automatically be converted into their respective 'primitive' forms. The specific types of field data returned are:

• Primitive type field values are returned in their respective Java wrapper.
• Array type field values are returned in an ArrayData object.
• SFNode type field values are returned as CommonEncodables.
• MFNode type field values are returned in an List<CommonEncodable>.

A ContentHandler instance must be set to this to support encoding.

Version:

$Revision: 1.0 $

Author:

Rex Melton

Field Summary

Fields

Modifier and Type	Field	Description
protected BinaryContentHandler	bch	Binary Content Handler reference
String	defName	The node's DEF name
protected VRMLFieldReader	fieldReader	The field parser
protected ContentHandler	handler	Content Handler reference
static final int	HANDLER_BINARY	Content Handler Types
static final int	HANDLER_NULL
static final int	HANDLER_STRING
protected int	handlerType	Flag indicating that the content handler is an instance of a BinaryContentHandler, a StringContentHandler, or null
protected StringContentHandler	sch	String Content Handler reference
protected ScriptHandler	scriptHandler	Content Handler reference
String	useName	The node's USE name

Constructor Summary

Constructors

Constructor	Description
CommonEncodable(String nodeName, FieldInfo[] fieldInfo, X3DConstants.TYPE[] nodeType)	Constructor

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the node fields to their initial (empty) values
CommonEncodable	clone(boolean full)	Create and return a unique copy of this object.
boolean	deepEquals(Encodable enc)	Compares this node to another and checks if all fields are the same and that all children fields are the same.
void	encode()	Push the node contents to the ContentHandler
void	encodeNode(boolean full)	Push the node contents to the ContentHandler
void	encodeShallow()	Push the node contents to the ContentHandler.
String[]	getAllFieldNames()	Return the array of all field names.
String	getDefName()	Return the DEF name of the node. null is returned if the DEF name is not set.
int	getFieldType(String fieldName)	Return the field type.
String[]	getNodeFieldNames()	Return the array of node type field names.
String	getNodeName()	Return the node name
X3DConstants.TYPE[]	getNodeTypes()	Return the array of X3D types that this node inherits from.
CommonEncodable	getParent()	Return the parent node of this
String[]	getUsedFieldNames()	Return the array of used field names.
String	getUseName()	Return the USE name of the node. null is returned if the USE name is not set.
Object	getValue(String fieldName)	Return field data.
boolean	isType(X3DConstants.TYPE type)	Return whether this node inherits from the specified type
void	setContentHandler(ContentHandler handler)	Set the content handler.
void	setDefName(String defName)	Set the DEF name of the node.
void	setFieldReader(VRMLFieldReader fieldReader)	Set the reader to use for parsing field values.
void	setParent(CommonEncodable parent)	Set the parent node of this
void	setScriptHandler(ScriptHandler handler)	Set the script handler.
void	setUseName(String useName)	Set the USE name of the node.
void	setValue(String fieldName, Object value)	Set the value of the named field.
void	setValue(String fieldName, Object value, int len)	Set the value of the named field.
String	toString()	Return a String representation of this.

Methods inherited from class java.lang.Object

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

Field Details

HANDLER_BINARY

public static final int HANDLER_BINARY

Content Handler Types

See Also:

• Constant Field Values

HANDLER_STRING

public static final int HANDLER_STRING

See Also:

• Constant Field Values

HANDLER_NULL

public static final int HANDLER_NULL

See Also:

• Constant Field Values

defName

public String defName

The node's DEF name

useName

public String useName

The node's USE name

fieldReader

protected VRMLFieldReader fieldReader

The field parser

handlerType

protected int handlerType

Flag indicating that the content handler is an instance of a BinaryContentHandler, a StringContentHandler, or null

handler

protected ContentHandler handler

Content Handler reference

scriptHandler

protected ScriptHandler scriptHandler

Content Handler reference

bch

protected BinaryContentHandler bch

Binary Content Handler reference

sch

protected StringContentHandler sch

String Content Handler reference

Constructor Details

CommonEncodable

public CommonEncodable(String nodeName,
 FieldInfo[] fieldInfo,
 X3DConstants.TYPE[] nodeType)

Constructor

Parameters:

nodeName - The node's name

fieldInfo - The node's field information.

nodeType - The nodes's inheritance information

Method Details

getNodeName

public String getNodeName()

Return the node name

Specified by:

getNodeName in interface Encodable

Returns:

The node name

getDefName

public String getDefName()

Return the DEF name of the node. null is returned if the DEF name is not set.

Specified by:

getDefName in interface Encodable

Returns:

the DEF name of the node

setDefName

public void setDefName(String defName)

Set the DEF name of the node. If the DEF name is non-null, this will clear the USE name if one is set.

Specified by:

setDefName in interface Encodable

Parameters:

defName - the DEF name of the node

getUseName

public String getUseName()

Return the USE name of the node. null is returned if the USE name is not set.

Specified by:

getUseName in interface Encodable

Returns:

the USE name of the node

setUseName

public void setUseName(String useName)

Set the USE name of the node. If the USE name is non-null, this will clear the DEF name if one is set. The fieldData of this node will remain unchanged by setting the USE name.

Specified by:

setUseName in interface Encodable

Parameters:

useName - the USE name of the node

clear

public void clear()

Clear the node fields to their initial (empty) values

Specified by:

clear in interface Encodable

encodeShallow

public void encodeShallow()

Push the node contents to the ContentHandler. Does not push MFNode children along, caller is reponsible for those.

encode

public void encode()

Push the node contents to the ContentHandler

Specified by:

encode in interface Encodable

encodeNode

public void encodeNode(boolean full)

Push the node contents to the ContentHandler

Parameters:

full -

setValue

public void setValue(String fieldName,
 Object value)

Set the value of the named field.

Specified by:

setValue in interface Encodable

Parameters:

fieldName - The field identifier

value - The field value

setValue

public void setValue(String fieldName,
 Object value,
 int len)

Set the value of the named field.

Specified by:

setValue in interface Encodable

Parameters:

fieldName - The field identifier

value - The field value. This must be a properly typed array.

len - The number of valid values in the array.

setFieldReader

public void setFieldReader(VRMLFieldReader fieldReader)

Set the reader to use for parsing field values.

Specified by:

setFieldReader in interface Encodable

Parameters:

fieldReader - The reader

setContentHandler

public void setContentHandler(ContentHandler handler)

Set the content handler.

Specified by:

setContentHandler in interface Encodable

Parameters:

handler - The ContentHandler instance to use

setScriptHandler

public void setScriptHandler(ScriptHandler handler)

Set the script handler.

Parameters:

handler - The ContentHandler instance to use

clone

public CommonEncodable clone(boolean full)

Create and return a unique copy of this object. A full clone will copy the node's field data. A non-full clone will have it's field data uninitialized. Neither case will copy the defName, useName or parent. Setting these is the user's responsibility.

Specified by:

clone in interface Encodable

Parameters:

full - true to copy the node's fields. false returns a new instance of this node type with it's field data uninitialized.

Returns:

a copy of this, initialized as specified.

deepEquals

public boolean deepEquals(Encodable enc)

Compares this node to another and checks if all fields are the same and that all children fields are the same.

DEF / USE handling

• If both nodes are DEF'ed, they are not equal, regardless of their field values.
• If one node USE's the other, they are equal.
• If both nodes USE the same DEF'ed node, they are equal.

The parent node is not considered in the comparison. Two nodes with different parents may be equal depending on their DEF/USE names and field values.

Specified by:

deepEquals in interface Encodable

Parameters:

enc - The node to compare with

Returns:

true if the nodes are determined to be equivalent, false if not.

setParent

public void setParent(CommonEncodable parent)

Set the parent node of this

Parameters:

parent - The parent node of this

getParent

public CommonEncodable getParent()

Return the parent node of this

Returns:

The parent node of this

getNodeTypes

public X3DConstants.TYPE[] getNodeTypes()

Return the array of X3D types that this node inherits from. If this node inherits from no known types, an empty array is returned. If this node is of an unknown type, null is returned.

Returns:

The array of X3D types that this node implements

isType

public boolean isType(X3DConstants.TYPE type)

Return whether this node inherits from the specified type

Parameters:

type - The type to check

Returns:

true if this node inherits from the specified type, false if not.

getValue

public Object getValue(String fieldName)

Return field data. If none is available, or the field is unknown, return null.

The specific types of field data returned are:

• Primitive type field values are returned in their respective Java wrapper.
• Array type field values are returned in an ArrayData object.
• SFNode type field values are returned as CommonEncodables.
• MFNode type field values are returned in an List<CommonEncodable>.

Parameters:

fieldName - The field identifier

Returns:

The field data

getFieldType

public int getFieldType(String fieldName)

Return the field type. If the field does not exist for this node, -1 is returned.

Parameters:

fieldName - The field identifier

Returns:

The field type.

getAllFieldNames

public String[] getAllFieldNames()

Return the array of all field names.

Returns:

The array of all field names.

getUsedFieldNames

public String[] getUsedFieldNames()

Return the array of used field names. If none are used, an empty String[] is returned.

Returns:

The array of used field names.

getNodeFieldNames

public String[] getNodeFieldNames()

Return the array of node type field names. If none are used, an empty String[] is returned.

Returns:

The array of node type field names.

toString

public String toString()

Return a String representation of this. The String contains the node name, DEF name and USE name.

Overrides:

toString in class Object

Returns:

A String representation of this