Package org.web3d.x3d.sai.Core
Interface MetadataString
- All Superinterfaces:
X3DMetadataObject
,X3DNode
- All Known Implementing Classes:
MetadataString
public interface MetadataString extends X3DNode, X3DMetadataObject
The metadata provided by this node is contained in the strings of the value field.
X3D node tooltip: [X3DNode,X3DMetadataObject] MetadataString contains a typed list of values providing metadata information about its parent node. Further information about this specific Metadata* node may be provided by a single child Metadata* node with containerField="metadata".
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: [X3DNode,X3DMetadataObject] MetadataString contains a typed list of values providing metadata information about its parent node. Further information about this specific Metadata* node may be provided by a single child Metadata* node with containerField="metadata".
- Hint: use containerField="value" if the parent node is MetadataSet.
- Hint: if a metadata node is needed as a top-level root node for the scene, first insert a parent WorldInfo (or WorldInfo/MetadataSet) to contain it.
- 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: 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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description X3DMetadataObject
getMetadata()
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.java.lang.String
getName()
Provide String value from inputOutput SFString field named name.java.lang.String
getReference()
Provide String value from inputOutput SFString field named reference.java.lang.String[]
getValue()
Provide array of String results from inputOutput MFString field named value.MetadataString
setMetadata(X3DMetadataObject newValue)
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.MetadataString
setName(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named name.MetadataString
setReference(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named reference.MetadataString
setValue(java.lang.String[] newValue)
Accessor method to assign String array to inputOutput MFString field named value.
-
Method Details
-
getMetadata
X3DMetadataObject getMetadata()Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
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-WD2/Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
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-WD2/Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
MetadataString
- 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
-
getName
java.lang.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 is not included if this instance is a USE node.
- 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 interfaceX3DMetadataObject
- Returns:
- value of name field
-
setName
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 is not included if this instance is a USE node.
- 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 interfaceX3DMetadataObject
- Parameters:
newValue
- is new value for the name field.- Returns:
MetadataString
- 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
-
getReference
java.lang.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 interfaceX3DMetadataObject
- Returns:
- value of reference field
-
setReference
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 interfaceX3DMetadataObject
- Parameters:
newValue
- is new value for the reference field.- Returns:
MetadataString
- 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
-
getValue
java.lang.String[] getValue()Provide array of String results from inputOutput MFString field named value.
Tooltip: The value attribute is a strictly typed data array providing relevant metadata information.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Returns:
- value of value field
-
setValue
Accessor method to assign String array to inputOutput MFString field named value.
Tooltip: The value attribute is a strictly typed data array providing relevant metadata information.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Parameters:
newValue
- is new value for the value field.- Returns:
MetadataString
- 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
-