Class ProtoInterface

java.lang.Object

public class ProtoInterface
extends X3DConcreteStatement
ProtoInterface defines fields for new Prototype nodes. This concrete class represents an X3D ProtoInterface statement.

X3D statement tooltip: [X3D statement] ProtoInterface is the first statement inside a ProtoDeclare statement and holds field declarations. ProtoInterface is followed by a corresponding ProtoBody statement.
See Also:
X3D Abstract Specification: ProtoInterface, X3D Tooltips: ProtoInterface, X3D Scene Authoring Hints: InlinesPrototypes
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String COMPONENT
    String constant COMPONENT defines X3D component for the ProtoInterface element: Core
    static int LEVEL
    Integer constant LEVEL provides default X3D Core component level for this element: 2
    static java.lang.String NAME
    String constant NAME provides name of this element: ProtoInterface.

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

    validationResult
  • Constructor Summary

    Constructors 
    Constructor Description
    ProtoInterface()
    Constructor for ProtoInterface to initialize member variables with default values.
  • Method Summary

    Modifier and Type Method Description
    ProtoInterface addComments​(java.lang.String newComment)
    Add comment as String to contained commentsList.
    ProtoInterface addComments​(java.lang.String[] newComments)
    Add comments as String[] array to contained commentsList.
    ProtoInterface addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to contained commentsList.
    ProtoInterface addField​(field newField)
    Add field to fieldList for this ProtoInterface
    ProtoInterface clearField()
    Utility method to clear MFNode value of fieldList field.
    void clearFields()
    Clear all fields
    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.
    field findFieldByName​(java.lang.String fieldName)
    Find contained field statement by name, if present.
    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 ProtoInterface element: Core
    int getComponentLevel()
    Provides default X3D component level for this element: 2
    java.lang.String getElementName()
    Provides name of this element: ProtoInterface
    java.util.ArrayList<field> getFieldList()
    Provide array of field results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field field.
    java.lang.String getFieldType​(java.lang.String fieldName)
    Indicate type corresponding to given fieldName.
    java.lang.String getName()
    Utility method to inspect parent ProtoDeclare and provide String value from inputOutput SFString field named name.
    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 hasField()
    Indicate whether an object is available for inputOutput MFNode field fieldList.
    boolean hasField​(java.lang.String fieldName)
    Determine if field statement is present.
    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.
    boolean removeField​(java.lang.String fieldName)
    Remove a field by name from contained fieldList
    boolean removeField​(field fieldToRemove)
    Remove a field from contained fieldList
    ProtoInterface setField​(field newValue)
    Set single child field node, replacing prior array of existing nodes (if any).
    ProtoInterface setFieldList​(java.util.ArrayList<field> newValue)
    Accessor method to assign field array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field field.
    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

    • NAME

      public static final java.lang.String NAME
      String constant NAME provides name of this element: ProtoInterface.
      See Also:
      Constant Field Values
    • COMPONENT

      public static final java.lang.String COMPONENT
      String constant COMPONENT defines X3D component for the ProtoInterface 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: 2
      See Also:
      Constant Field Values
  • Constructor Details

    • ProtoInterface

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

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: ProtoInterface
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the ProtoInterface 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 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
    • getFieldList

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

      Tooltip: Include a field statement for each field declaration in this ProtoDeclare's ProtoInterface. *


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

      public ProtoInterface setFieldList​(java.util.ArrayList<field> newValue)
      Accessor method to assign field array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field field.

      Tooltip: Include a field statement for each field declaration in this ProtoDeclare's ProtoInterface. *


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

      public ProtoInterface setField​(field newValue)
      Set single child field node, replacing prior array of existing nodes (if any).

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

      public ProtoInterface clearField()
      Utility method to clear MFNode value of fieldList field.
      Returns:
      ProtoInterface - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasField

      public boolean hasField()
      Indicate whether an object is available for inputOutput MFNode field fieldList.
      Returns:
      whether a concrete statement array or CommentsBlock is available.
      See Also:
      getFieldList()
    • addComments

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

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

      public ProtoInterface addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ProtoInterface - 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)
    • addField

      public ProtoInterface addField​(field newField)
      Add field to fieldList for this ProtoInterface
      Parameters:
      newField - is field to add
      Returns:
      ProtoInterface - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • findFieldByName

      public field findFieldByName​(java.lang.String fieldName)
      Find contained field statement by name, if present.
      Parameters:
      fieldName - is name attribute for field of interest
      Returns:
      field reference of interest, null otherwise
    • removeField

      public boolean removeField​(field fieldToRemove)
      Remove a field from contained fieldList
      Parameters:
      fieldToRemove - matching field of interest
      Returns:
      whether field was removed
      See Also:
      removeField(String)
    • removeField

      public boolean removeField​(java.lang.String fieldName)
      Remove a field by name from contained fieldList
      Parameters:
      fieldName - matching field of interest
      Returns:
      whether field was removed
      See Also:
      removeField(field)
    • clearFields

      public void clearFields()
      Clear all fields
    • hasField

      public boolean hasField​(java.lang.String fieldName)
      Determine if field statement is present.
      Parameters:
      fieldName - is name attribute for field of interest
      Returns:
      whether field is found
    • getName

      public java.lang.String getName()
      Utility method to inspect parent ProtoDeclare and provide String value from inputOutput SFString field named name.
      Returns:
      value of name field in parent ProtoDeclare
      See Also:
      ProtoDeclare.getName()