Class ROUTE

All Implemented Interfaces:
X3DChildNode, X3DNode

public class ROUTE
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.
See Also:
X3D Abstract Specification: ROUTE, X3D Tooltips: ROUTE, X3D Scene Authoring Hints
  • Field Summary

    Fields 
    Modifier and Type Field 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 Description
    ROUTE()
    Constructor for ROUTE to initialize member variables with default values.
  • Method Summary

    Modifier and Type Method Description
    ROUTE addComments​(java.lang.String newComment)
    Add comment as String to contained commentsList.
    ROUTE addComments​(java.lang.String[] newComments)
    Add comments as String[] array to contained commentsList.
    ROUTE addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock 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.
    ROUTE setCssClass​(java.lang.String newValue)
    Deprecated.
    ROUTE setDEF​(java.lang.String newValue)
    Deprecated.
    ROUTE setFromField​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named fromField.
    ROUTE setFromField​(SFString newValue)
    Assign typed object value to SFString fromField field, similar to setFromField(String).
    ROUTE setFromNode​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named fromNode.
    ROUTE setFromNode​(SFString newValue)
    Assign typed object value to SFString fromNode field, similar to setFromNode(String).
    ROUTE setMetadata​(X3DMetadataObject newValue)
    Deprecated.
    ROUTE setToField​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named toField.
    ROUTE setToField​(SFString newValue)
    Assign typed object value to SFString toField field, similar to setToField(String).
    ROUTE setToNode​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named toNode.
    ROUTE setToNode​(SFString newValue)
    Assign typed object value to SFString toNode field, similar to setToNode(String).
    ROUTE 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 java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • ROUTE

      public ROUTE()
      Constructor for ROUTE to initialize member variables with default values.
  • Method Details

    • 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.
      Returns:
      value of fromField field
    • setFromField

      public ROUTE setFromField​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named fromField.

      Tooltip: fromField is the field name in the source node which is originating an event.
      Parameters:
      newValue - is new value for the fromField field.
      Returns:
      ROUTE - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFromField

      public ROUTE setFromField​(SFString newValue)
      Assign typed object value to SFString fromField field, similar to setFromField(String).
      Parameters:
      newValue - is new value for the fromField field.
      Returns:
      ROUTE - 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 ROUTE setFromNode​(java.lang.String newValue)
      Accessor method to 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:
      ROUTE - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFromNode

      public ROUTE setFromNode​(SFString newValue)
      Assign typed object value to SFString fromNode field, similar to setFromNode(String).
      Parameters:
      newValue - is new value for the fromNode field.
      Returns:
      ROUTE - 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.
      Returns:
      value of toField field
    • setToField

      public ROUTE setToField​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named toField.

      Tooltip: toField is the field name in the destination node which is receiving an event.
      Parameters:
      newValue - is new value for the toField field.
      Returns:
      ROUTE - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setToField

      public ROUTE setToField​(SFString newValue)
      Assign typed object value to SFString toField field, similar to setToField(String).
      Parameters:
      newValue - is new value for the toField field.
      Returns:
      ROUTE - 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 ROUTE setToNode​(java.lang.String newValue)
      Accessor method to 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:
      ROUTE - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setToNode

      public ROUTE setToNode​(SFString newValue)
      Assign typed object value to SFString toNode field, similar to setToNode(String).
      Parameters:
      newValue - is new value for the toNode field.
      Returns:
      ROUTE - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public ROUTE addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      ROUTE - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public ROUTE 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:
      ROUTE - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public ROUTE addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ROUTE - 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:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • 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:
      X3D.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:
      X3D.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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 ROUTE 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 ROUTE 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.
      Parameters:
      newValue - ignored
      Returns:
      unmodified object, this method is deprecated and has no effect
    • setUSE

      @Deprecated public ROUTE 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.
      Parameters:
      newValue - ignored
      Returns:
      unmodified object, this method is deprecated and has no effect
    • setCssClass

      @Deprecated public ROUTE setCssClass​(java.lang.String newValue)
      Deprecated.