Package org.web3d.x3d.jsail.DIS

Class DISEntityManager

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.DIS.DISEntityManager
All Implemented Interfaces:
X3DChildNode, X3DNode, DISEntityManager
public class DISEntityManager
extends X3DConcreteNode
implements DISEntityManager
DISEntityManager notifies a scene when new DIS ESPDU entities arrive or current entities leave.

X3D node tooltip: [X3DChildNode] DISEntityManager notifies a scene when new DIS ESPDU entities arrive or current entities leave. DISEntityManager may contain any number of DISEntityTypeMapping nodes that provide a best-match X3D model to incoming entity type values. For each new DIS entity, DISEntityManager thus produces a new EspduTransform node that contains a corresponding X3D model.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: DISEntityManager, X3D Tooltips: DISEntityManager, X3D Scene Authoring Hints

  • Field Details

  • Constructor Details

    • DISEntityManager

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

    • DISEntityManager

      public DISEntityManager​(java.lang.String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node

  • Method Details

    • getElementName

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

    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the DISEntityManager element: DIS
      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 node
      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 node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

    • initialize

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

    • getAddress

      public java.lang.String getAddress()
      Provide String value from inputOutput SFString field named address.

      Tooltip: Multicast network address, or else "localhost" example: 224.2.181.145. *
      Specified by:
      getAddress in interface DISEntityManager
      Returns:
      value of address field

    • setAddress

      public DISEntityManager setAddress​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named address.

      Tooltip: Multicast network address, or else "localhost" example: 224.2.181.145. *
      Specified by:
      setAddress in interface DISEntityManager
      Parameters:
      newValue - is new value for the address field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setAddress

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

    • getApplicationID

      public int getApplicationID()
      Provide int value from inputOutput SFInt32 field named applicationID.

      Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *
      Specified by:
      getApplicationID in interface DISEntityManager
      Returns:
      value of applicationID field

    • setApplicationID

      public DISEntityManager setApplicationID​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named applicationID.

      Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *
      Specified by:
      setApplicationID in interface DISEntityManager
      Parameters:
      newValue - is new value for the applicationID field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setApplicationID

      public DISEntityManager setApplicationID​(SFInt32 newValue)
      Assign typed object value to SFInt32 applicationID field, similar to setApplicationID(int).
      Parameters:
      newValue - is new value for the applicationID field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect

    • setIS

      public DISEntityManager setIS​(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect

    • clearIS

      public DISEntityManager clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()

    • getMapping

      public X3DNode[] getMapping()
      Provide array of org.web3d.x3d.sai.DIS.DISEntityTypeMapping results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field mapping.

      Tooltip: [DISEntityTypeMapping] mapping field provides a mechanism for automatically creating an X3D model when a new entity arrives over the network. If a new entity matches one of the nodes, an instance of the provided URL is created and added as a child to the EspduTransform specified in the addedEntities field.
      • Hint: multiple DISEntityTypeMapping nodes can be provided in mapping field, best match takes precedence.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
      Specified by:
      getMapping in interface DISEntityManager
      Returns:
      value of mapping field
      See Also:
      DISEntityTypeMapping

    • getMappingList

      public java.util.ArrayList<X3DNode> getMappingList()
      Utility method to get ArrayList value of MFNode mapping field, similar to getMapping().
      Returns:
      value of mapping field

    • setMapping

      public DISEntityManager setMapping​(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.DIS.DISEntityTypeMapping array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field mapping.

      Tooltip: [DISEntityTypeMapping] mapping field provides a mechanism for automatically creating an X3D model when a new entity arrives over the network. If a new entity matches one of the nodes, an instance of the provided URL is created and added as a child to the EspduTransform specified in the addedEntities field.
      • Hint: multiple DISEntityTypeMapping nodes can be provided in mapping field, best match takes precedence.


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

    • setMapping

      public DISEntityManager setMapping​(java.util.ArrayList<DISEntityTypeMapping> newValue)
      Assign ArrayList value of MFNode mapping field, similar to setMapping(org.web3d.x3d.sai.Core.X3DNode[]).
      Parameters:
      newValue - is new value for the mapping field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addMapping

      public DISEntityManager addMapping​(DISEntityTypeMapping newValue)
      Add single child node to existing array of mapping nodes (if any).

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

    • addMapping

      public DISEntityManager addMapping​(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for mapping field.

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

    • addMapping

      public void addMapping​(X3DNode[] newValue)
      Add array of child mapping nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
      Specified by:
      addMapping in interface DISEntityManager
      Parameters:
      newValue - is new value array to be appended the mapping field.

    • setMapping

      public void setMapping​(X3DNode newValue)
      Set single child mapping node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to DISEntityTypeMapping.
      Specified by:
      setMapping in interface DISEntityManager
      Parameters:
      newValue - is new node for the mapping field (restricted to DISEntityTypeMapping)

    • clearMapping

      public DISEntityManager clearMapping()
      Utility method to clear MFNode value of mapping field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasMapping

      public boolean hasMapping()
      Indicate whether an object is available for inputOutput MFNode field mapping.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getMapping()

    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface DISEntityManager
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      public DISEntityManager setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface DISEntityManager
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • clearMetadata

      public DISEntityManager clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setMetadata

      public DISEntityManager setMetadata​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)

    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

    • getPort

      public int getPort()
      Provide int value from inputOutput SFInt32 field named port.

      Tooltip: Multicast network port, for example: 3000. *
      Specified by:
      getPort in interface DISEntityManager
      Returns:
      value of port field

    • setPort

      public DISEntityManager setPort​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named port.

      Tooltip: Multicast network port, for example: 3000. *
      Specified by:
      setPort in interface DISEntityManager
      Parameters:
      newValue - is new value for the port field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setPort

      public DISEntityManager setPort​(SFInt32 newValue)
      Assign typed object value to SFInt32 port field, similar to setPort(int).
      Parameters:
      newValue - is new value for the port field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getSiteID

      public int getSiteID()
      Provide int value from inputOutput SFInt32 field named siteID.

      Tooltip: Simulation/exercise siteID of the participating LAN or organization. *
      Specified by:
      getSiteID in interface DISEntityManager
      Returns:
      value of siteID field

    • setSiteID

      public DISEntityManager setSiteID​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named siteID.

      Tooltip: Simulation/exercise siteID of the participating LAN or organization. *
      Specified by:
      setSiteID in interface DISEntityManager
      Parameters:
      newValue - is new value for the siteID field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSiteID

      public DISEntityManager setSiteID​(SFInt32 newValue)
      Assign typed object value to SFInt32 siteID field, similar to setSiteID(int).
      Parameters:
      newValue - is new value for the siteID field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions

    • setDEF

      public final DISEntityManager setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

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

    • getUSE

      public java.lang.String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions

    • setUSE

      public final DISEntityManager setUSE​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

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

    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets

    • setCssClass

      public final DISEntityManager setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets

    • setCssClass

      public DISEntityManager 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:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public DISEntityManager setUSE​(DISEntityManager DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addComments

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

    • addComments

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

    • addComments

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