NASA World Wind

gov.nasa.worldwind
Class WorldWind

java.lang.Object
  extended by gov.nasa.worldwind.WorldWind

public final class WorldWind
extends Object


Field Summary
static String SHUTDOWN_EVENT
           
 
Method Summary
static void addPropertyChangeListener(PropertyChangeListener listener)
           
static void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
           
static Object createComponent(String className)
           
static Object createComponentFromConfigurationFactory(String factoryClassKey, String[] keys)
          Creates a component using a specified Factory and one of several specified configuration mechanisms.
static Object createConfigurationComponent(String classNameKey)
           
static FileStore getDataFileStore()
           
static MemoryCache getMemoryCache(String key)
           
static MemoryCacheSet getMemoryCacheSet()
           
static NetworkStatus getNetworkStatus()
           
static RetrievalService getRetrievalService()
           
static SessionCache getSessionCache()
           
static String getStringValue(String key)
           
static TaskService getTaskService()
           
static Object getValue(String key)
           
static boolean hasKey(String key)
           
static boolean isOfflineMode()
          Indicates whether World Wind will attempt to connect to the network to retrieve data or for other reasons.
static void removeKey(String key)
           
static void removePropertyChangeListener(PropertyChangeListener listener)
           
static void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
           
static void setOfflineMode(boolean offlineMode)
          Indicate whether World Wind should attempt to connect to the network to retrieve data or for other reasons.
static void setValue(String key, String value)
           
static void shutDown()
          Reinitialize World Wind to its initial ready state.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SHUTDOWN_EVENT

public static final String SHUTDOWN_EVENT
See Also:
Constant Field Values
Method Detail

addPropertyChangeListener

public static void addPropertyChangeListener(PropertyChangeListener listener)

addPropertyChangeListener

public static void addPropertyChangeListener(String propertyName,
                                             PropertyChangeListener listener)

createComponent

public static Object createComponent(String className)
                              throws WWRuntimeException
Parameters:
className - the full name, including package names, of the component to create
Returns:
the new component
Throws:
WWRuntimeException - if the Object could not be created
IllegalArgumentException - if className is null or zero length

createComponentFromConfigurationFactory

public static Object createComponentFromConfigurationFactory(String factoryClassKey,
                                                             String[] keys)
Creates a component using a specified Factory and one of several specified configuration mechanisms. The factory determines which mechanism to use, but typically attempts the specified ones in the order specified until one is successful.

Parameters:
factoryClassKey - the key identifying the factory class name in Configuration.
keys - an array of keys identifying the mechanisms to use to create the component. See Factory.createFromKeys(String[]) for a list of common method keys.
Returns:
the requested component.
Throws:
IllegalArgumentException - if the factory key is null or the key array is null or empty.
WWRuntimeException - if none of the methods are successful.

createConfigurationComponent

public static Object createConfigurationComponent(String classNameKey)
                                           throws IllegalStateException,
                                                  IllegalArgumentException
Parameters:
classNameKey - the key identifying the component
Returns:
the new component
Throws:
IllegalStateException - if no name could be found which corresponds to classNameKey
IllegalArgumentException - if classNameKey is null
WWRuntimeException - if the component could not be created

getDataFileStore

public static FileStore getDataFileStore()

getMemoryCache

public static MemoryCache getMemoryCache(String key)

getMemoryCacheSet

public static MemoryCacheSet getMemoryCacheSet()

getNetworkStatus

public static NetworkStatus getNetworkStatus()

getRetrievalService

public static RetrievalService getRetrievalService()

getSessionCache

public static SessionCache getSessionCache()

getStringValue

public static String getStringValue(String key)

getTaskService

public static TaskService getTaskService()

getValue

public static Object getValue(String key)

hasKey

public static boolean hasKey(String key)

isOfflineMode

public static boolean isOfflineMode()
Indicates whether World Wind will attempt to connect to the network to retrieve data or for other reasons.

Returns:
true if World Wind is in off-line mode, false if not.
See Also:
NetworkStatus

removeKey

public static void removeKey(String key)

removePropertyChangeListener

public static void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public static void removePropertyChangeListener(String propertyName,
                                                PropertyChangeListener listener)

setOfflineMode

public static void setOfflineMode(boolean offlineMode)
Indicate whether World Wind should attempt to connect to the network to retrieve data or for other reasons. The default value for this attribute is false, indicating that the network should be used.

Parameters:
offlineMode - true if World Wind should use the network, false otherwise
See Also:
NetworkStatus

setValue

public static void setValue(String key,
                            String value)

shutDown

public static void shutDown()
Reinitialize World Wind to its initial ready state. Shut down and restart all World Wind services and clear all World Wind memory caches. Cache memory will be released at the next JVM garbage collection.

Call this method to reduce World Wind's current resource usage to its initial, empty state. This is typically required by applets when the user leaves the applet page.

The state of any open WorldWindow objects is indeterminate subsequent to invocation of this method. The core WorldWindow objects attempt to shut themselves down cleanly during the call, but their resulting window state is undefined.

World Wind can continue to be used after calling this method.


NASA World Wind