Package org.web3d.x3d.jsail

Class X3DConcreteElement

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

Direct Known Subclasses:

X3DConcreteNode, X3DConcreteStatement

public abstract class X3DConcreteElement
extends Object

Topmost abstract parent class for concrete X3D nodes and statements, containing common methods and member variables.

See Also:

• X3D Tooltips
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS_DEFAULT_VALUE	SFString field named class for CSS has default value equal to an empty string.
static final String	ID_DEFAULT_VALUE	SFString field named id for html has default value equal to an empty string.
protected static final String	NAME	String constant NAME provides name of this element; overridden by implementing class.
static final String	STYLE_DEFAULT_VALUE	SFString field named style for CSS has default value equal to an empty string.
protected StringBuilder	validationResult	Results log of local validation.

Constructor Summary

Constructors

Constructor	Description
X3DConcreteElement()

Method Summary

Modifier and Type	Method	Description
X3DConcreteElement	addComments()	Debug support: adding empty comment as CommentsBlock to children field has no effect.
abstract X3DConcreteElement	addComments(String newComment)	Add comment as String to contained commentsList.
abstract X3DConcreteElement	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
abstract X3DConcreteElement	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to element
void	clearParent()	Package-protected internal method to clear local reference to parent object, if any.
X3DConcreteElement	findAncestorElementByName(String ancestorElementName)	Find object reference to ancestor element (i.e. node or statement), if this object is an attached child.
ProtoBody	findAncestorProtoBody()	Find object reference to ancestor ProtoBody, if this node or statement is a child.
Scene	findAncestorScene()	Find object reference to ancestor Scene element, assumes this object is an attached child.
X3D	findAncestorX3D()	Find object reference to ancestor X3D element, if this node or statement is part of an X3D object.
abstract 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.
abstract 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.
abstract X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
abstract String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
abstract String	getComponent()	Defines X3D component for this element.
abstract int	getComponentLevel()	Provides default X3D component level for this element
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
abstract String	getElementName()	Provides name of this element.
abstract String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
static String	getPackageName(String className)	Provide fully qualified package for a given element object, including className.
X3DConcreteElement	getParent()	Provide object reference to parent X3D node or statement, if any.
String	getValidationResult()	Get output of results from prior validation, if any
boolean	hasAncestorElementByName(String ancestorElementName)	Determine whether ancestor element (i.e. node or statement) is found, meaning this object is an attached child.
boolean	hasAncestorProtoBody()	Determine whether ancestor ProtoBody element is found, meaning this object is an attached child.
boolean	hasAncestorScene()	Determine whether ancestor Scene element is found, meaning this object is an attached child.
boolean	hasAncestorX3D()	Determine whether ancestor X3D element is found, meaning this object is an attached child.
boolean	hasParent()	Whether parent object exists.
void	initialize()	Initialize all member variables to default values.
boolean	isValid()	Recursive method to determine whether this element is valid.
protected void	setConcreteCssClass(String newValue)	Protected internal superclass method to keep cssClass private, scene authors should use method setCssClass(newValue) instead.
protected void	setConcreteCssStyle(String newValue)	Protected internal superclass method to keep cssStyles private, scene authors should use method setCssStyle(newValue) instead.
protected void	setConcreteHtmlID(String newValue)	Protected internal superclass method to keep HTML id private, scene authors should use method setHtmlID(newValue) instead.
void	setParent(X3DConcreteElement newParentObject)	Package-internal method to set parent object reference.
String	toStringClassicVRML()	Recursive method to provide ClassicVRML string serialization.
abstract String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97()	Recursive method to provide VRML97 string serialization.
abstract String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D()	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
abstract String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
abstract 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 java.lang.Object

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

Field Details

NAME

protected static final String NAME

String constant NAME provides name of this element; overridden by implementing class.

See Also:

• Constant Field Values

ID_DEFAULT_VALUE

public static final String ID_DEFAULT_VALUE

SFString field named id for html has default value equal to an empty string.

See Also:

• Constant Field Values

CLASS_DEFAULT_VALUE

public static final String CLASS_DEFAULT_VALUE

SFString field named class for CSS has default value equal to an empty string.

See Also:

• Constant Field Values

STYLE_DEFAULT_VALUE

public static final String STYLE_DEFAULT_VALUE

SFString field named style for CSS has default value equal to an empty string.

See Also:

• Constant Field Values

validationResult

protected StringBuilder validationResult

Results log of local validation.

Constructor Details

X3DConcreteElement

public X3DConcreteElement()

Method Details

getParent

public X3DConcreteElement getParent()

Provide object reference to parent X3D node or statement, if any. This reference is named "parentObject" rather than "parent" to avoid potential name collision with any X3D field named "parent".

Returns:

object reference to parent X3D node or statement, otherwise null if none

hasParent

public boolean hasParent()

Whether parent object exists. This reference is named "parentObject" rather than "parent" to avoid potential name collision with any X3D field named "parent".

Returns:

true if found

setParent

public void setParent(X3DConcreteElement newParentObject)

Package-internal method to set parent object reference.

Parameters:

newParentObject - object reference to parent node or X3D statement that contains this node

clearParent

public void clearParent()

Package-protected internal method to clear local reference to parent object, if any.

findAncestorScene

public Scene findAncestorScene()

Find object reference to ancestor Scene element, assumes this object is an attached child.

Returns:

ancestor Scene child reference if attached, otherwise null

See Also:

• hasAncestorScene()
• hasAncestorX3D()
• findAncestorX3D()

hasAncestorScene

public boolean hasAncestorScene()

Determine whether ancestor Scene element is found, meaning this object is an attached child.

Returns:

whether ancestor Scene node is found

See Also:

• hasAncestorScene()
• hasAncestorX3D()
• findAncestorX3D()

findAncestorElementByName

public X3DConcreteElement findAncestorElementByName(String ancestorElementName)

Find object reference to ancestor element (i.e. node or statement), if this object is an attached child.

Parameters:

ancestorElementName - elementName of ancestor of interest (e.g. first Transform)

Returns:

ancestor node reference if attached and found, otherwise null

hasAncestorElementByName

public boolean hasAncestorElementByName(String ancestorElementName)

Determine whether ancestor element (i.e. node or statement) is found, meaning this object is an attached child.

Parameters:

ancestorElementName - elementName of ancestor of interest (e.g. first Transform)

Returns:

whether ancestor element is found

See Also:

• findAncestorProtoBody()

findAncestorProtoBody

public ProtoBody findAncestorProtoBody()

Find object reference to ancestor ProtoBody, if this node or statement is a child.

Returns:

ancestor ProtoBody reference if attached and found, otherwise null

See Also:

• hasAncestorProtoBody()

hasAncestorProtoBody

public boolean hasAncestorProtoBody()

Determine whether ancestor ProtoBody element is found, meaning this object is an attached child.

Returns:

whether ancestor ProtoBody element is found

See Also:

• findAncestorProtoBody()

findAncestorX3D

public X3D findAncestorX3D()

Find object reference to ancestor X3D element, if this node or statement is part of an X3D object.

Returns:

ancestor X3D reference if attached, otherwise null

See Also:

• hasAncestorX3D()
• hasAncestorScene()
• hasAncestorScene()

hasAncestorX3D

public boolean hasAncestorX3D()

Determine whether ancestor X3D element is found, meaning this object is an attached child.

Returns:

whether ancestor X3D element is found

See Also:

• findAncestorX3D()
• hasAncestorScene()
• hasAncestorScene()

getElementName

public abstract String getElementName()

Provides name of this element.

Returns:

name of this element

getComponent

public abstract String getComponent()

Defines X3D component for this element.

Returns:

X3D component for this element

getComponentLevel

public abstract int getComponentLevel()

Provides default X3D component level for this element

Returns:

default X3D component level for this element

getFieldType

public abstract String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

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 abstract String getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

Parameters:

fieldName - name of field in this X3D statement

Returns:

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

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

findElementByNameValue

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

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)
• hasAncestorScene()
• findAncestorX3D()
• meta
• Warning: more than one element may be found that has the same name, this method does not handle that case.

findElementByNameValue

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

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)
• hasAncestorScene()
• findAncestorX3D()

findNodeByDEF

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

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)
• hasAncestorScene()
• findAncestorX3D()

getPackageName

public static String getPackageName(String className)

Provide fully qualified package for a given element object, including className. Helpful for reflection.

Parameters:

className - X3D statement or node of interest

Returns:

fully qualified package for className

initialize

public void initialize()

Initialize all member variables to default values.

setConcreteCssClass

protected void setConcreteCssClass(String newValue)

Protected internal superclass method to keep cssClass private, scene authors should use method setCssClass(newValue) instead. This attribute is only functional if the X3D model is loaded within an HTML page. Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.

Parameters:

newValue - is new value for the 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

setConcreteHtmlID

protected void setConcreteHtmlID(String newValue)

Protected internal superclass method to keep HTML id private, scene authors should use method setHtmlID(newValue) instead. This attribute is only functional if the X3D model is loaded within an HTML page. Tooltip: the id attribute on each X3D node is considered a unique identifier when used as part of an encompassing HTML/DOM context.

Parameters:

newValue - is new value for the id field.

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

setConcreteCssStyle

protected void setConcreteCssStyle(String newValue)

Protected internal superclass method to keep cssStyles private, scene authors should use method setCssStyle(newValue) instead. This attribute is only functional if the X3D model is loaded within an HTML page. Tooltip: The style attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.

Parameters:

newValue - is new value for the 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

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Tooltip: the id attribute on each X3D node is considered a unique identifier when used as part of an encompassing HTML/DOM context.The class field is a space-separated list of classes, reserved for use by CSS cascading stylesheets.

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

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Tooltip: The class field is a space-separated list of classes, reserved for use by CSS cascading stylesheets.

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

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Tooltip: The style field provides an inline block of CSS for element styling, reserved for use by CSS cascading stylesheets.

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

addComments

public abstract X3DConcreteElement addComments(String newComment)

Add comment as String to contained commentsList.

Parameters:

newComment - initial value

Returns:

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

addComments

public X3DConcreteElement addComments()

Debug support: adding empty comment as CommentsBlock to children field has no effect.

Returns:

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

addComments

public abstract X3DConcreteElement addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Parameters:

newComments - array of comments

Returns:

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

addComments

public abstract X3DConcreteElement addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to element

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

getValidationResult

public String getValidationResult()

Get output of results from prior validation, if any

Returns:

validation results (if any)

toStringX3D

public String toStringX3D()

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

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringX3D

public abstract String toStringX3D(int indentLevel)

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

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML()

Recursive method to provide ClassicVRML string serialization.

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

toStringClassicVRML

public abstract String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

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

Recursive method to provide VRML97 string serialization.

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

toStringVRML97

public abstract String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

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

isValid

public boolean isValid()

Recursive method to determine whether this element is valid.

Returns:

true if validate() has no results

validate

public abstract 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. This method must be overridden, ensuring that a concrete method is provided for each class.

Returns:

validation results (if any)