Package org.web3d.x3d.jsail.Core

Class MetadataSet

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Core.MetadataSet

All Implemented Interfaces:

MetadataSet, X3DMetadataObject, X3DNode

public class MetadataSet
extends X3DConcreteNode
implements MetadataSet

The metadata provided by this node is contained in the metadata nodes of the value field.

X3D node tooltip: [X3DNode,X3DMetadataObject] MetadataSet contains a list of Metadata* nodes that each have containerField="value" and together provide information about the parent node of the MetadataSet. Further information about this specific MetadataSet node may be provided by a single child Metadata* node with containerField="metadata".

• Hint: use containerField="value" if the parent node is MetadataSet.
• Hint: each of the Metadata nodes are allowed as top-level root nodes in a scene, be sure to explicitly define containerField='metadata'. https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes
• Warning: Metadata nodes can only contain other Metadata nodes.
• Hint: if present, an IS statement is the first child within any other node.
• Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any other sibling nodes.
• Hint: MetadataSet can contain other MetadataSet nodes.
• Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo and Metadata* nodes are persistent and inspectable at run time.
• Hint: X3D for Web Authors, Chapter 15, Metadata Information https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.html

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the MetadataSet element: Core
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_NAME	fromField ROUTE name for SFString field named name.
static final String	fromField_REFERENCE	fromField ROUTE name for SFString field named reference.
static final String	fromField_VALUE	fromField ROUTE name for MFNode field named value.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Core component level for this element: 1
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: MetadataSet.
static final String	NAME_DEFAULT_VALUE	SFString field named name has default value equal to an empty string.
static final String	REFERENCE_DEFAULT_VALUE	SFString field named reference has default value equal to an empty string.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_NAME	toField ROUTE name for SFString field named name.
static final String	toField_REFERENCE	toField ROUTE name for SFString field named reference.
static final String	toField_VALUE	toField ROUTE name for MFNode field named value.

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

containerField_ALTERNATE_VALUES, 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
MetadataSet()	Constructor for MetadataSet to initialize member variables with default values.
MetadataSet(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.
MetadataSet(String DEFlabel, String newName)	Utility constructor that assigns both DEF label and name, after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
MetadataSet	addComments(String newComment)	Add comment as String to contained commentsList.
MetadataSet	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
MetadataSet	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
MetadataSet	addValue(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for value field.
MetadataSet	addValue(X3DNode newValue)	Add single child node to existing array of value nodes (if any).
void	addValue(X3DNode[] newValue)	Add array of child value nodes to array of existing nodes (if any).
MetadataSet	clearIS()	Utility method to clear SFNode value of IS field.
MetadataSet	clearMetadata()	Utility method to clear SFNode value of metadata field.
MetadataSet	clearValue()	Utility method to clear MFNode value 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.
final String	getComponent()	Defines X3D component for the MetadataSet element: Core
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
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.
final String	getElementName()	Provides name of this element: MetadataSet
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.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
String	getName()	Provide String value from inputOutput SFString field named name.
String	getReference()	Provide String value from inputOutput SFString field named reference.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
X3DNode[]	getValue()	Provide array of org.web3d.x3d.sai.Core.X3DMetadataObject results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field value.
ArrayList<X3DNode>	getValueList()	Utility method to get ArrayList MFNode value field, similar to getValue().
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.
boolean	hasValue()	Indicate whether an object is available for inputOutput MFNode field value.
final void	initialize()	Initialize all member variables to default values.
final MetadataSet	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
MetadataSet	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final MetadataSet	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
MetadataSet	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final MetadataSet	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
MetadataSet	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final MetadataSet	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
MetadataSet	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
MetadataSet	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
MetadataSet	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
MetadataSet	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
final MetadataSet	setName(String newValue)	Accessor method to assign String value to inputOutput SFString field named name.
MetadataSet	setName(SFString newValue)	Assign typed object value to SFString name field, similar to setName(String).
MetadataSet	setReference(String newValue)	Accessor method to assign String value to inputOutput SFString field named reference.
MetadataSet	setReference(SFString newValue)	Assign typed object value to SFString reference field, similar to setReference(String).
final MetadataSet	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
MetadataSet	setUSE(MetadataSet DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
MetadataSet	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
MetadataSet	setValue(ArrayList<X3DMetadataObject> newValue)	Assign ArrayList MFNode value field, similar to setValue(org.web3d.x3d.sai.Core.X3DNode[]).
void	setValue(X3DNode newValue)	Set single child value node, replacing prior array of existing nodes (if any).
MetadataSet	setValue(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field value.
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

getContainerFieldAlternateValues, getContainerFieldOverride, 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: MetadataSet.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

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

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

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

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

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

REFERENCE_DEFAULT_VALUE

public static final String REFERENCE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

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, default value is provided for informational purposes.

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Unified Object Model (X3DUOM)
• 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_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_NAME

public static final String fromField_NAME

fromField ROUTE name for SFString field named name.

See Also:

• Constant Field Values

toField_NAME

public static final String toField_NAME

toField ROUTE name for SFString field named name.

See Also:

• Constant Field Values

fromField_REFERENCE

public static final String fromField_REFERENCE

fromField ROUTE name for SFString field named reference.

See Also:

• Constant Field Values

toField_REFERENCE

public static final String toField_REFERENCE

toField ROUTE name for SFString field named reference.

See Also:

• Constant Field Values

fromField_VALUE

public static final String fromField_VALUE

fromField ROUTE name for MFNode field named value.

See Also:

• Constant Field Values

toField_VALUE

public static final String toField_VALUE

toField ROUTE name for MFNode field named value.

See Also:

• Constant Field Values

Constructor Details

MetadataSet

public MetadataSet()

Constructor for MetadataSet to initialize member variables with default values.

MetadataSet

public MetadataSet(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

MetadataSet

public MetadataSet(String DEFlabel,
 String newName)

Utility constructor that assigns both DEF label and name, after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

newName - name for this meta element

See Also:

• X3D Tooltips: MetadataSet
• X3D Scene Authoring Hints: Metadata Nodes

Method Details

getElementName

public final String getElementName()

Provides name of this element: MetadataSet

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the MetadataSet 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 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. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

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

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

clearIS

public MetadataSet clearIS()

Utility method to clear SFNode value of IS field.

Returns:

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

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 MetadataSet

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

setMetadata

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

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

clearMetadata

public MetadataSet clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getName

public String getName()

Provide String value from inputOutput SFString field named name.

Tooltip: Depending on the metadata vocabulary, the attribute name is usually required for metadata nodes.

• Warning: name field is not included if this instance is a USE node, in order to avoid potential mismatches.
• 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

Specified by:

getName in interface MetadataSet

Specified by:

getName in interface X3DMetadataObject

Overrides:

getName in class X3DConcreteNode

Returns:

value of name field

setName

public final MetadataSet setName(String newValue)

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

Tooltip: Depending on the metadata vocabulary, the attribute name is usually required for metadata nodes.

• Warning: name field is not included if this instance is a USE node, in order to avoid potential mismatches.
• 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

Specified by:

setName in interface MetadataSet

Specified by:

setName in interface X3DMetadataObject

Parameters:

newValue - is new value for the name field.

Returns:

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setName

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

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

getReference

public String getReference()

Provide String value from inputOutput SFString field named reference.

Tooltip: Reference to the metadata standard or definition defining this particular metadata value. *

Specified by:

getReference in interface MetadataSet

Specified by:

getReference in interface X3DMetadataObject

Returns:

value of reference field

setReference

public MetadataSet setReference(String newValue)

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

Tooltip: Reference to the metadata standard or definition defining this particular metadata value. *

Specified by:

setReference in interface MetadataSet

Specified by:

setReference in interface X3DMetadataObject

Parameters:

newValue - is new value for the reference field.

Returns:

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setReference

public MetadataSet setReference(SFString newValue)

Assign typed object value to SFString reference field, similar to setReference(String).

Parameters:

newValue - is new value for the reference field.

Returns:

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

getValue

public X3DNode[] getValue()

Provide array of org.web3d.x3d.sai.Core.X3DMetadataObject results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field value.

Tooltip: [X3DNode] The value field provides a list of X3DMetadataObject nodes whose meaning is determined by the name field. *


Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DMetadataObject.

Specified by:

getValue in interface MetadataSet

Returns:

value of value field

See Also:

• X3DMetadataObject

getValueList

public ArrayList<X3DNode> getValueList()

Utility method to get ArrayList MFNode value field, similar to getValue().

Returns:

value of value field

setValue

public MetadataSet setValue(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field value.

Tooltip: [X3DNode] The value field provides a list of X3DMetadataObject nodes whose meaning is determined by the name field. *


Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DMetadataObject.

Specified by:

setValue in interface MetadataSet

Parameters:

newValue - is new value for the value field.

Returns:

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setValue

public MetadataSet setValue(ArrayList<X3DMetadataObject> newValue)

Assign ArrayList MFNode value field, similar to setValue(org.web3d.x3d.sai.Core.X3DNode[]).

Parameters:

newValue - is new value for the value field.

Returns:

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

addValue

public MetadataSet addValue(X3DNode newValue)

Add single child node to existing array of value nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DMetadataObject and ProtoInstance.

Parameters:

newValue - is new value to be appended the value field.

Returns:

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

addValue

public MetadataSet addValue(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for value field.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.

Parameters:

newValue - is new value to be appended the parts field.

Returns:

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

addValue

public void addValue(X3DNode[] newValue)

Add array of child value nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DMetadataObject.

Specified by:

addValue in interface MetadataSet

Parameters:

newValue - is new value array to be appended the value field.

setValue

public void setValue(X3DNode newValue)

Set single child value node, replacing prior array of existing nodes (if any). Warning: this method can only accept Metadata* nodes. Unable to return this object and pipeline methods since abstract SAI specifies void return type.

Specified by:

setValue in interface MetadataSet

Parameters:

newValue - is new node for the value field

See Also:

• stackoverflow: Can overridden methods differ in return type?

clearValue

public MetadataSet clearValue()

Utility method to clear MFNode value field.

Returns:

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

hasValue

public boolean hasValue()

Indicate whether an object is available for inputOutput MFNode field value.

Returns:

whether a properly typed node or ProtoInstance array or CommentsBlock is available.

See Also:

• getValue()

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

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setDEF

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

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

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setUSE

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

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

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setCssClass

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

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

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setHtmlID

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

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

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setCssStyle

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

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

setUSE

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

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

addComments

public MetadataSet addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public MetadataSet addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)