gov.nasa.worldwind.retrieve
Interface BulkRetrievable

All Known Implementing Classes:

BasicElevationModel, BasicTiledImageLayer, BMNGWMSLayer, CountryBoundariesLayer, LandsatI3WMSLayer, LocalRasterServerElevationModel, LocalRasterServerLayer, MSVirtualEarthLayer, NASAWFSPlaceNameLayer, PlaceNameLayer, ScankortDenmarkImageLayer, USDANAIPWMSImageLayer, USGSDigitalOrtho, USGSTopoHighRes, USGSTopoLowRes, USGSTopoMedRes, USGSUrbanAreaOrtho, WMSBasicElevationModel, WMSTiledImageLayer

public interface BulkRetrievable

Interface for classes whose data may be retrieved in bulk from its remote source. When used, will copy the requested data to either the local World Wind cache or a specified filestore. Data already contained in the specified location is not recopied.

Method Summary

long	getEstimatedMissingDataSize(Sector sector, double resolution) Estimates the amount of data, in bytes, that must be retrieved to the World Wind data cache for a specified sector and resolution.
long	getEstimatedMissingDataSize(Sector sector, double resolution, FileStore fileStore) Estimates the amount of data, in bytes, that must be retrieved to a specified filestore for a specified sector and resolution.
String	getName()
BulkRetrievalThread	makeLocal(Sector sector, double resolution, BulkRetrievalListener listener) Initiates data retrieval to the current World Wind data cache.
BulkRetrievalThread	makeLocal(Sector sector, double resolution, FileStore fileStore, BulkRetrievalListener listener) Initiates data retrieval to a specified filestore.

Method Detail

getEstimatedMissingDataSize

long getEstimatedMissingDataSize(Sector sector,
                                 double resolution)

Estimates the amount of data, in bytes, that must be retrieved to the World Wind data cache for a specified sector and resolution.

Parameters:

sector - the sector for which to retrieve the data.

resolution - the resolution desired. All data within the specified sector up to and including this resolution is downloaded.

Returns:

the estimated data size, in bytes.

getEstimatedMissingDataSize

long getEstimatedMissingDataSize(Sector sector,
                                 double resolution,
                                 FileStore fileStore)

Estimates the amount of data, in bytes, that must be retrieved to a specified filestore for a specified sector and resolution.

Parameters:

sector - the sector for which to retrieve the data.

resolution - the resolution desired. All data within the specified sector up to and including this resolution is downloaded.

fileStore - the location to place the data. If null, the current World Wind cache is used.

Returns:

the estimated data size, in bytes.

getName

String getName()

makeLocal

BulkRetrievalThread makeLocal(Sector sector,
                              double resolution,
                              BulkRetrievalListener listener)

Initiates data retrieval to the current World Wind data cache. The method starts a new thread to perform the retrieval. The thread terminates when either all the requested data has been retrieved or when any data not retrieved is determined to be unretrievable.

Parameters:

sector - the sector for which to retrieve the data.

resolution - the resolution desired. All data within the specified sector up to and including this resolution is downloaded.

listener - an optional bulk-download listener that can be used to monitor the success or failure of individual retrievals. Note: The listener is called on the thread performing the download, which is not the event dispatch thread. Therefore any interaction with AWT or Swing within the call must be done within a call to SwingUtilities.invokeLater().

Returns:

returns the running thread created to perform the retrieval.

makeLocal

BulkRetrievalThread makeLocal(Sector sector,
                              double resolution,
                              FileStore fileStore,
                              BulkRetrievalListener listener)

Initiates data retrieval to a specified filestore. The method starts a new thread to perform the retrieval. The thread terminates when either all the requested data has been retrieved or when any data not retrieved is determined to be unretrievable.

Parameters:

sector - the sector for which to retrieve the data.

resolution - the resolution desired. All data within the specified sector up to and including this resolution is downloaded.

listener - an optional bulk-download listener that can be used to monitor the success or failure of individual retrievals. Note: The listener is called on the thread performing the download, which is not the event dispatch thread. Therefore any interaction with AWT or Swing within the call must be done within a call to SwingUtilities.invokeLater().

fileStore - the location to place the data. If null, the current World Wind cache is used.

Returns:

returns the running thread created to perform the retrieval.