DISEntityManagerObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.DIS.DISEntityManagerObject

All Implemented Interfaces:

X3DChildNode, X3DNode, DISEntityManager
```
public class DISEntityManagerObject
extends X3DConcreteNode
implements DISEntityManager
```
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.
- Hint: DISEntityManager contains DISEntityTypeMapping nodes.
- Hint: DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
- Hint: Savage Developers Guide on DIS
  https://savage.nps.edu/Savage/developers.html#DIS
- Hint: X3D for Advanced Modeling (X3D4AM) slideset
  http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
- Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/>
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 Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADDRESS_DEFAULT_VALUE` SFString field named address has default value "localhost" (Java syntax) or localhost (XML syntax).
`static int`	`APPLICATIONID_DEFAULT_VALUE` SFInt32 field named applicationID has default value 0 (Java syntax) or 0 (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the DISEntityManager element: DIS
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`fromField_ADDEDENTITIES` fromField ROUTE name for MFNode field named addedEntities.
`static java.lang.String`	`fromField_ADDRESS` fromField ROUTE name for SFString field named address.
`static java.lang.String`	`fromField_APPLICATIONID` fromField ROUTE name for SFInt32 field named applicationID.
`static java.lang.String`	`fromField_MAPPING` fromField ROUTE name for MFNode field named mapping.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_PORT` fromField ROUTE name for SFInt32 field named port.
`static java.lang.String`	`fromField_REMOVEDENTITIES` fromField ROUTE name for MFNode field named removedEntities.
`static java.lang.String`	`fromField_SITEID` fromField ROUTE name for SFInt32 field named siteID.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D DIS component level for this element: 2
`static java.lang.String`	`NAME` String constant NAME provides name of this element: DISEntityManager.
`static int`	`PORT_DEFAULT_VALUE` SFInt32 field named port has default value 0 (Java syntax) or 0 (XML syntax).
`static int`	`SITEID_DEFAULT_VALUE` SFInt32 field named siteID has default value 0 (Java syntax) or 0 (XML syntax).
`static java.lang.String`	`toField_ADDRESS` toField ROUTE name for SFString field named address.
`static java.lang.String`	`toField_APPLICATIONID` toField ROUTE name for SFInt32 field named applicationID.
`static java.lang.String`	`toField_MAPPING` toField ROUTE name for MFNode field named mapping.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_PORT` toField ROUTE name for SFInt32 field named port.
`static java.lang.String`	`toField_SITEID` toField ROUTE name for SFInt32 field named siteID.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

Constructor Summary

Constructors
Constructor and Description
`DISEntityManagerObject()` Constructor for DISEntityManagerObject to initialize member variables with default values.
`DISEntityManagerObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DISEntityManagerObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`DISEntityManagerObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`DISEntityManagerObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`DISEntityManagerObject`	`addMapping(DISEntityTypeMappingObject newValue)` Add single child node to existing array of mapping nodes (if any).
`void`	`addMapping(X3DNode[] newValue)` Add array of child mapping nodes to array of existing nodes (if any).
`DISEntityManagerObject`	`clearMapping()` Utility method to clear MFNode value of mapping field.
`DISEntityManagerObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`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`	`getAddress()` Provide String value from inputOutput SFString field named address.
`int`	`getApplicationID()` Provide int value from inputOutput SFInt32 field named applicationID.
`java.lang.String`	`getComponent()` Defines X3D component for the DISEntityManager element: DIS
`int`	`getComponentLevel()` Provides default X3D component level for this element: 2
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`java.lang.String`	`getElementName()` Provides name of this element: DISEntityManager
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`X3DNode[]`	`getMapping()` Provide array of DISEntityTypeMapping results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field mapping.
`java.util.ArrayList<X3DNode>`	`getMappingList()` Utility method to get ArrayList value of MFNode mapping field, similar to `getMapping()`.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`int`	`getPort()` Provide int value from inputOutput SFInt32 field named port.
`int`	`getSiteID()` Provide int value from inputOutput SFInt32 field named siteID.
`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`	`hasMapping()` Indicate whether an object is available for inputOutput MFNode field mapping.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`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.
`DISEntityManagerObject`	`setAddress(SFStringObject newValue)` Assign typed object value to SFString address field, similar to `setAddress(String)`.
`DISEntityManagerObject`	`setAddress(java.lang.String newValue)` Assign String value to inputOutput SFString field named address.
`DISEntityManagerObject`	`setApplicationID(int newValue)` Assign int value to inputOutput SFInt32 field named applicationID.
`DISEntityManagerObject`	`setApplicationID(SFInt32Object newValue)` Assign typed object value to SFInt32 applicationID field, similar to `setApplicationID(int)`.
`DISEntityManagerObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`DISEntityManagerObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`DISEntityManagerObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`DISEntityManagerObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`DISEntityManagerObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`DISEntityManagerObject`	`setMapping(java.util.ArrayList<DISEntityTypeMapping> newValue)` Assign ArrayList value of MFNode mapping field, similar to `setMapping(X3DNode[])`.
`DISEntityManagerObject`	`setMapping(X3DConcreteNode newValue)` Utility method to set single SFNode as DISEntityManagerObject mapping.
`void`	`setMapping(X3DNode newValue)` Set single child mapping node, replacing prior array of existing nodes (if any).
`DISEntityManagerObject`	`setMapping(X3DNode[] newValue)` Assign DISEntityTypeMapping array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field mapping.
`DISEntityManagerObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`DISEntityManagerObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`DISEntityManagerObject`	`setPort(int newValue)` Assign int value to inputOutput SFInt32 field named port.
`DISEntityManagerObject`	`setPort(SFInt32Object newValue)` Assign typed object value to SFInt32 port field, similar to `setPort(int)`.
`DISEntityManagerObject`	`setSiteID(int newValue)` Assign int value to inputOutput SFInt32 field named siteID.
`DISEntityManagerObject`	`setSiteID(SFInt32Object newValue)` Assign typed object value to SFInt32 siteID field, similar to `setSiteID(int)`.
`DISEntityManagerObject`	`setUSE(DISEntityManagerObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`DISEntityManagerObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`DISEntityManagerObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`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.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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: DISEntityManager.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the DISEntityManager element: DIS
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D DIS component level for this element: 2
    
    See Also:
    
    Constant Field Values
  - ADDRESS_DEFAULT_VALUE
```
public static final java.lang.String ADDRESS_DEFAULT_VALUE
```
    SFString field named address has default value "localhost" (Java syntax) or localhost (XML syntax).
    
    See Also:
    
    Constant Field Values
  - APPLICATIONID_DEFAULT_VALUE
```
public static final int APPLICATIONID_DEFAULT_VALUE
```
    SFInt32 field named applicationID has default value 0 (Java syntax) or 0 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - PORT_DEFAULT_VALUE
```
public static final int PORT_DEFAULT_VALUE
```
    SFInt32 field named port has default value 0 (Java syntax) or 0 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - SITEID_DEFAULT_VALUE
```
public static final int SITEID_DEFAULT_VALUE
```
    SFInt32 field named siteID has default value 0 (Java syntax) or 0 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    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.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - fromField_ADDEDENTITIES
```
public static final java.lang.String fromField_ADDEDENTITIES
```
    fromField ROUTE name for MFNode field named addedEntities.
    
    See Also:
    
    Constant Field Values
  - fromField_ADDRESS
```
public static final java.lang.String fromField_ADDRESS
```
    fromField ROUTE name for SFString field named address.
    
    See Also:
    
    Constant Field Values
  - toField_ADDRESS
```
public static final java.lang.String toField_ADDRESS
```
    toField ROUTE name for SFString field named address.
    
    See Also:
    
    Constant Field Values
  - fromField_APPLICATIONID
```
public static final java.lang.String fromField_APPLICATIONID
```
    fromField ROUTE name for SFInt32 field named applicationID.
    
    See Also:
    
    Constant Field Values
  - toField_APPLICATIONID
```
public static final java.lang.String toField_APPLICATIONID
```
    toField ROUTE name for SFInt32 field named applicationID.
    
    See Also:
    
    Constant Field Values
  - fromField_MAPPING
```
public static final java.lang.String fromField_MAPPING
```
    fromField ROUTE name for MFNode field named mapping.
    
    See Also:
    
    Constant Field Values
  - toField_MAPPING
```
public static final java.lang.String toField_MAPPING
```
    toField ROUTE name for MFNode field named mapping.
    
    See Also:
    
    Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - fromField_PORT
```
public static final java.lang.String fromField_PORT
```
    fromField ROUTE name for SFInt32 field named port.
    
    See Also:
    
    Constant Field Values
  - toField_PORT
```
public static final java.lang.String toField_PORT
```
    toField ROUTE name for SFInt32 field named port.
    
    See Also:
    
    Constant Field Values
  - fromField_REMOVEDENTITIES
```
public static final java.lang.String fromField_REMOVEDENTITIES
```
    fromField ROUTE name for MFNode field named removedEntities.
    
    See Also:
    
    Constant Field Values
  - fromField_SITEID
```
public static final java.lang.String fromField_SITEID
```
    fromField ROUTE name for SFInt32 field named siteID.
    
    See Also:
    
    Constant Field Values
  - toField_SITEID
```
public static final java.lang.String toField_SITEID
```
    toField ROUTE name for SFInt32 field named siteID.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DISEntityManagerObject
```
public DISEntityManagerObject()
```
    Constructor for DISEntityManagerObject to initialize member variables with default values.
  - DISEntityManagerObject
```
public DISEntityManagerObject(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 Detail
  - 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 DISEntityManagerObject setAddress(java.lang.String newValue)
```
    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:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setAddress
```
public DISEntityManagerObject setAddress(SFStringObject newValue)
```
    Assign typed object value to SFString address field, similar to setAddress(String).
    
    Parameters:
    
    newValue - is new value for the address field.
    
    Returns:
    
    DISEntityManagerObject - 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 DISEntityManagerObject setApplicationID(int newValue)
```
    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:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setApplicationID
```
public DISEntityManagerObject setApplicationID(SFInt32Object newValue)
```
    Assign typed object value to SFInt32 applicationID field, similar to setApplicationID(int).
    
    Parameters:
    
    newValue - is new value for the applicationID field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMapping
```
public X3DNode[] getMapping()
```
    Provide array of DISEntityTypeMapping results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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:
    
    DISEntityTypeMappingObject
  - 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 DISEntityManagerObject setMapping(X3DNode[] newValue)
```
    Assign DISEntityTypeMapping array (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setMapping
```
public DISEntityManagerObject setMapping(java.util.ArrayList<DISEntityTypeMapping> newValue)
```
    Assign ArrayList value of MFNode mapping field, similar to setMapping(X3DNode[]).
    
    Parameters:
    
    newValue - is new value for the mapping field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addMapping
```
public DISEntityManagerObject addMapping(DISEntityTypeMappingObject 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:
    
    DISEntityManagerObject - 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)
  - setMapping
```
public DISEntityManagerObject setMapping(X3DConcreteNode newValue)
```
    Utility method to set single SFNode as DISEntityManagerObject mapping.
    
    Parameters:
    
    newValue - DISEntityManagerObject node to set
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - clearMapping
```
public DISEntityManagerObject clearMapping()
```
    Utility method to clear MFNode value of mapping field.
    
    Returns:
    
    DISEntityManagerObject - 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 X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface DISEntityManager
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public DISEntityManagerObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface DISEntityManager
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public DISEntityManagerObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public DISEntityManagerObject setMetadata(ProtoInstanceObject 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:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(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 DISEntityManagerObject setPort(int newValue)
```
    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:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setPort
```
public DISEntityManagerObject setPort(SFInt32Object newValue)
```
    Assign typed object value to SFInt32 port field, similar to setPort(int).
    
    Parameters:
    
    newValue - is new value for the port field.
    
    Returns:
    
    DISEntityManagerObject - 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 DISEntityManagerObject setSiteID(int newValue)
```
    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:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setSiteID
```
public DISEntityManagerObject setSiteID(SFInt32Object newValue)
```
    Assign typed object value to SFInt32 siteID field, similar to setSiteID(int).
    
    Parameters:
    
    newValue - is new value for the siteID field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public final DISEntityManagerObject setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface DISEntityManager
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public DISEntityManagerObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final DISEntityManagerObject setUSE(java.lang.String newValue)
```
    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 interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface DISEntityManager
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public DISEntityManagerObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final DISEntityManagerObject setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface DISEntityManager
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    DISEntityManagerObject - 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 DISEntityManagerObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public DISEntityManagerObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    DISEntityManagerObject - 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
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public DISEntityManagerObject setUSE(DISEntityManagerObject 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:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public DISEntityManagerObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public DISEntityManagerObject 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:
    
    DISEntityManagerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public DISEntityManagerObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    DISEntityManagerObject - 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)

Class DISEntityManagerObject

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

ADDRESS_DEFAULT_VALUE

APPLICATIONID_DEFAULT_VALUE

PORT_DEFAULT_VALUE

SITEID_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_ADDEDENTITIES

fromField_ADDRESS

toField_ADDRESS

fromField_APPLICATIONID

toField_APPLICATIONID

fromField_MAPPING

toField_MAPPING

fromField_METADATA

toField_METADATA

fromField_PORT

toField_PORT

fromField_REMOVEDENTITIES

fromField_SITEID

toField_SITEID

Constructor Detail

DISEntityManagerObject

DISEntityManagerObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getAddress

setAddress

setAddress

getApplicationID

setApplicationID

setApplicationID

getMapping

getMappingList

setMapping

setMapping

addMapping

addMapping

setMapping

setMapping

clearMapping

hasMapping

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getPort

setPort

setPort

getSiteID

setSiteID

setSiteID

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments