Package org.web3d.x3d.jsail.Core

Class ProtoDeclare

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteStatement

org.web3d.x3d.jsail.Core.ProtoDeclare

All Implemented Interfaces:

X3DChildNode, X3DNode

public class ProtoDeclare
extends X3DConcreteStatement
implements X3DChildNode

ProtoDeclare defines new Prototype nodes. Nested ProtoDeclares and ProtoInstances are allowed by the specification. This concrete class represents an X3D ProtoDeclare statement.

ProtoDeclare statement tooltip: ProtoDeclare is a Prototype Declaration, defining a new node made up of other node(s). ProtoDeclare contains ProtoInterface and ProtoBody statements.

• Hint: ProtoInterface contains field interfaces using the <field> tag, then ProtoBody contains the X3D nodes making up this prototype.
• Hint: initial scene node in a ProtoDeclare/ProtoBody statement determines this prototype's node type.
• Hint: ProtoDeclare is a definition only, add corresponding ProtoInstance nodes later in a scene to create new node instances.
• Hint: Nested ProtoInstance and ProtoDeclare statements are allowed within a ProtoDeclare/ProtoBody.
• Warning: a ProtoInstance node may not be instantiated inside its own ProtoDeclare or ExternProtoDeclare declaration (i.e. recursive prototypes are illegal).
• Hint: X3D Scene Authoring Hints, Inlines and Prototypes https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#InlinesPrototypes
• Hint: X3D Architecture 7.2.5.8 PROTO statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#PROTOStatement
• Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#PROTOdefinitionsemantics Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes

See Also:

• X3D Abstract Specification: ProtoDeclare
• X3D Tooltips: ProtoDeclare
• X3D Scene Authoring Hints: InlinesPrototypes

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPINFO_DEFAULT_VALUE	SFString field named appinfo has default value equal to an empty string.
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ProtoDeclare element: Core
static final String	DOCUMENTATION_DEFAULT_VALUE	SFString field named documentation has default value equal to an empty string.
static final int	LEVEL	Integer constant LEVEL provides default X3D Core component level for this element: 2
static final String	NAME	String constant NAME provides name of this element: ProtoDeclare.
static final String	NAME_DEFAULT_VALUE	SFString field named name has default value equal to an empty string.
static final ProtoBody	PROTOBODY_DEFAULT_VALUE	SFNode field named ProtoBody has default value null (Java syntax) or NULL (XML syntax).
static final ProtoInterface	PROTOINTERFACE_DEFAULT_VALUE	SFNode field named ProtoInterface has default value null (Java syntax) or NULL (XML syntax).

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
ProtoDeclare()	Constructor for ProtoDeclare to initialize member variables with default values.
ProtoDeclare(String prototypeName)	Utility constructor that assigns ProtoDeclare name after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
ProtoDeclare	addComments(String newComment)	Add comment as String to contained commentsList.
ProtoDeclare	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ProtoDeclare	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
ProtoDeclare	clearProtoBody()	Utility method to clear SFNode value of ProtoBody field.
ProtoDeclare	clearProtoInterface()	Utility method to clear SFNode value of ProtoInterface 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.
field	findFieldByName(String fieldName)	Find contained field statement by name, if present in contained ProtoInterface.
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.
String	getAppinfo()	Provide String value from inputOutput SFString field named appinfo.
final String	getComponent()	Defines X3D component for the ProtoDeclare element: Core
final int	getComponentLevel()	Provides default X3D component level for this element: 2
String	getContainerFieldDefault()	Utility method that provides default containerField value for initial node in ProtoDeclare.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDocumentation()	Provide String value from inputOutput SFString field named documentation.
final String	getElementName()	Provides name of this element: ProtoDeclare
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
X3DMetadataObject	getMetadata()	Deprecated.
String	getName()	Provide String value from inputOutput SFString field named name.
String	getNodeType()	This method helps determine node type of ProtoInstance by inspecting first node within corresponding ProtoDeclare ProtoBody, where local copy is maintained in ProtoBody primaryNode.
ProtoBody	getProtoBody()	Provide ProtoBody instance (using a properly typed node) from inputOutput SFNode field ProtoBody.
ProtoInterface	getProtoInterface()	Provide ProtoInterface instance (using a properly typed node) from inputOutput SFNode field ProtoInterface.
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	hasField(String fieldName)	Determine if field statement is present in contained ProtoInterface.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
boolean	hasProtoBody()	Indicate whether an object is available for inputOutput SFNode field ProtoBody.
boolean	hasProtoInterface()	Indicate whether an object is available for inputOutput SFNode field ProtoInterface.
final void	initialize()	Initialize all member variables to default values.
ProtoDeclare	setAppinfo(String newValue)	Accessor method to assign String value to inputOutput SFString field named appinfo.
ProtoDeclare	setAppinfo(SFString newValue)	Assign typed object value to SFString appinfo field, similar to setAppinfo(String).
final ProtoDeclare	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ProtoDeclare	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final ProtoDeclare	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ProtoDeclare	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
ProtoDeclare	setDEF(String newValue)	Deprecated.
ProtoDeclare	setDocumentation(String newValue)	Accessor method to assign String value to inputOutput SFString field named documentation.
ProtoDeclare	setDocumentation(SFString newValue)	Assign typed object value to SFString documentation field, similar to setDocumentation(String).
final ProtoDeclare	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ProtoDeclare	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
ProtoDeclare	setMetadata(X3DMetadataObject newValue)	Deprecated.
final ProtoDeclare	setName(String newValue)	Accessor method to assign String value to inputOutput SFString field named name.
ProtoDeclare	setName(SFString newValue)	Assign typed object value to SFString name field, similar to setName(String).
ProtoDeclare	setProtoBody(ProtoBody newValue)	Accessor method to assign ProtoBody instance (using a properly typed node) to inputOutput SFNode field ProtoBody.
ProtoDeclare	setProtoInterface(ProtoInterface newValue)	Accessor method to assign ProtoInterface instance (using a properly typed node) to inputOutput SFNode field ProtoInterface.
ProtoDeclare	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: ProtoDeclare.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

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

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

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

See Also:

• Constant Field Values

APPINFO_DEFAULT_VALUE

public static final String APPINFO_DEFAULT_VALUE

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

See Also:

• Constant Field Values

DOCUMENTATION_DEFAULT_VALUE

public static final String DOCUMENTATION_DEFAULT_VALUE

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

See Also:

• Constant Field Values

NAME_DEFAULT_VALUE

public static final String NAME_DEFAULT_VALUE

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

See Also:

• Constant Field Values

PROTOBODY_DEFAULT_VALUE

public static final ProtoBody PROTOBODY_DEFAULT_VALUE

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

PROTOINTERFACE_DEFAULT_VALUE

public static final ProtoInterface PROTOINTERFACE_DEFAULT_VALUE

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

Constructor Details

ProtoDeclare

public ProtoDeclare()

Constructor for ProtoDeclare to initialize member variables with default values.

ProtoDeclare

public ProtoDeclare(String prototypeName)

Utility constructor that assigns ProtoDeclare name after initializing member variables with default values.

Parameters:

prototypeName - initial name for this ProtoDeclare statement

Method Details

getElementName

public final String getElementName()

Provides name of this element: ProtoDeclare

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the ProtoDeclare element: Core

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 2

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public 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

getAppinfo

public String getAppinfo()

Provide String value from inputOutput SFString field named appinfo.

Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag. *

Returns:

value of appinfo field

setAppinfo

public ProtoDeclare setAppinfo(String newValue)

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

Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag. *

Parameters:

newValue - is new value for the appinfo field.

Returns:

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

setAppinfo

public ProtoDeclare setAppinfo(SFString newValue)

Assign typed object value to SFString appinfo field, similar to setAppinfo(String).

Parameters:

newValue - is new value for the appinfo field.

Returns:

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

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

setCssClass

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

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

getDocumentation

public String getDocumentation()

Provide String value from inputOutput SFString field named documentation.

Tooltip: Documentation url for further information, similar to XML Schema documentation tag. *

Returns:

value of documentation field

setDocumentation

public ProtoDeclare setDocumentation(String newValue)

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

Tooltip: Documentation url for further information, similar to XML Schema documentation tag. *

Parameters:

newValue - is new value for the documentation field.

Returns:

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

setDocumentation

public ProtoDeclare setDocumentation(SFString newValue)

Assign typed object value to SFString documentation field, similar to setDocumentation(String).

Parameters:

newValue - is new value for the documentation field.

Returns:

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

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

setHtmlID

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

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

getName

public String getName()

Provide String value from inputOutput SFString field named name.

Tooltip: name of this prototype being declared.

• 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

Returns:

value of name field

setName

public final ProtoDeclare setName(String newValue)

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

Tooltip: name of this prototype being declared.

• 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

@see X3D Scene Authoring Hints: Naming Conventions

Parameters:

newValue - is new value for the name field.

Returns:

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

setName

public ProtoDeclare setName(SFString newValue)

Assign typed object value to SFString name field, similar to setName(String).

Parameters:

newValue - is new value for the name field.

Returns:

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

getProtoBody

public ProtoBody getProtoBody()

Provide ProtoBody instance (using a properly typed node) from inputOutput SFNode field ProtoBody.

Tooltip: Include one ProtoBody statement after the ProtoInterface statement. *

Returns:

value of ProtoBody field

setProtoBody

public ProtoDeclare setProtoBody(ProtoBody newValue)

Accessor method to assign ProtoBody instance (using a properly typed node) to inputOutput SFNode field ProtoBody.

Tooltip: Include one ProtoBody statement after the ProtoInterface statement. *

Parameters:

newValue - is new value for the ProtoBody field.

Returns:

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

clearProtoBody

public ProtoDeclare clearProtoBody()

Utility method to clear SFNode value of ProtoBody field.

Returns:

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

hasProtoBody

public boolean hasProtoBody()

Indicate whether an object is available for inputOutput SFNode field ProtoBody.

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getProtoBody()

getProtoInterface

public ProtoInterface getProtoInterface()

Provide ProtoInterface instance (using a properly typed node) from inputOutput SFNode field ProtoInterface.

Tooltip: Include an optional ProtoInterface statement if this ProtoDeclare has field declarations.

• Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#PROTOdefinitionsemantics Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes

Returns:

value of ProtoInterface field

setProtoInterface

public ProtoDeclare setProtoInterface(ProtoInterface newValue)

Accessor method to assign ProtoInterface instance (using a properly typed node) to inputOutput SFNode field ProtoInterface.

Tooltip: Include an optional ProtoInterface statement if this ProtoDeclare has field declarations.

• Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#PROTOdefinitionsemantics Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes

Parameters:

newValue - is new value for the ProtoInterface field.

Returns:

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

clearProtoInterface

public ProtoDeclare clearProtoInterface()

Utility method to clear SFNode value of ProtoInterface field.

Returns:

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

hasProtoInterface

public boolean hasProtoInterface()

Indicate whether an object is available for inputOutput SFNode field ProtoInterface.

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getProtoInterface()

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

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

setCssStyle

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

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

getNodeType

public String getNodeType()

This method helps determine node type of ProtoInstance by inspecting first node within corresponding ProtoDeclare ProtoBody, where local copy is maintained in ProtoBody primaryNode.

Returns:

name of X3D node corresponding to node type for this ProtoDeclare statement

See Also:

• X3D Abstract Specification: 4.4.4.3 PROTO definition semantics
• ProtoBody.getNodeType()
• ExternProtoDeclare.getNodeType()
• ProtoInstance.getNodeType()
• Scene

getContainerFieldDefault

public String getContainerFieldDefault()

Utility method that provides default containerField value for initial node in ProtoDeclare. Hint: ProtoInstance containerField is important for determining parent-child node relationships.

Returns:

default containerField value

See Also:

• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3DConcreteNode.setContainerFieldOverride(String)
• X3D Tooltips: ProtoInstance.containerField
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField

findFieldByName

public field findFieldByName(String fieldName)

Find contained field statement by name, if present in contained ProtoInterface.

Parameters:

fieldName - is name attribute for field of interest

Returns:

field reference of interest, null otherwise

hasField

public boolean hasField(String fieldName)

Determine if field statement is present in contained ProtoInterface.

Parameters:

fieldName - is name attribute for field of interest

Returns:

whether field is found

addComments

public ProtoDeclare addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ProtoDeclare addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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