Class IS

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.IS
public class IS extends X3DConcreteStatement
Functional summary: the IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields. IS/connect statements can be added if the parent node is within a ProtoBody and connect statements define correspondences between prototype fields and built-in node fields. This concrete class represents an X3D IS statement.

IS statement tooltip: The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields. To define each Prototype connection between a ProtoInterface field and a ProtoBody node field, add one or more connect statements within each IS statement.
See Also:

  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: IS.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the IS element: Core
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Core component level for this element: 2
      See Also:

  • Constructor Details

    • IS

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

  • Method Details

    • getElementName

      public final String getElementName()
      Provides name of this element: IS
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the IS 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: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element

    • getFieldType

      public String getFieldType(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:

    • getAccessType

      public String getAccessType(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:

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteStatement

    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

      public final IS setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Parameters:
      newValue - is new value for the class field.
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssClass

      public IS setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getConnectList

      public ArrayList<connect> getConnectList()
      Provide array of connect results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field connect.

      Tooltip: When inside a ProtoBody declaration and an IS statement, add a connect statement to define event-routing connections between a parent node's field to a corresponding ProtoInterface field.

      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to connect.
      Returns:
      value of connect field
      See Also:

    • setConnectList

      public IS setConnectList(ArrayList<connect> newValue)
      Accessor method to assign connect array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field connect.

      Tooltip: When inside a ProtoBody declaration and an IS statement, add a connect statement to define event-routing connections between a parent node's field to a corresponding ProtoInterface field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to connect.
      Parameters:
      newValue - is new value for the connect field.
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addConnect

      public IS addConnect(connect newValue)
      Add array of child connect nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to connect.
      Parameters:
      newValue - is new value array to be appended the connect field.
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setConnect

      public IS setConnect(connect newValue)
      Set single child connect node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to connect.
      Parameters:
      newValue - is new node for the connect field (restricted to connect)
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearConnect

      public IS clearConnect()
      Utility method to clear MFNode value of connectList field. This method does not initialize withCONNECT_DEFAULT_VALUE.
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasConnect

      public boolean hasConnect()
      Indicate whether an object is available for inputOutput MFNode field connectList.
      Returns:
      whether a concrete statement array or CommentsBlock is available.
      See Also:

    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:

    • setHtmlID

      public final IS setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Parameters:
      newValue - is new value for the id field.
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setHtmlID

      public IS setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
      Parameters:
      newValue - is new value for the id field.
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:

    • setCssStyle

      public final IS setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Parameters:
      newValue - is new value for the style field.
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssStyle

      public IS setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
      Parameters:
      newValue - is new value for the style field.
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addComments

      public IS addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addComments

      public IS addComments(String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public IS addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      IS - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • toStringX3D

      public 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:

    • toStringClassicVRML

      public 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:

    • toStringVRML97

      public 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:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(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:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, 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:

    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, 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:

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(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:

    • hasNodeByDEF

      public boolean hasNodeByDEF(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:

    • validate

      public 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. TODO document specific validation methods.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)