Package org.web3d.x3d.jsail.DIS

Class DISEntityTypeMapping

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.DIS.DISEntityTypeMapping

All Implemented Interfaces:

X3DChildNode, X3DInfoNode, X3DNode, DISEntityTypeMapping, X3DUrlObject

public class DISEntityTypeMapping
extends X3DConcreteNode
implements DISEntityTypeMapping

DISEntityTypeMapping provides a best-match mapping from DIS ESPDU entity type information to a specific X3D model, thus providing a visual and behavioral representation that best matches the entity type.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. DISEntityTypeMapping node tooltip: [X3DInfoNode,X3DUrlObject] DISEntityTypeMapping provides a best-match mapping from DIS ESPDU entity type information to a specific X3D model, thus providing a visual and behavioral representation that best matches the entity type. Fields are processed in order: kind, domain, country, category, subcategory, specific, extra.

• Hint: values set to zero are wildcards, matching any received value.
• Hint: DISEntityTypeMapping is contained by a parent DISEntityManager node.
• 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 https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
• Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/>
• Hint: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList' (X3Dv3). https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

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: DISEntityTypeMapping
• X3D Tooltips: DISEntityTypeMapping
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final double	AUTOREFRESH_DEFAULT_VALUE	SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).
static final double	AUTOREFRESHTIMELIMIT_DEFAULT_VALUE	SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).
static final int	CATEGORY_DEFAULT_VALUE	SFInt32 field named category has default value 0 (Java syntax) or 0 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the DISEntityTypeMapping element: DIS
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final int	COUNTRY_DEFAULT_VALUE	SFInt32 field named country has default value 0 (Java syntax) or 0 (XML syntax).
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final int	DOMAIN_DEFAULT_VALUE	SFInt32 field named domain has default value 0 (Java syntax) or 0 (XML syntax).
static final int	EXTRA_DEFAULT_VALUE	SFInt32 field named extra has default value 0 (Java syntax) or 0 (XML syntax).
static final String	fromField_AUTOREFRESH	fromField ROUTE name for SFTime field named autoRefresh.
static final String	fromField_AUTOREFRESHTIMELIMIT	fromField ROUTE name for SFTime field named autoRefreshTimeLimit.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_LOAD	fromField ROUTE name for SFBool field named load.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_URL	fromField ROUTE name for MFString field named url.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	KIND_DEFAULT_VALUE	SFInt32 field named kind has default value 0 (Java syntax) or 0 (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D DIS component level for this element: 2
static final boolean	LOAD_DEFAULT_VALUE	SFBool field named load has default value true (Java syntax) or true (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: DISEntityTypeMapping.
static final int	SPECIFIC_DEFAULT_VALUE	SFInt32 field named specific has default value 0 (Java syntax) or 0 (XML syntax).
static final int	SUBCATEGORY_DEFAULT_VALUE	SFInt32 field named subcategory has default value 0 (Java syntax) or 0 (XML syntax).
static final String	toField_AUTOREFRESH	toField ROUTE name for SFTime field named autoRefresh.
static final String	toField_AUTOREFRESHTIMELIMIT	toField ROUTE name for SFTime field named autoRefreshTimeLimit.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_LOAD	toField ROUTE name for SFBool field named load.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_URL	toField ROUTE name for MFString field named url.
static final ArrayList<String>	URL_DEFAULT_VALUE	MFString field named url has default value equal to an empty list.

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

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
DISEntityTypeMapping()	Constructor for DISEntityTypeMapping to initialize member variables with default values.
DISEntityTypeMapping(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
DISEntityTypeMapping	addComments(String newComment)	Add comment as String to contained commentsList.
DISEntityTypeMapping	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
DISEntityTypeMapping	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
DISEntityTypeMapping	addUrl(String newValue)	Add singleton String value to MFString url field.
DISEntityTypeMapping	addUrl(SFString newValue)	Add singleton SFString value to MFString url field.
DISEntityTypeMapping	clearIS()	Utility method to clear SFNode value of IS field.
DISEntityTypeMapping	clearMetadata()	Utility method to clear SFNode value of metadata field.
DISEntityTypeMapping	clearUrl()	Utility method to clear MFString value of url field.
X3DConcreteElement	findElementByNameValue(String nameValue)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(String nameValue, String elementName)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
double	getAutoRefresh()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
double	getAutoRefreshTimeLimit()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
int	getCategory()	Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named category.
final String	getComponent()	Defines X3D component for the DISEntityTypeMapping element: DIS
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
int	getCountry()	Provide int value within allowed range of [0,65535] from initializeOnly SFInt32 field named country.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
String	getDescription()	Provide String value from inputOutput SFString field named description.
int	getDomain()	Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named domain.
final String	getElementName()	Provides name of this element: DISEntityTypeMapping
int	getExtra()	Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named extra.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
int	getKind()	Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named kind.
boolean	getLoad()	Provide boolean value from inputOutput SFBool field named load.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
int	getSpecific()	Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named specific.
int	getSubcategory()	Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named subcategory.
String[]	getUrl()	Provide array of String results from inputOutput MFString field named url.
ArrayList<String>	getUrlList()	Utility method to get ArrayList value of MFString url field, similar to getUrl().
String	getUrlString()	Utility method to get String value of MFString url field, similar to getUrl().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasElementByNameValue(String nameValue, String elementName)	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
DISEntityTypeMapping	setAutoRefresh(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
DISEntityTypeMapping	setAutoRefresh(SFTime newValue)	Assign typed object value to SFTime autoRefresh field, similar to setAutoRefresh(double).
DISEntityTypeMapping	setAutoRefreshTimeLimit(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
DISEntityTypeMapping	setAutoRefreshTimeLimit(SFTime newValue)	Assign typed object value to SFTime autoRefreshTimeLimit field, similar to setAutoRefreshTimeLimit(double).
DISEntityTypeMapping	setCategory(int newValue)	Accessor method to assign int value to initializeOnly SFInt32 field named category.
DISEntityTypeMapping	setCategory(SFInt32 newValue)	Assign typed object value to SFInt32 category field, similar to setCategory(int).
DISEntityTypeMapping	setCountry(int newValue)	Accessor method to assign int value to initializeOnly SFInt32 field named country.
DISEntityTypeMapping	setCountry(SFInt32 newValue)	Assign typed object value to SFInt32 country field, similar to setCountry(int).
final DISEntityTypeMapping	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
DISEntityTypeMapping	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final DISEntityTypeMapping	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
DISEntityTypeMapping	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final DISEntityTypeMapping	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
DISEntityTypeMapping	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
DISEntityTypeMapping	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
DISEntityTypeMapping	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
DISEntityTypeMapping	setDomain(int newValue)	Accessor method to assign int value to initializeOnly SFInt32 field named domain.
DISEntityTypeMapping	setDomain(SFInt32 newValue)	Assign typed object value to SFInt32 domain field, similar to setDomain(int).
DISEntityTypeMapping	setExtra(int newValue)	Accessor method to assign int value to initializeOnly SFInt32 field named extra.
DISEntityTypeMapping	setExtra(SFInt32 newValue)	Assign typed object value to SFInt32 extra field, similar to setExtra(int).
final DISEntityTypeMapping	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
DISEntityTypeMapping	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
DISEntityTypeMapping	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
DISEntityTypeMapping	setKind(int newValue)	Accessor method to assign int value to initializeOnly SFInt32 field named kind.
DISEntityTypeMapping	setKind(SFInt32 newValue)	Assign typed object value to SFInt32 kind field, similar to setKind(int).
DISEntityTypeMapping	setLoad(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named load.
DISEntityTypeMapping	setLoad(SFBool newValue)	Assign typed object value to SFBool load field, similar to setLoad(boolean).
DISEntityTypeMapping	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
DISEntityTypeMapping	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
DISEntityTypeMapping	setSpecific(int newValue)	Accessor method to assign int value to initializeOnly SFInt32 field named specific.
DISEntityTypeMapping	setSpecific(SFInt32 newValue)	Assign typed object value to SFInt32 specific field, similar to setSpecific(int).
DISEntityTypeMapping	setSubcategory(int newValue)	Accessor method to assign int value to initializeOnly SFInt32 field named subcategory.
DISEntityTypeMapping	setSubcategory(SFInt32 newValue)	Assign typed object value to SFInt32 subcategory field, similar to setSubcategory(int).
DISEntityTypeMapping	setUrl(String newValue)	Assign singleton String value to MFString url field, similar to setUrl(String[]).
DISEntityTypeMapping	setUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named url.
DISEntityTypeMapping	setUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString url field, similar to setUrl(String[]).
DISEntityTypeMapping	setUrl(MFString newValue)	Assign typed object value to MFString url field, similar to setUrl(String[]).
DISEntityTypeMapping	setUrl(SFString newValue)	Assign single SFString object value to MFString url field, similar to setUrl(String[]).
final DISEntityTypeMapping	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
DISEntityTypeMapping	setUSE(DISEntityTypeMapping DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
DISEntityTypeMapping	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: DISEntityTypeMapping.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the DISEntityTypeMapping 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

AUTOREFRESH_DEFAULT_VALUE

public static final double AUTOREFRESH_DEFAULT_VALUE

SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

AUTOREFRESHTIMELIMIT_DEFAULT_VALUE

public static final double AUTOREFRESHTIMELIMIT_DEFAULT_VALUE

SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).

See Also:

• Constant Field Values

CATEGORY_DEFAULT_VALUE

public static final int CATEGORY_DEFAULT_VALUE

SFInt32 field named category has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

COUNTRY_DEFAULT_VALUE

public static final int COUNTRY_DEFAULT_VALUE

SFInt32 field named country has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

DOMAIN_DEFAULT_VALUE

public static final int DOMAIN_DEFAULT_VALUE

SFInt32 field named domain has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

EXTRA_DEFAULT_VALUE

public static final int EXTRA_DEFAULT_VALUE

SFInt32 field named extra has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

KIND_DEFAULT_VALUE

public static final int KIND_DEFAULT_VALUE

SFInt32 field named kind has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

LOAD_DEFAULT_VALUE

public static final boolean LOAD_DEFAULT_VALUE

SFBool field named load has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

SPECIFIC_DEFAULT_VALUE

public static final int SPECIFIC_DEFAULT_VALUE

SFInt32 field named specific has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

SUBCATEGORY_DEFAULT_VALUE

public static final int SUBCATEGORY_DEFAULT_VALUE

SFInt32 field named subcategory has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

URL_DEFAULT_VALUE

public static final ArrayList<String> URL_DEFAULT_VALUE

MFString field named url has default value equal to an empty list.

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children", "mapping", "children" }; type X3DUOM containerFieldChoicesDISEntityTypeMapping

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_AUTOREFRESH

public static final String fromField_AUTOREFRESH

fromField ROUTE name for SFTime field named autoRefresh.

See Also:

• Constant Field Values

toField_AUTOREFRESH

public static final String toField_AUTOREFRESH

toField ROUTE name for SFTime field named autoRefresh.

See Also:

• Constant Field Values

fromField_AUTOREFRESHTIMELIMIT

public static final String fromField_AUTOREFRESHTIMELIMIT

fromField ROUTE name for SFTime field named autoRefreshTimeLimit.

See Also:

• Constant Field Values

toField_AUTOREFRESHTIMELIMIT

public static final String toField_AUTOREFRESHTIMELIMIT

toField ROUTE name for SFTime field named autoRefreshTimeLimit.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_LOAD

public static final String fromField_LOAD

fromField ROUTE name for SFBool field named load.

See Also:

• Constant Field Values

toField_LOAD

public static final String toField_LOAD

toField ROUTE name for SFBool field named load.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_URL

public static final String fromField_URL

fromField ROUTE name for MFString field named url.

See Also:

• Constant Field Values

toField_URL

public static final String toField_URL

toField ROUTE name for MFString field named url.

See Also:

• Constant Field Values

Constructor Details

DISEntityTypeMapping

public DISEntityTypeMapping()

Constructor for DISEntityTypeMapping to initialize member variables with default values.

DISEntityTypeMapping

public DISEntityTypeMapping(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 String getElementName()

Provides name of this element: DISEntityTypeMapping

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the DISEntityTypeMapping 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 String getFieldType(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 String getAccessType(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 String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getAutoRefresh

public double getAutoRefresh()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.

Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.

• Hint: if preceding file loading fails or load field is false, no refresh is performed.
• Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

getAutoRefresh in interface DISEntityTypeMapping

Specified by:

getAutoRefresh in interface X3DUrlObject

Returns:

value of autoRefresh field

setAutoRefresh

public DISEntityTypeMapping setAutoRefresh(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.

Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.

• Hint: if preceding file loading fails or load field is false, no refresh is performed.
• Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

setAutoRefresh in interface DISEntityTypeMapping

Specified by:

setAutoRefresh in interface X3DUrlObject

Parameters:

newValue - is new value for the autoRefresh field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAutoRefresh

public DISEntityTypeMapping setAutoRefresh(SFTime newValue)

Assign typed object value to SFTime autoRefresh field, similar to setAutoRefresh(double).

Parameters:

newValue - is new value for the autoRefresh field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getAutoRefreshTimeLimit

public double getAutoRefreshTimeLimit()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.

Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.

• Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

getAutoRefreshTimeLimit in interface DISEntityTypeMapping

Specified by:

getAutoRefreshTimeLimit in interface X3DUrlObject

Returns:

value of autoRefreshTimeLimit field

setAutoRefreshTimeLimit

public DISEntityTypeMapping setAutoRefreshTimeLimit(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.

Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.

• Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

setAutoRefreshTimeLimit in interface DISEntityTypeMapping

Specified by:

setAutoRefreshTimeLimit in interface X3DUrlObject

Parameters:

newValue - is new value for the autoRefreshTimeLimit field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAutoRefreshTimeLimit

public DISEntityTypeMapping setAutoRefreshTimeLimit(SFTime newValue)

Assign typed object value to SFTime autoRefreshTimeLimit field, similar to setAutoRefreshTimeLimit(double).

Parameters:

newValue - is new value for the autoRefreshTimeLimit field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCategory

public int getCategory()

Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named category.

Tooltip: Integer enumerations value for main category that describes the entity, semantics of each code varies according to domain. See DIS Enumerations values. *

Specified by:

getCategory in interface DISEntityTypeMapping

Returns:

value of category field

setCategory

public DISEntityTypeMapping setCategory(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named category.

Tooltip: Integer enumerations value for main category that describes the entity, semantics of each code varies according to domain. See DIS Enumerations values. *

Specified by:

setCategory in interface DISEntityTypeMapping

Parameters:

newValue - is new value for the category field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCategory

public DISEntityTypeMapping setCategory(SFInt32 newValue)

Assign typed object value to SFInt32 category field, similar to setCategory(int).

Parameters:

newValue - is new value for the category field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCountry

public int getCountry()

Provide int value within allowed range of [0,65535] from initializeOnly SFInt32 field named country.

Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed. *

Specified by:

getCountry in interface DISEntityTypeMapping

Returns:

value of country field

setCountry

public DISEntityTypeMapping setCountry(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named country.

Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed. *

Specified by:

setCountry in interface DISEntityTypeMapping

Parameters:

newValue - is new value for the country field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCountry

public DISEntityTypeMapping setCountry(SFInt32 newValue)

Assign typed object value to SFInt32 country field, similar to setCountry(int).

Parameters:

newValue - is new value for the country field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface DISEntityTypeMapping

Specified by:

getDescription in interface X3DUrlObject

Returns:

value of description field

setDescription

public DISEntityTypeMapping setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface DISEntityTypeMapping

Specified by:

setDescription in interface X3DUrlObject

Parameters:

newValue - is new value for the description field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDescription

public DISEntityTypeMapping setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDomain

public int getDomain()

Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named domain.

Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER. *

Specified by:

getDomain in interface DISEntityTypeMapping

Returns:

value of domain field

setDomain

public DISEntityTypeMapping setDomain(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named domain.

Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER. *

Specified by:

setDomain in interface DISEntityTypeMapping

Parameters:

newValue - is new value for the domain field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDomain

public DISEntityTypeMapping setDomain(SFInt32 newValue)

Assign typed object value to SFInt32 domain field, similar to setDomain(int).

Parameters:

newValue - is new value for the domain field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getExtra

public int getExtra()

Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named extra.

Tooltip: Any extra information required to describe a particular entity. The contents of this field shall depend on the type of entity represented. *

Specified by:

getExtra in interface DISEntityTypeMapping

Returns:

value of extra field

setExtra

public DISEntityTypeMapping setExtra(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named extra.

Tooltip: Any extra information required to describe a particular entity. The contents of this field shall depend on the type of entity represented. *

Specified by:

setExtra in interface DISEntityTypeMapping

Parameters:

newValue - is new value for the extra field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setExtra

public DISEntityTypeMapping setExtra(SFInt32 newValue)

Assign typed object value to SFInt32 extra field, similar to setExtra(int).

Parameters:

newValue - is new value for the extra field.

Returns:

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

DISEntityTypeMapping - 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 DISEntityTypeMapping clearIS()

Utility method to clear SFNode value of IS field.

Returns:

DISEntityTypeMapping - 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()

getKind

public int getKind()

Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named kind.

Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER. *

Specified by:

getKind in interface DISEntityTypeMapping

Returns:

value of kind field

setKind

public DISEntityTypeMapping setKind(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named kind.

Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER. *

Specified by:

setKind in interface DISEntityTypeMapping

Parameters:

newValue - is new value for the kind field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setKind

public DISEntityTypeMapping setKind(SFInt32 newValue)

Assign typed object value to SFInt32 kind field, similar to setKind(int).

Parameters:

newValue - is new value for the kind field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getLoad

public boolean getLoad()

Provide boolean value from inputOutput SFBool field named load.

Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.

• Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
• Hint: use a separate LoadSensor node to detect when loading is complete.

Specified by:

getLoad in interface DISEntityTypeMapping

Specified by:

getLoad in interface X3DUrlObject

Returns:

value of load field

setLoad

public DISEntityTypeMapping setLoad(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named load.

Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.

• Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
• Hint: use a separate LoadSensor node to detect when loading is complete.

Specified by:

setLoad in interface DISEntityTypeMapping

Specified by:

setLoad in interface X3DUrlObject

Parameters:

newValue - is new value for the load field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLoad

public DISEntityTypeMapping setLoad(SFBool newValue)

Assign typed object value to SFBool load field, similar to setLoad(boolean).

Parameters:

newValue - is new value for the load field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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 DISEntityTypeMapping

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DInfoNode

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/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DInfoNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

DISEntityTypeMapping - 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/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public DISEntityTypeMapping clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

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

DISEntityTypeMapping - 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

getSpecific

public int getSpecific()

Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named specific.

Tooltip: Specific information about an entity based on the subcategory field. See DIS Enumerations values. *

Specified by:

getSpecific in interface DISEntityTypeMapping

Returns:

value of specific field

setSpecific

public DISEntityTypeMapping setSpecific(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named specific.

Tooltip: Specific information about an entity based on the subcategory field. See DIS Enumerations values. *

Specified by:

setSpecific in interface DISEntityTypeMapping

Parameters:

newValue - is new value for the specific field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSpecific

public DISEntityTypeMapping setSpecific(SFInt32 newValue)

Assign typed object value to SFInt32 specific field, similar to setSpecific(int).

Parameters:

newValue - is new value for the specific field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getSubcategory

public int getSubcategory()

Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named subcategory.

Tooltip: Integer enumerations value for particular subcategory to which an entity belongs based on the category field. See DIS Enumerations values. *

Specified by:

getSubcategory in interface DISEntityTypeMapping

Returns:

value of subcategory field

setSubcategory

public DISEntityTypeMapping setSubcategory(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named subcategory.

Tooltip: Integer enumerations value for particular subcategory to which an entity belongs based on the category field. See DIS Enumerations values. *

Specified by:

setSubcategory in interface DISEntityTypeMapping

Parameters:

newValue - is new value for the subcategory field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSubcategory

public DISEntityTypeMapping setSubcategory(SFInt32 newValue)

Assign typed object value to SFInt32 subcategory field, similar to setSubcategory(int).

Parameters:

newValue - is new value for the subcategory field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUrl

public String[] getUrl()

Provide array of String results from inputOutput MFString field named url.

Tooltip: Local and/or online addresses of X3D model of interest, for example: "ExtrusionExampleShip.x3d" "https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d"

• Hint: see https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html
• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
• Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls

Specified by:

getUrl in interface DISEntityTypeMapping

Specified by:

getUrl in interface X3DUrlObject

Returns:

value of url field

getUrlList

public ArrayList<String> getUrlList()

Utility method to get ArrayList value of MFString url field, similar to getUrl().

Returns:

value of url field

getUrlString

public String getUrlString()

Utility method to get String value of MFString url field, similar to getUrl().

Returns:

value of url field

setUrl

public DISEntityTypeMapping setUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named url.

Tooltip: Local and/or online addresses of X3D model of interest, for example: "ExtrusionExampleShip.x3d" "https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d"

• Hint: see https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html
• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
• Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls

Specified by:

setUrl in interface DISEntityTypeMapping

Specified by:

setUrl in interface X3DUrlObject

Parameters:

newValue - is new value for the url field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUrl

public DISEntityTypeMapping setUrl(MFString newValue)

Assign typed object value to MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUrl

public DISEntityTypeMapping setUrl(SFString newValue)

Assign single SFString object value to MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUrl

public DISEntityTypeMapping setUrl(String newValue)

Assign singleton String value to MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUrl

public DISEntityTypeMapping setUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearUrl

public DISEntityTypeMapping clearUrl()

Utility method to clear MFString value of url field. This method does not initialize withURL_DEFAULT_VALUE.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addUrl

public DISEntityTypeMapping addUrl(String newValue)

Add singleton String value to MFString url field.

Parameters:

newValue - is new value to add to the url field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

addUrl

public DISEntityTypeMapping addUrl(SFString newValue)

Add singleton SFString value to MFString url field.

Parameters:

newValue - is new value to add to the url field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

getDEF

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

• 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final DISEntityTypeMapping setDEF(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.

• 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

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:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

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

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public 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 DISEntityTypeMapping setUSE(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:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

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

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final DISEntityTypeMapping setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

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

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final DISEntityTypeMapping setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public DISEntityTypeMapping setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final DISEntityTypeMapping setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public DISEntityTypeMapping setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public DISEntityTypeMapping setUSE(DISEntityTypeMapping 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:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public DISEntityTypeMapping addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public DISEntityTypeMapping addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public DISEntityTypeMapping addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• 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 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 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(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(String nameValue,
 String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

• findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

• findElementByNameValue(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

• findNodeByDEF(String)

validate

public String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)