ROUTEObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteStatement
  - - org.web3d.x3d.jsail.Core.ROUTEObject

All Implemented Interfaces:

X3DChildNode, X3DNode
```
public class ROUTEObject
extends X3DConcreteStatement
implements X3DChildNode
```
ROUTE connects output fields of event-producing nodes to input fields of event-consuming nodes. This concrete class represents an X3D ROUTE statement.

X3D statement tooltip: [X3D statement] ROUTE connects output fields of event-producing nodes to input fields of event-consuming nodes.
- Warning: each ROUTE must follow the DEF definition of both event-source and event-target nodes.
- Warning: strongly typed event checking means that data type (SFInt32, MFVec3f, etc.) must match identically for both event-source and event-target fields.
- Warning: event-source fields can have accessType outputOnly or inputOutput, while event-target nodes can have accessType inputOnly or inputOutput.
- Hint: event tracing supports animation debugging
  http://X3dGraphics.com/examples/X3dForWebAuthors/Chapter07-EventAnimationInterpolation/Chapter07-EventAnimationInterpolation-EventTracing.pdf
- Hint: X3D Architecture 7.2.5.7 ROUTE statement
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#ROUTEStatement
See Also:

X3D Abstract Specification: ROUTE, X3D Tooltips: ROUTE, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the ROUTE element: Core
`static java.lang.String`	`FROMFIELD_DEFAULT_VALUE` SFString field named fromField has default value equal to an empty string.
`static java.lang.String`	`FROMNODE_DEFAULT_VALUE` SFString field named fromNode has default value equal to an empty string.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Core component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: ROUTE.
`static java.lang.String`	`TOFIELD_DEFAULT_VALUE` SFString field named toField has default value equal to an empty string.
`static java.lang.String`	`TONODE_DEFAULT_VALUE` SFString field named toNode has default value equal to an empty string.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description

ROUTEObject()
Constructor for ROUTEObject to initialize member variables with default values.

Constructors
Constructor and Description
`ROUTEObject()` Constructor for ROUTEObject to initialize member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ROUTEObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`ROUTEObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`ROUTEObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`java.lang.String`	`getComponent()` Defines X3D component for the ROUTE element: Core
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getElementName()` Provides name of this element: ROUTE
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`java.lang.String`	`getFromField()` Provide String value from inputOutput SFString field named fromField.
`java.lang.String`	`getFromNode()` Provide String value from inputOutput SFString field named fromNode.
`X3DMetadataObject`	`getMetadata()` Deprecated.
`java.lang.String`	`getToField()` Provide String value from inputOutput SFString field named toField.
`java.lang.String`	`getToNode()` Provide String value from inputOutput SFString field named toNode.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()` Initialize all member variables to default values.
`ROUTEObject`	`setCssClass(java.lang.String newValue)` Deprecated.
`ROUTEObject`	`setDEF(java.lang.String newValue)` Deprecated.
`ROUTEObject`	`setFromField(SFStringObject newValue)` Assign typed object value to SFString fromField field, similar to `setFromField(String)`.
`ROUTEObject`	`setFromField(java.lang.String newValue)` Assign String value to inputOutput SFString field named fromField.
`ROUTEObject`	`setFromNode(SFStringObject newValue)` Assign typed object value to SFString fromNode field, similar to `setFromNode(String)`.
`ROUTEObject`	`setFromNode(java.lang.String newValue)` Assign String value to inputOutput SFString field named fromNode.
`ROUTEObject`	`setMetadata(X3DMetadataObject newValue)` Deprecated.
`ROUTEObject`	`setToField(SFStringObject newValue)` Assign typed object value to SFString toField field, similar to `setToField(String)`.
`ROUTEObject`	`setToField(java.lang.String newValue)` Assign String value to inputOutput SFString field named toField.
`ROUTEObject`	`setToNode(SFStringObject newValue)` Assign typed object value to SFString toNode field, similar to `setToNode(String)`.
`ROUTEObject`	`setToNode(java.lang.String newValue)` Assign String value to inputOutput SFString field named toNode.
`ROUTEObject`	`setUSE(java.lang.String newValue)` Deprecated.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteStatement
isNode, isStatement

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: ROUTE.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the ROUTE element: Core
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Core component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - FROMFIELD_DEFAULT_VALUE
```
public static final java.lang.String FROMFIELD_DEFAULT_VALUE
```
    SFString field named fromField has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - FROMNODE_DEFAULT_VALUE
```
public static final java.lang.String FROMNODE_DEFAULT_VALUE
```
    SFString field named fromNode has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - TOFIELD_DEFAULT_VALUE
```
public static final java.lang.String TOFIELD_DEFAULT_VALUE
```
    SFString field named toField has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - TONODE_DEFAULT_VALUE
```
public static final java.lang.String TONODE_DEFAULT_VALUE
```
    SFString field named toNode has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ROUTEObject
```
public ROUTEObject()
```
    Constructor for ROUTEObject to initialize member variables with default values.
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: ROUTE
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the ROUTE element: Core
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 1
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D statement
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D statement
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteStatement
  - getFromField
```
public java.lang.String getFromField()
```
    Provide String value from inputOutput SFString field named fromField.
    
    Tooltip: fromField is the field name in the source node which is originating an event.
    - Hint: if (and only if) corresponding field has accessType inputOutput, author has option to append "_changed" suffix to field name - both forms are functionally equivalent.
    - Warning: do not define an event connection using DEF, USE, class or containerField as literal values, since they are not fields in a node that can be modified by events at run time.
    - Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the set_ prefix or the _changed suffix on the field name.
    - Hint: X3D Architecture 4.4.2.2 Field Semantics
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#FieldSemantics
    - Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form
      http://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm
    Returns:
    
    value of fromField field
  - setFromField
```
public ROUTEObject setFromField(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named fromField.
    
    Tooltip: fromField is the field name in the source node which is originating an event. Hint: if (and only if) corresponding field has accessType inputOutput, author has option to append "_changed" suffix to field name - both forms are functionally equivalent. Warning: do not define an event connection using DEF, USE, class or containerField as literal values, since they are not fields in a node that can be modified by events at run time. Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the set_ prefix or the _changed suffix on the field name. Hint: X3D Architecture 4.4.2.2 Field Semantics http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#FieldSemantics Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form http://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm
    
    Parameters:
    
    newValue - is new value for the fromField field.
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setFromField
```
public ROUTEObject setFromField(SFStringObject newValue)
```
    Assign typed object value to SFString fromField field, similar to setFromField(String).
    
    Parameters:
    
    newValue - is new value for the fromField field.
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getFromNode
```
public java.lang.String getFromNode()
```
    Provide String value from inputOutput SFString field named fromNode.
    
    Tooltip: fromNode is the DEF name of the node originating an event. *
    
    Returns:
    
    value of fromNode field
  - setFromNode
```
public ROUTEObject setFromNode(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named fromNode.
    
    Tooltip: fromNode is the DEF name of the node originating an event.
    
    Parameters:
    
    newValue - is new value for the fromNode field.
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setFromNode
```
public ROUTEObject setFromNode(SFStringObject newValue)
```
    Assign typed object value to SFString fromNode field, similar to setFromNode(String).
    
    Parameters:
    
    newValue - is new value for the fromNode field.
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getToField
```
public java.lang.String getToField()
```
    Provide String value from inputOutput SFString field named toField.
    
    Tooltip: toField is the field name in the destination node which is receiving an event.
    - Hint: if (and only if) corresponding field has accessType inputOutput, author has option to prepend "set_" prefix to field name - both forms are functionally equivalent.
    - Warning: do not define an event connection using DEF, USE, class or containerField as literal values, since they are not fields in a node that can be modified by events at run time.
    - Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the set_ prefix or the _changed suffix on the field name.
    - Hint: X3D Architecture 4.4.2.2 Field Semantics
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#FieldSemantics
    - Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form
      http://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm
    Returns:
    
    value of toField field
  - setToField
```
public ROUTEObject setToField(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named toField.
    
    Tooltip: toField is the field name in the destination node which is receiving an event. Hint: if (and only if) corresponding field has accessType inputOutput, author has option to prepend "set_" prefix to field name - both forms are functionally equivalent. Warning: do not define an event connection using DEF, USE, class or containerField as literal values, since they are not fields in a node that can be modified by events at run time. Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the set_ prefix or the _changed suffix on the field name. Hint: X3D Architecture 4.4.2.2 Field Semantics http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#FieldSemantics Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form http://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm
    
    Parameters:
    
    newValue - is new value for the toField field.
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setToField
```
public ROUTEObject setToField(SFStringObject newValue)
```
    Assign typed object value to SFString toField field, similar to setToField(String).
    
    Parameters:
    
    newValue - is new value for the toField field.
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getToNode
```
public java.lang.String getToNode()
```
    Provide String value from inputOutput SFString field named toNode.
    
    Tooltip: toNode is the DEF name of the destination node receiving an event. *
    
    Returns:
    
    value of toNode field
  - setToNode
```
public ROUTEObject setToNode(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named toNode.
    
    Tooltip: toNode is the DEF name of the destination node receiving an event.
    
    Parameters:
    
    newValue - is new value for the toNode field.
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setToNode
```
public ROUTEObject setToNode(SFStringObject newValue)
```
    Assign typed object value to SFString toNode field, similar to setToNode(String).
    
    Parameters:
    
    newValue - is new value for the toNode field.
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public ROUTEObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ROUTEObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ROUTEObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)
  - getMetadata
```
@Deprecated
public X3DMetadataObject getMetadata()
```
    Deprecated.
    
    DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    null, this method is deprecated and has no effect
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
@Deprecated
public ROUTEObject setMetadata(X3DMetadataObject newValue)
```
    Deprecated.
    
    DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - ignored
    
    Returns:
    
    unmodified object, this method is deprecated and has no effect
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setDEF
```
@Deprecated
public ROUTEObject setDEF(java.lang.String newValue)
```
    Deprecated.
    
    DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - ignored
    
    Returns:
    
    unmodified object, this method is deprecated and has no effect
  - setUSE
```
@Deprecated
public ROUTEObject setUSE(java.lang.String newValue)
```
    Deprecated.
    
    DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - ignored
    
    Returns:
    
    unmodified object, this method is deprecated and has no effect
  - setCssClass
```
@Deprecated
public ROUTEObject setCssClass(java.lang.String newValue)
```
    Deprecated.
    
    Description copied from interface: X3DChildNode
    
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    X3DChildNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Class ROUTEObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteStatement

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

FROMFIELD_DEFAULT_VALUE

FROMNODE_DEFAULT_VALUE

TOFIELD_DEFAULT_VALUE

TONODE_DEFAULT_VALUE

Constructor Detail

ROUTEObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

initialize

getFromField

setFromField

setFromField

getFromNode

setFromNode

setFromNode

getToField

setToField

setToField

getToNode

setToNode

setToNode

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate

getMetadata

setMetadata

setDEF

setUSE

setCssClass