Interface MetadataSet

All Superinterfaces:
X3DMetadataObject, X3DNode
All Known Implementing Classes:
MetadataSetObject

public interface MetadataSet
extends X3DNode, X3DMetadataObject
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: 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: 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 http://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).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: MetadataSet, X3D Tooltips: MetadataSet, X3D Scene Authoring Hints: Metadata
  • Method Summary

    Modifier and Type Method Description
    void addValue​(X3DNode[] newValue)
    Add array of child value nodes to array of existing nodes (if any).
    X3DMetadataObject getMetadata()
    Provide 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.
    X3DNode[] getValue()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field value.
    MetadataSet setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    MetadataSet setName​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named name.
    MetadataSet setReference​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named reference.
    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 X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field value.
  • Method Details

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      MetadataSet setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DNode
      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:
      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.
      Specified by:
      getName in interface X3DMetadataObject
      Returns:
      value of name field
    • setName

      MetadataSet setName​(java.lang.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.

      @see X3D Scene Authoring Hints: Naming Conventions
      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
    • 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 interface X3DMetadataObject
      Returns:
      value of reference field
    • setReference

      MetadataSet setReference​(java.lang.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 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
    • getValue

      X3DNode[] getValue()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field value.

      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DMetadataObject.
      Returns:
      value of value field
      See Also:
      X3DMetadataObject
    • setValue

      MetadataSet setValue​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field value.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DMetadataObject.
      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
    • addValue

      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.
      Parameters:
      newValue - is new value array to be appended the value field.
    • setValue

      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.
      Parameters:
      newValue - is new node for the value field