Package org.apache.sis.storage.earthobservation

Class LandsatStore

Object

DataStore

LandsatStore

All Implemented Interfaces:

Auto­Closeable, Resource, Localized

public class LandsatStore
extends DataStore

Parses Landsat metadata as ISO 19115 Metadata object. Landsat data are distributed as a collection of TIFF files, together with a single text file like below:

GROUP = L1_METADATA_FILE
  GROUP = METADATA_FILE_INFO
    ORIGIN = "Image courtesy of the U.S. Geological Survey"
    REQUEST_ID = "0501403126384_00011"
    LANDSAT_SCENE_ID = "LC81230522014071LGN00"
    FILE_DATE = 2014-03-12T06:06:35Z
    STATION_ID = "LGN"
    PROCESSING_SOFTWARE_VERSION = "LPGS_2.3.0"
  END_GROUP = METADATA_FILE_INFO
  GROUP = PRODUCT_METADATA
    DATA_TYPE = "L1T"
    ELEVATION_SOURCE = "GLS2000"
    OUTPUT_FORMAT = "GEOTIFF"
    SPACECRAFT_ID = "LANDSAT_8"
    SENSOR_ID = "OLI_TIRS"
    etc...

This class reads the content from the given input until the first occurrence of the END keyword. Lines beginning with the # character (ignoring spaces) are treated as comment lines and ignored.

Since:

0.8

Defined in the sis-earth-observation module

Field Summary

Fields inherited from class DataStore

listeners, provider

Constructor Summary

Constructors

Constructor	Description
LandsatStore(LandsatStoreProvider provider, StorageConnector connector)	Creates a new Landsat store from the given file, URL, stream or character reader.

Method Summary

Modifier and Type	Method	Description
<T extends StoreEvent> void	addListener(Class<T> eventType, StoreListener<? super T> listener)	Registers a listener to notify when the specified kind of event occurs in this data store.
void	close()	Closes this Landsat store and releases any underlying resources.
Optional<GenericName>	getIdentifier()	Returns the value associated to LANDSAT_SCENE_ID in the Landsat metadata file.
Metadata	getMetadata()	Returns information about the dataset as a whole.
Optional<ParameterValueGroup>	getOpenParameters()	Returns the parameters used to open this Landsat data store.

Methods inherited from class DataStore

add­Warning­Listener, find­Resource, get­Display­Name, get­Locale, get­Provider, remove­Listener, remove­Warning­Listener, set­Locale, to­String

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

Constructor Detail

LandsatStore

public LandsatStore(LandsatStoreProvider provider,
                    StorageConnector connector)
             throws DataStoreException

Creates a new Landsat store from the given file, URL, stream or character reader. This constructor invokes Storage­Connector.close­All­Except(Object), keeping open only the needed resource.

Parameters:

provider - the factory that created this Data­Store instance, or null if unspecified.

connector - information about the storage (URL, stream, reader instance, etc).

Throws:

Data­Store­Exception - if an error occurred while opening the Landsat file.

Method Detail

getOpenParameters

public Optional<ParameterValueGroup> getOpenParameters()

Returns the parameters used to open this Landsat data store. The parameters are described by Landsat­Store­Provider.get­Open­Parameters() and contains at least a parameter named "location" with a URI value. The return value may be empty if the storage input can not be described by a URI (for example a Landsat file reading directly from a Readable­Byte­Channel).

Specified by:

get­Open­Parameters in class Data­Store

Returns:

parameters used for opening this data store.

Since:

0.8

See Also:

Data­Store­Provider.get­Open­Parameters()

getIdentifier

public Optional<GenericName> getIdentifier()
                                    throws DataStoreException

Returns the value associated to LANDSAT_SCENE_ID in the Landsat metadata file. This value is fetched from get­Metadata()/identification­Info/citation/identifier.

Specified by:

get­Identifier in interface Resource

Overrides:

get­Identifier in class Data­Store

Returns:

the identifier fetched from metadata, or null if none.

Throws:

Data­Store­Exception - if an error occurred while reading the metadata.

Since:

1.0

See Also:

Data­Store.get­Metadata(), Data­Store.get­Display­Name()

getMetadata

public Metadata getMetadata()
                     throws DataStoreException

Returns information about the dataset as a whole. The returned metadata object can contain information such as the spatiotemporal extent of the dataset, contact information about the creator or distributor, data quality, usage constraints and more.

Specified by:

get­Metadata in interface Resource

Specified by:

get­Metadata in class Data­Store

Returns:

information about the dataset.

Throws:

Data­Store­Exception - if an error occurred while reading the metadata.

See Also:

Data­Store.get­Identifier()

addListener

public <T extends StoreEvent> void addListener(Class<T> eventType,
                                               StoreListener<? super T> listener)

Registers a listener to notify when the specified kind of event occurs in this data store. The current implementation of this data store can emit only Warning­Events; any listener specified for another kind of events will be ignored.

Specified by:

add­Listener in interface Resource

Overrides:

add­Listener in class Data­Store

Type Parameters:

T - compile-time value of the event­Type argument.

Parameters:

event­Type - type of Store­Event to listen (can not be null).

listener - listener to notify about events.

close

public void close()
           throws DataStoreException

Closes this Landsat store and releases any underlying resources.

Specified by:

close in interface Auto­Closeable

Specified by:

close in class Data­Store

Throws:

Data­Store­Exception - if an error occurred while closing the Landsat file.