Interface GeoMetadata

All Superinterfaces:

X3DChildNode, X3DInfoNode, X3DNode, X3DUrlObject

All Known Implementing Classes:

GeoMetadata

public interface GeoMetadata
extends X3DInfoNode, X3DUrlObject

GeoMetadata includes a generic subset of metadata about the geographic data.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. GeoMetadata node tooltip: [X3DInfoNode] GeoMetadata includes a generic subset of metadata about the geographic data.

• Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
• Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
• Hint: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList' (X3Dv3). https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

• SAI Java Specification
• 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).
double	getAutoRefresh()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
double	getAutoRefreshTimeLimit()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
X3DNode[]	getData()	Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field data.
String	getDescription()	Provide String value from inputOutput SFString field named description.
boolean	getLoad()	Provide boolean value from inputOutput SFBool field named load.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
String[]	getSummary()	Provide array of String results from inputOutput MFString field named summary.
String[]	getUrl()	Provide array of String results from inputOutput MFString field named url.
GeoMetadata	setAutoRefresh(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
GeoMetadata	setAutoRefreshTimeLimit(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
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 org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field data.
GeoMetadata	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
GeoMetadata	setLoad(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named load.
GeoMetadata	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
GeoMetadata	setSummary(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named summary.
GeoMetadata	setUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named url.

Method Details

getAutoRefresh

double getAutoRefresh()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.

Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.

• Hint: if preceding file loading fails or load field is false, no refresh is performed.
• Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

getAutoRefresh in interface X3DUrlObject

Returns:

value of autoRefresh field

setAutoRefresh

GeoMetadata setAutoRefresh(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.

Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.

• Hint: if preceding file loading fails or load field is false, no refresh is performed.
• Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

setAutoRefresh in interface X3DUrlObject

Parameters:

newValue - is new value for the autoRefresh field.

Returns:

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

getAutoRefreshTimeLimit

double getAutoRefreshTimeLimit()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.

Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.

• Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

getAutoRefreshTimeLimit in interface X3DUrlObject

Returns:

value of autoRefreshTimeLimit field

setAutoRefreshTimeLimit

GeoMetadata setAutoRefreshTimeLimit(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.

Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.

• Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

setAutoRefreshTimeLimit in interface X3DUrlObject

Parameters:

newValue - is new value for the autoRefreshTimeLimit field.

Returns:

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

getData

X3DNode[] getData()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) 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 org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) 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

getDescription

String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• 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).

Specified by:

getDescription in interface X3DUrlObject

Returns:

value of description field

setDescription

GeoMetadata setDescription(String newValue)

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

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• 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).

Specified by:

setDescription in interface X3DUrlObject

Parameters:

newValue - is new value for the description field.

Returns:

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

getLoad

boolean getLoad()

Provide boolean value from inputOutput SFBool field named load.

Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.

• Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
• Hint: use a separate LoadSensor node to detect when loading is complete.

Specified by:

getLoad in interface X3DUrlObject

Returns:

value of load field

setLoad

GeoMetadata setLoad(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named load.

Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.

• Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
• Hint: use a separate LoadSensor node to detect when loading is complete.

Specified by:

setLoad in interface X3DUrlObject

Parameters:

newValue - is new value for the load field.

Returns:

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

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/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#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)

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/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#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

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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#t-keywordsandvaluesHint: there should always be an even (or zero) number of strings to match key-value paired strings.

Returns:

value of summary field

setSummary

GeoMetadata setSummary(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.

• Hint: example <GeoMetadata summary=' "title" "San Francisco, California USA" '/>.
• Hint: Table 25.5, GeoMetadata keywords and values https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#t-keywordsandvaluesHint: there should always be an even (or zero) number of strings to match key-value paired 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

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