Package org.web3d.x3d.sai.Geospatial

Interface GeoMetadata

All Superinterfaces:
X3DChildNode, X3DInfoNode, X3DNode, X3DUrlObject
All Known Implementing Classes:
GeoMetadataObject
public interface GeoMetadata
extends X3DInfoNode, X3DUrlObject
GeoMetadata includes a generic subset of metadata about the geographic data.

X3D node tooltip: [X3DInfoNode] GeoMetadata includes a generic subset of metadata about the geographic data.
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: GeoMetadata, X3D Tooltips: GeoMetadata, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    void addData​(X3DNode[] newValue)
    Add array of child data nodes to array of existing nodes (if any).
    X3DNode[] getData()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field data.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    java.lang.String[] getSummary()
    Provide array of String results from inputOutput MFString field named summary.
    java.lang.String[] getUrl()
    Provide array of String results from inputOutput MFString field named url.
    void setData​(X3DNode newValue)
    Set single child data node, replacing prior array of existing nodes (if any).
    GeoMetadata setData​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field data.
    GeoMetadata setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    GeoMetadata setSummary​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named summary.
    GeoMetadata setUrl​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named url.

  • Method Details

    • getData

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

      Tooltip: DEF list of all nodes that implement this data. If no specific geospatial nodes are identified, then this GeoMetadata node pertains to entire scene. *


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

    • setData

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

      Tooltip: DEF list of all nodes that implement this data. If no specific geospatial nodes are identified, then this GeoMetadata node pertains to entire scene. *


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode.
      Parameters:
      newValue - is new value for the data field.
      Returns:
      GeoMetadata - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addData

      void addData​(X3DNode[] newValue)
      Add array of child data nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode.
      Parameters:
      newValue - is new value array to be appended the data field.

    • setData

      void setData​(X3DNode newValue)
      Set single child data node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the data field

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide 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.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DInfoNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      GeoMetadata setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign 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.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DInfoNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoMetadata - 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

    • getSummary

      java.lang.String[] getSummary()
      Provide array of String results from inputOutput MFString field named summary.

      Tooltip: The summary string array contains a set of keyword/value pairs, with each keyword and its subsequent value contained in separate strings.
      Returns:
      value of summary field

    • setSummary

      GeoMetadata setSummary​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named summary.

      Tooltip: The summary string array contains a set of keyword/value pairs, with each keyword and its subsequent value contained in separate strings.
      Parameters:
      newValue - is new value for the summary field.
      Returns:
      GeoMetadata - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUrl

      java.lang.String[] getUrl()
      Provide array of String results from inputOutput MFString field named url.

      Tooltip: Hypertext link to an external, complete metadata description.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Specified by:
      getUrl in interface X3DUrlObject
      Returns:
      value of url field

    • setUrl

      GeoMetadata setUrl​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named url.

      Tooltip: Hypertext link to an external, complete metadata description.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Specified by:
      setUrl in interface X3DUrlObject
      Parameters:
      newValue - is new value for the url field.
      Returns:
      GeoMetadata - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).