Package org.web3d.x3d.jsail.Core

Class ROUTE

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteStatement

org.web3d.x3d.jsail.Core.ROUTE

All Implemented Interfaces:

X3DChildNode, X3DNode

public class ROUTE
extends X3DConcreteStatement
implements X3DChildNode

ROUTE connects output fields of event-producing nodes to input fields of event-consuming nodes. This concrete class represents an X3D ROUTE statement.

ROUTE statement tooltip: ROUTE connects output fields of event-producing nodes to input fields of event-consuming nodes.

• Warning: each ROUTE must follow the DEF definition of both event-source and event-target nodes.
• Warning: strongly typed event checking means that data type (SFInt32, MFVec3f, etc.) must match identically for both event-source and event-target fields.
• Warning: event-source fields can have accessType outputOnly or inputOutput, while event-target nodes can have accessType inputOnly or inputOutput.
• Hint: event tracing supports animation debugging https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07-EventAnimationInterpolation/Chapter07-EventAnimationInterpolation-EventTracing.pdf
• Hint: X3D Architecture 7.2.5.7 ROUTE statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#ROUTEStatement
• Hint: Fan-in occurs when two or more routes have the same destination field. All events are considered to have been received simultaneously; therefore, the order in which they are processed is not considered relevant.
• Hint: Fan-out occurs when one field is the source for more than one route. This results in sending any event generated by the field along all routes. All events are considered to have been sent simultaneously; therefore, the order in which they are processed is not considered relevant.
• Hint: X3D Architecture 4.4.8.2 Routes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Routes
• Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation

See Also:

• X3D Abstract Specification: ROUTE
• X3D Tooltips: ROUTE
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ROUTE element: Core
static final String	FROMFIELD_DEFAULT_VALUE	SFString field named fromField has default value equal to an empty string.
static final String	FROMNODE_DEFAULT_VALUE	SFString field named fromNode has default value equal to an empty string.
static final int	LEVEL	Integer constant LEVEL provides default X3D Core component level for this element: 1
static final String	NAME	String constant NAME provides name of this element: ROUTE.
static final String	TOFIELD_DEFAULT_VALUE	SFString field named toField has default value equal to an empty string.
static final String	TONODE_DEFAULT_VALUE	SFString field named toNode has default value equal to an empty string.

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
ROUTE()	Constructor for ROUTE to initialize member variables with default values.

Method Summary

Modifier and Type	Method	Description
ROUTE	addComments(String newComment)	Add comment as String to contained commentsList.
ROUTE	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ROUTE	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
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.
final String	getComponent()	Defines X3D component for the ROUTE element: Core
final int	getComponentLevel()	Provides default X3D component level for this element: 1
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
final String	getElementName()	Provides name of this element: ROUTE
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getFromField()	Provide String value from inputOutput SFString field named fromField.
String	getFromNode()	Provide String value from inputOutput SFString field named fromNode.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
X3DMetadataObject	getMetadata()	Deprecated.
String	getToField()	Provide String value from inputOutput SFString field named toField.
String	getToNode()	Provide String value from inputOutput SFString field named toNode.
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	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.
final ROUTE	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ROUTE	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final ROUTE	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ROUTE	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
ROUTE	setDEF(String newValue)	Deprecated.
ROUTE	setFromField(String newValue)	Accessor method to assign String value to inputOutput SFString field named fromField.
ROUTE	setFromField(SFString newValue)	Assign typed object value to SFString fromField field, similar to setFromField(String).
ROUTE	setFromNode(String newValue)	Accessor method to assign String value to inputOutput SFString field named fromNode.
ROUTE	setFromNode(SFString newValue)	Assign typed object value to SFString fromNode field, similar to setFromNode(String).
final ROUTE	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ROUTE	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
ROUTE	setMetadata(X3DMetadataObject newValue)	Deprecated.
ROUTE	setToField(String newValue)	Accessor method to assign String value to inputOutput SFString field named toField.
ROUTE	setToField(SFString newValue)	Assign typed object value to SFString toField field, similar to setToField(String).
ROUTE	setToNode(String newValue)	Accessor method to assign String value to inputOutput SFString field named toNode.
ROUTE	setToNode(SFString newValue)	Assign typed object value to SFString toNode field, similar to setToNode(String).
ROUTE	setUSE(String newValue)	Deprecated.
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.X3DConcreteStatement

isNode, isStatement

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: ROUTE.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the ROUTE element: Core

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Core component level for this element: 1

See Also:

• Constant Field Values

FROMFIELD_DEFAULT_VALUE

public static final String FROMFIELD_DEFAULT_VALUE

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

See Also:

• Constant Field Values

FROMNODE_DEFAULT_VALUE

public static final String FROMNODE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

TOFIELD_DEFAULT_VALUE

public static final String TOFIELD_DEFAULT_VALUE

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

See Also:

• Constant Field Values

TONODE_DEFAULT_VALUE

public static final String TONODE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

Constructor Details

ROUTE

public ROUTE()

Constructor for ROUTE to initialize member variables with default values.

Method Details

getElementName

public final String getElementName()

Provides name of this element: ROUTE

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the ROUTE element: Core

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D statement

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

• 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 statement

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteStatement

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 ROUTE setCssClass(String newValue)

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

Parameters:

newValue - is new value for the class field.

Returns:

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

setCssClass

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

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

getFromField

public String getFromField()

Provide String value from inputOutput SFString field named fromField.

Tooltip: fromField is the field name in the source node which is originating an event.

• Hint: if (and only if) corresponding field has accessType inputOutput, author has option to append "_changed" suffix to field name - both forms are functionally equivalent.
• Warning: do not define an event connection using DEF, USE, class or containerField as literal values, since they are not fields in a node that can be modified by events at run time.
• Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the set_ prefix or the _changed suffix on the field name.
• Hint: X3D Architecture 4.4.2.2 Field Semantics https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/concepts.html#FieldSemantics
• Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form https://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm

Returns:

value of fromField field

setFromField

public ROUTE setFromField(String newValue)

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

Tooltip: fromField is the field name in the source node which is originating an event.

• Hint: if (and only if) corresponding field has accessType inputOutput, author has option to append "_changed" suffix to field name - both forms are functionally equivalent.
• Warning: do not define an event connection using DEF, USE, class or containerField as literal values, since they are not fields in a node that can be modified by events at run time.
• Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the set_ prefix or the _changed suffix on the field name.
• Hint: X3D Architecture 4.4.2.2 Field Semantics https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/concepts.html#FieldSemantics
• Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form https://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm

Parameters:

newValue - is new value for the fromField field.

Returns:

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

setFromField

public ROUTE setFromField(SFString newValue)

Assign typed object value to SFString fromField field, similar to setFromField(String).

Parameters:

newValue - is new value for the fromField field.

Returns:

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

getFromNode

public String getFromNode()

Provide String value from inputOutput SFString field named fromNode.

Tooltip: fromNode is the DEF name of the node originating an event. *

Returns:

value of fromNode field

setFromNode

public ROUTE setFromNode(String newValue)

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

Tooltip: fromNode is the DEF name of the node originating an event. *

Parameters:

newValue - is new value for the fromNode field.

Returns:

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

setFromNode

public ROUTE setFromNode(SFString newValue)

Assign typed object value to SFString fromNode field, similar to setFromNode(String).

Parameters:

newValue - is new value for the fromNode field.

Returns:

ROUTE - 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 ROUTE setHtmlID(String newValue)

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

Parameters:

newValue - is new value for the id field.

Returns:

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

setHtmlID

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

ROUTE - 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 ROUTE setCssStyle(String newValue)

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

Parameters:

newValue - is new value for the style field.

Returns:

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

setCssStyle

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

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

getToField

public String getToField()

Provide String value from inputOutput SFString field named toField.

Tooltip: toField is the field name in the destination node which is receiving an event.

• Hint: if (and only if) corresponding field has accessType inputOutput, author has option to prepend "set_" prefix to field name - both forms are functionally equivalent.
• Warning: do not define an event connection using DEF, USE, class or containerField as literal values, since they are not fields in a node that can be modified by events at run time.
• Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the set_ prefix or the _changed suffix on the field name.
• Hint: X3D Architecture 4.4.2.2 Field Semantics https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/concepts.html#FieldSemantics
• Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form https://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm

Returns:

value of toField field

setToField

public ROUTE setToField(String newValue)

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

Tooltip: toField is the field name in the destination node which is receiving an event.

• Hint: if (and only if) corresponding field has accessType inputOutput, author has option to prepend "set_" prefix to field name - both forms are functionally equivalent.
• Warning: do not define an event connection using DEF, USE, class or containerField as literal values, since they are not fields in a node that can be modified by events at run time.
• Warning: if corresponding field has accessType outputOnly or inputOnly, do not modify the set_ prefix or the _changed suffix on the field name.
• Hint: X3D Architecture 4.4.2.2 Field Semantics https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/concepts.html#FieldSemantics
• Hint: X3D Compressed Binary Encoding, 4.2.3 X3D Canonical Form https://www.web3d.org/documents/specifications/19776-3/V3.3/Part03/concepts.html#X3DCanonicalForm

Parameters:

newValue - is new value for the toField field.

Returns:

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

setToField

public ROUTE setToField(SFString newValue)

Assign typed object value to SFString toField field, similar to setToField(String).

Parameters:

newValue - is new value for the toField field.

Returns:

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

getToNode

public String getToNode()

Provide String value from inputOutput SFString field named toNode.

Tooltip: toNode is the DEF name of the destination node receiving an event. *

Returns:

value of toNode field

setToNode

public ROUTE setToNode(String newValue)

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

Tooltip: toNode is the DEF name of the destination node receiving an event. *

Parameters:

newValue - is new value for the toNode field.

Returns:

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

setToNode

public ROUTE setToNode(SFString newValue)

Assign typed object value to SFString toNode field, similar to setToNode(String).

Parameters:

newValue - is new value for the toNode field.

Returns:

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

addComments

public ROUTE addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

ROUTE - 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 ROUTE addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ROUTE addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

ROUTE - 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)

getMetadata

@Deprecated
public X3DMetadataObject getMetadata()

Deprecated.

DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

null, this method is deprecated and has no effect

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

@Deprecated
public ROUTE setMetadata(X3DMetadataObject newValue)

Deprecated.

DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - ignored

Returns:

unmodified object, this method is deprecated and has no effect

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setDEF

@Deprecated
public ROUTE setDEF(String newValue)

Deprecated.

DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.

Parameters:

newValue - ignored

Returns:

unmodified object, this method is deprecated and has no effect

setUSE

@Deprecated
public ROUTE setUSE(String newValue)

Deprecated.

DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.

Parameters:

newValue - ignored

Returns:

unmodified object, this method is deprecated and has no effect