Class GDALStore

Object

DataStore

GDALStore

All Implemented Interfaces:

Auto­Closeable, Aggregate, Resource, Localized

public class GDALStore
extends DataStore
implements Aggregate

A data store using the GDAL library for all data accesses.

Since:

1.5

Nested Class Summary

Nested classes/interfaces inherited from interface Resource

Resource.File­Set

Field Summary

Fields inherited from class DataStore

listeners, provider

Constructor Summary

Constructors

Constructor	Description
GDALStore(GDALStore­Provider provider, Storage­Connector connector)	Creates a new data store for reading the file specified by the given connector.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this data store and releases any underlying resources.
Collection<? extends Resource>	components()	Returns the children resources of this aggregate.
Driver	get­Driver()	Returns the GDAL driver used for opening the file.
Optional<Resource.File­Set>	get­File­Set()	Returns an array of files believed to be part of this resource.
final Optional<Generic­Name>	get­Identifier()	Returns an identifier for the root resource of this data store, or an empty value if none.
Metadata	get­Metadata()	Returns information about the data store as a whole.
Optional<Parameter­Value­Group>	get­Open­Parameters()	Returns the parameters used for opening this GDAL data store.
final GDALStore­Provider	get­Provider()	Returns the factory that created this Data­Store instance.

Methods inherited from class DataStore

add­Listener, find­Resource, get­Display­Name, get­Locale, get­Native­Metadata, remove­Listener, set­Locale, to­String

Methods inherited from class Object

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

Methods inherited from interface Resource

add­Listener, remove­Listener

Constructor Details

GDALStore

public GDALStore(GDALStoreProvider provider,
 StorageConnector connector)
          throws DataStoreException

Creates a new data store for reading the file specified by the given connector. The provider argument is mandatory for this data store, because it provides the links to the GDAL library.

Parameters:

provider - the factory that created this GDALStore instance.

connector - information about the storage. Should be convertible to a URL.

Throws:

Data­Store­Exception - if an error occurred while creating the data store for the given storage.

Method Details

getProvider

public final GDALStoreProvider getProvider()

Returns the factory that created this Data­Store instance. The provider determines which GDAL library is used.

Overrides:

get­Provider in class Data­Store

Returns:

the factory that created this Data­Store instance.

See Also:

• Data­Store.provider

getDriver

public Driver getDriver()
                 throws DataStoreException

Returns the GDAL driver used for opening the file.

Returns:

the GDAL driver used for opening the file.

Throws:

Data­Store­Exception - if this data store is closed.

getOpenParameters

public Optional<ParameterValueGroup> getOpenParameters()

Returns the parameters used for opening this GDAL data store. The parameters are described by GDALStore­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 cannot be described by a URI.

Specified by:

get­Open­Parameters in class Data­Store

Returns:

parameters used for opening this data store.

See Also:

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

getFileSet

public Optional<Resource.FileSet> getFileSet()
                                      throws DataStoreException

Returns an array of files believed to be part of this resource.

Specified by:

get­File­Set in interface Resource

Returns:

files used by this resource, or an empty value if unknown.

Throws:

Data­Store­Exception - if the list of files cannot be obtained.

"TODO:"

This method is often used for copying a resources from one location to another. GDAL provides a GDALCopy­Dataset­Files function for this purpose. That function is not yet used by Apache SIS.

getIdentifier

public final Optional<GenericName> getIdentifier()
                                          throws DataStoreException

Returns an identifier for the root resource of this data store, or an empty value if none.

Specified by:

get­Identifier in interface Resource

Overrides:

get­Identifier in class Data­Store

Returns:

an identifier for the root resource of this data store.

Throws:

Data­Store­Exception - if an error occurred while fetching the identifier.

See Also:

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

getMetadata

public Metadata getMetadata()
                     throws DataStoreException

Returns information about the data store as a whole.

Specified by:

get­Metadata in interface Resource

Specified by:

get­Metadata in class Data­Store

Returns:

information about resources in the data store.

Throws:

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

See Also:

• Data­Store.get­Identifier()
• Default­Metadata.deep­Copy(Metadata)

components

public Collection<? extends Resource> components()
                                          throws DataStoreException

Returns the children resources of this aggregate.

Specified by:

components in interface Aggregate

Returns:

the resources that are contained in this aggregate.

Throws:

Data­Store­Exception - if an error occurred in a GDAL function.

close

public void close()
           throws DataStoreException

Closes this data store and releases any underlying resources. A

invalid reference

Close­Event

is sent to listeners before the data store is closed. Any attempt to use this store after closing will result in Data­Store­Closed­Exception.

Specified by:

close in interface Auto­Closeable

Specified by:

close in class Data­Store

Throws:

Data­Store­Exception - if an error occurred while closing this data store.

See Also:

• Store­Listeners.close()