Package org.web3d.vrml.lang

Class VRMLFieldDeclaration

java.lang.Object

org.web3d.vrml.lang.VRMLFieldDeclaration

public class VRMLFieldDeclaration
extends Object

Representation of any field definition in the VRML system.

Each node contains a collection of fields. Each field has a fixed index for all instances of this node.

This class represents the declaration of a field rather than the complete field instance. For this reason it is immutable. You should not be allowed to change items of a field declaration on the fly.

Version:

$Revision: 1.17 $

Author:

Justin Couch

See Also:

• FieldConstants

Field Summary

Fields

Modifier and Type	Field	Description
static final String	UNKNOWN_IMPORT	Definition of a field type that we don't know yet because it came from an unresolved IMPORT statement.

Constructor Summary

Constructors

Constructor	Description
VRMLFieldDeclaration(int accessType, String type, String name)	Create an instance of a field declaration.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Check for equivalence between this field declaration and another.
int	getAccessType()	Get the access type of the field.
int	getFieldSize()	Get the size of the raw element.
int	getFieldType()	Get the field type.
String	getFieldTypeString()	Get the field type.
String	getName()	Get the name of this field.
static String	toAccessTypeString(int type, boolean isVRML)	Convert a field access type into a string representation in the appropriate specification version
String	toString()	Create a pretty string version of this field.
String	toString(boolean isVRML)	Create a pretty string version of this field that modifies the field type based on the version of the spec.

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN_IMPORT

public static final String UNKNOWN_IMPORT

Definition of a field type that we don't know yet because it came from an unresolved IMPORT statement.

See Also:

• Constant Field Values

Constructor Details

VRMLFieldDeclaration

public VRMLFieldDeclaration(int accessType,
 String type,
 String name)
                     throws InvalidFieldTypeException

Create an instance of a field declaration. The string type is automatically converted to the appropriate constant.

Parameters:

accessType - The type of access that this node has

type - The type of the node (eg SFInt32)

name - The name of this field

Throws:

InvalidFieldTypeException - The type is not a recognised type in either X3D or VRML97.

See Also:

• FieldConstants

Method Details

equals

public boolean equals(Object o)

Check for equivalence between this field declaration and another. Makes sure the name, access type and data type are identical.

Overrides:

equals in class Object

Parameters:

o - The object to compare against

Returns:

true if these represent identical fields

toString

public String toString()

Create a pretty string version of this field. It will produce a string of the form:

   access_type field_type field_name
 

Assumes X3D field semantics. If you need VRML naming use toString(boolean).

Overrides:

toString in class Object

Returns:

A X3D string representation of this declaration

getName

public String getName()

Get the name of this field. This will be something like "children" or "translation".

Returns:

The name of this field

getAccessType

public int getAccessType()

Get the access type of the field. Under VRML97 this will be one of field, exposedField, eventIn or eventOut. For VRML 3.0, this will always be exposedField.

Returns:

The access type of this node

See Also:

• FieldConstants

getFieldType

public int getFieldType()

Get the field type. This string represents the field type such as MFNode, SFInt32. A string is used to allow full extensibility.

Returns:

A constant describing the field type

See Also:

• FieldConstants

getFieldSize

public int getFieldSize()

Get the size of the raw element. Ie an SFVec3f would be 3. The lone exception to this is the IMAGE types which will return 1.

Returns:

A constant describing the element size.

getFieldTypeString

public String getFieldTypeString()

Get the field type. This string represents the field type such as MFNode, SFInt32. A string is used to allow full extensibility.

Returns:

A string describing the field type

See Also:

• FieldConstants

toString

public String toString(boolean isVRML)

Create a pretty string version of this field that modifies the field type based on the version of the spec. It will produce a string of the form

   access_type field_type field_name
 

Parameters:

isVRML - true if this should use the VRML terms, false for X3D

Returns:

A string representation of this declaration

toAccessTypeString

public static String toAccessTypeString(int type,
 boolean isVRML)

Convert a field access type into a string representation in the appropriate specification version

Parameters:

type - The access type constant

isVRML - true if this should use the VRML terms, false for X3D

Returns:

The string representation of it