GeoMetadata (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DInfoNode, X3DNode, X3DUrlObject

All Known Implementing Classes:

GeoMetadataObject
```
public interface GeoMetadata
extends X3DInfoNode, X3DUrlObject
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DInfoNode] GeoMetadata includes a generic subset of metadata about the geographic data.
- Hint: X3D for Advanced Modeling (X3D4AM) slideset
  http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
- Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
- Hint: apply containerField='watchList' when parent node is LoadSensor.
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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.
`GeoMetadata`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`void`	`setData(X3DNode newValue)` Set single child data node, replacing prior array of existing nodes (if any).
`GeoMetadata`	`setData(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field data.
`GeoMetadata`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`GeoMetadata`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`GeoMetadata`	`setSummary(java.lang.String[] newValue)` Assign String array to inputOutput MFString field named summary.
`GeoMetadata`	`setUrl(java.lang.String[] newValue)` Assign String array to inputOutput MFString field named url.
`GeoMetadata`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    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.
    
    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)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    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.
    - Hint: example <GeoMetadata summary=' "title" "San Francisco, California USA" '/>.
    - Hint: Table 25.5, GeoMetadata keywords and values
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#t-keywordsandvaluesHint: there should always be an even (or zero) number of strings to match key-value pairs.
    Returns:
    
    value of summary field
  - setSummary
```
GeoMetadata setSummary(java.lang.String[] newValue)
```
    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. Hint: example <GeoMetadata summary=' "title" "San Francisco, California USA" '/>. Hint: Table 25.5, GeoMetadata keywords and values http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#t-keywordsandvaluesHint: there should always be an even (or zero) number of strings to match key-value pairs.
    
    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
      "http://www.web3d.org"
      "http://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
      http://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)
```
    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 "http://www.web3d.org" "http://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 http://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).
  - setDEF
```
GeoMetadata setDEF(java.lang.String newValue)
```
    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 http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DInfoNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    GeoMetadata - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
GeoMetadata setUSE(java.lang.String newValue)
```
    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 interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DInfoNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    GeoMetadata - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
GeoMetadata setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DInfoNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    GeoMetadata - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface GeoMetadata

Method Summary

Method Detail

getData

setData

addData

setData

getMetadata

setMetadata

getSummary

setSummary

getUrl

setUrl

setDEF

setUSE

setCssClass