Package gov.nasa.worldwind.data

Interface DataRasterReader

All Superinterfaces:

AVList

All Known Implementing Classes:

AbstractDataRasterReader, BILRasterReader, DDSRasterReader, DTEDRasterReader, GDALDataRasterReader, GeotiffRasterReader, ImageIORasterReader, RPFRasterReader

public interface DataRasterReader
extends AVList

Method Summary

Modifier and Type	Method	Description
boolean	canRead(java.lang.Object source, AVList params)	Indicates whether this reader can read a specified data source.
java.lang.String	getDescription()
java.lang.String[]	getSuffixes()
boolean	isElevationsRaster(java.lang.Object source, AVList params)	Indicates whether a data source is elevation data.
boolean	isImageryRaster(java.lang.Object source, AVList params)	Indicates whether a data source is imagery.
DataRaster[]	read(java.lang.Object source, AVList params)	Reads and returns the DataRaster instances from a data source.
AVList	readMetadata(java.lang.Object source, AVList params)	Reads and returns the metadata from a data source.

Methods inherited from interface gov.nasa.worldwind.avlist.AVList

addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getEntries, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues

Method Detail

getDescription

java.lang.String getDescription()

getSuffixes

java.lang.String[] getSuffixes()

canRead

boolean canRead(java.lang.Object source,
                AVList params)

Indicates whether this reader can read a specified data source. The source may be one of the following:

• File
• String
• InputStream
• URL

Parameters:

source - the source to examine.

params - parameters required by certain reader implementations. May be null for most readers.

Returns:

true if this reader can read the data source, otherwise false.

read

DataRaster[] read(java.lang.Object source,
                  AVList params)
           throws java.io.IOException

Reads and returns the DataRaster instances from a data source. The source may be one of the following: The source may be one of the following:

• File
• String
• InputStream
• URL

Parameters:

source - the source to read.

params - parameters required by certain reader implementations. May be null for most readers. If non-null, the metadata is added to this list, and the list reference is the return value of this method.

Returns:

the list of metadata read from the data source. The list is empty if the data source has no metadata.

Throws:

java.io.IOException - if an IO error occurs.

readMetadata

AVList readMetadata(java.lang.Object source,
                    AVList params)
             throws java.io.IOException

Reads and returns the metadata from a data source. The source may be one of the following:

• File
• String
• InputStream
• URL

TODO: Why would the caller specify parameters to this method?

Parameters:

source - the source to examine.

params - parameters required by certain reader implementations. May be null for most readers. If non-null, the metadata is added to this list, and the list reference is the return value of this method.

Returns:

the list of metadata read from the data source. The list is empty if the data source has no metadata.

Throws:

java.io.IOException - if an IO error occurs.

isImageryRaster

boolean isImageryRaster(java.lang.Object source,
                        AVList params)

Indicates whether a data source is imagery. TODO: Identify when parameters must be passed. The source may be one of the following:

• File
• String
• InputStream
• URL

Parameters:

source - the source to examine.

params - parameters required by certain reader implementations. May be null for most readers.

Returns:

true if the source is imagery, otherwise false.

isElevationsRaster

boolean isElevationsRaster(java.lang.Object source,
                           AVList params)

Indicates whether a data source is elevation data. TODO: Identify when parameters must be passed. The source may be one of the following:

• File
• String
• InputStream
• URL

Parameters:

source - the source to examine.

params - parameters required by certain reader implementations. May be null for most readers. TODO: Identify when parameters must be passed.

Returns:

true if the source is elevation data, otherwise false.