DataConfiguration (NASA World Wind)

Overview

Package

Class

Use

Tree

Index

Help

NASA World Wind

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gov.nasa.worldwind
Interface DataConfiguration

All Known Implementing Classes:: BasicDataConfiguration, CapabilitiesConfiguration, ElevationModelConfiguration, LayerConfiguration

public interface DataConfiguration

An interface to heirarchical properties which describe the data for a particular component, or set of components.

The parameter name property accepted by the getter methods denotes an abstract configuration path, which is evaluated according to the specified type. This configuration's values and its children's values are evaluated in this path. However a null path indicates that only this configuration is evaluated.

Method Summary

Boolean getBoolean(String paramName)
          Returns the Boolean value identified by a specified parameter name.

DataConfiguration getChild(String paramName)
          Returns the child configuration with a specified name.

DataConfiguration[] getChildren(String paramName)
          Returns an array of child configurations with a specified name.

Double getDouble(String paramName)
          Returns the Double value identified by a specified parameter name.

Integer getInteger(String paramName)
          Returns the Integer value identified by a specified parameter name.

LatLon getLatLon(String paramName)
          Returns the LatLon value identified by a specified parameter name.

Long getLong(String paramName)
          Returns the Long value identified by a specified parameter name.

String getName()
          Returns the name of this configuration information.

Sector getSector(String paramName)
          Returns the Sector value identified by a specified parameter name.

LevelSet.SectorResolution getSectorResolutionLimit(String paramName)
          Returns the LevelSet.SectorResolution value identified by a specified parameter name.

Object getSource()
          Returns the backing source of configuration information.

String getString(String paramName)
          Returns the String value identified by a specified parameter name.

String[] getStringArray(String paramName)
          Returns all String values identified by a specified parameter name.

Long getTimeInMillis(String paramName)
          Returns the time value in milliseconds identified by a specified parameter name.

String getType()
          Returns the type of this configuration information.

String[] getUniqueStrings(String paramName)
          Returns all unique String values identified by a specified parameter name.

String getVersion()
          Returns the version of this configuration information, or null if no version exists.

Method Detail

getBoolean

Boolean getBoolean(String paramName)

Returns the Boolean value identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: Boolean value of a parameter with the specified name. Returns null if no parameter exists with the specified name.

getChild

DataConfiguration getChild(String paramName)

Returns the child configuration with a specified name.

Parameters:: paramName - name of the child configuration.
Returns:: a child configuration, or null if none exists.
Throws:: IllegalArgumentException - if the parameter name is null.

getChildren

DataConfiguration[] getChildren(String paramName)

Returns an array of child configurations with a specified name.

Parameters:: paramName - name of the child configurations.
Returns:: an array of child configurations, or null if none exists.
Throws:: IllegalArgumentException - if the parameter name is null.

getDouble

Double getDouble(String paramName)

Returns the Double value identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: Double value of a parameter with the specified name. Returns null if no parameter exists with the specified name.

getInteger

Integer getInteger(String paramName)

Returns the Integer value identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: Integer value of a parameter with the specified name. Returns null if no parameter exists with the specified name.

getLatLon

LatLon getLatLon(String paramName)

Returns the LatLon value identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: LatLon value of a parameter with the specified name. Returns null if no parameter exists with the specified name.

getLong

Long getLong(String paramName)

Returns the Long value identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: Long value of a parameter with the specified name. Returns null if no parameter exists with the specified name.

getName

String getName()

Returns the name of this configuration information. This value is likely a simple title for the component this configuration information describes.

Returns:: a String title for the described component.

getSector

Sector getSector(String paramName)

Returns the Sector value identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: Sector value of a parameter with the specified name. Returns null if no parameter exists with the specified name.

getSectorResolutionLimit

LevelSet.SectorResolution getSectorResolutionLimit(String paramName)

Returns the LevelSet.SectorResolution value identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: LevelSet.SectorResolution value of a parameter with the specified name. Returns null if no parameter exists with the specified name.

getSource

Object getSource()

Returns the backing source of configuration information. Implementations are potentially backed by any source types. For example, if this configuration information is backed by an XML document object model (DOM), this likely returns a DOM Element reference.

Returns:: the backing configuration source.

getString

String getString(String paramName)

Returns the String value identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: String value of a parameter with the specified name. Returns null if no parameter exists with the specified name.

getStringArray

String[] getStringArray(String paramName)

Returns all String values identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: an array containing the value of each parameter matching the specified name. Returns null if no parameters exist with the specified name.

getTimeInMillis

Long getTimeInMillis(String paramName)

Returns the time value in milliseconds identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: time in milliseconds of a parameter with the specified name. Returns null if no parameter exists with the specified name.

getType

String getType()

Returns the type of this configuration information. For example, if this is a Layer configuration this returns "Layer", and if this describes an ElevationModel configuration this returns "ElevationModel".

Returns:: the type of configuration information.

getUniqueStrings

String[] getUniqueStrings(String paramName)

Returns all unique String values identified by a specified parameter name.

Parameters:: paramName - the parameter name.
Returns:: an array containing the value of each parameter matching the specified name, and containing a unique value. Returns null if no parameters exist with the specified name.

getVersion

String getVersion()

Returns the version of this configuration information, or null if no version exists.

Returns:: the configuration version, or null if none exists.