Class GeoHeifStore

Object

DataStore

GeoHeifStore

All Implemented Interfaces:

Auto­Closeable, Aggregate, Resource, Localized

public class GeoHeifStore
extends DataStore
implements Aggregate

A data store backed by GeoHEIF files.

Nested Class Summary

Nested classes/interfaces inherited from interface Resource

Resource.File­Set

Modifier and Type	Interface	Description
static class	Resource.File­Set	Paths to the files potentially used by the enclosing resource.

Field Summary

Fields inherited from class DataStore

listeners, provider

Modifier and Type	Field	Description
protected final Store­Listeners	listeners	The set of registered Store­Listeners for this data store.
protected final Data­Store­Provider	provider	The factory that created this Data­Store instance, or null if unspecified.

Constructor Summary

Constructors

Constructor	Description
Geo­Heif­Store(Data­Store­Provider provider, Storage­Connector connector)	Creates a new GeoHEIF store from the given file, URL or stream object.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this GeoHEIF store and releases any underlying resources.
Collection<? extends Resource>	components()	Returns the children resources of this aggregate.
Optional<Resource.File­Set>	get­File­Set()	Returns the paths to the files used by this GeoHEIF store.
Optional<Generic­Name>	get­Identifier()	Returns an identifier constructed from the name of the HEIF file.
Metadata	get­Metadata()	Returns information about the dataset as a whole.
Optional<Tree­Table>	get­Native­Metadata()	Returns HEIF boxes and their fields as a tree for debugging purpose.
Optional<Parameter­Value­Group>	get­Open­Parameters()	Returns the parameters used to open this GeoHEIF data store.

Methods inherited from class DataStore

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

Modifier and Type	Method	Description
<T extends Store­Event> void	add­Listener(Class<T> event­Type, Store­Listener<? super T> listener)	Registers a listener to notify when the specified kind of event occurs in this data store or in a resource.
Resource	find­Resource(String identifier)	Searches for a resource identified by the given identifier.
String	get­Display­Name()	Returns a short name or label for this data store.
Locale	get­Locale()	The locale to use for formatting warnings and other messages.
Data­Store­Provider	get­Provider()	Returns the factory that created this Data­Store instance.
<T extends Store­Event> void	remove­Listener(Class<T> event­Type, Store­Listener<? super T> listener)	Unregisters a listener previously added to this data store for the given type of events.
void	set­Locale(Locale locale)	Sets the locale to use for formatting warnings and other messages.
String	to­String()	Returns a string representation of this data store for debugging purpose.

Methods inherited from class Object

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

Constructor Details

GeoHeifStore

public GeoHeifStore(DataStoreProvider provider,
 StorageConnector connector)
             throws DataStoreException

Creates a new GeoHEIF store from the given file, URL or stream object. 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, etc).

Throws:

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

Method Details

getOpenParameters

public Optional<ParameterValueGroup> getOpenParameters()

Returns the parameters used to open this GeoHEIF data store. The parameters are described by Geo­Heif­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 cannot be described by a URI (for example a GeoHEIF 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.

See Also:

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

getFileSet

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

Returns the paths to the files used by this GeoHEIF store.

Specified by:

get­File­Set in interface Resource

Returns:

files used by this GeoHEIF store.

Throws:

Data­Store­Exception - if an error occurred while preparing the set of files.

getIdentifier

public Optional<GenericName> getIdentifier()
                                    throws DataStoreException

Returns an identifier constructed from the name of the HEIF file. An identifier is available only if the storage input specified at construction time was something convertible to URI, for example an URL, File or Path.

Specified by:

get­Identifier in interface Resource

Overrides:

get­Identifier in class Data­Store

Returns:

the identifier derived from the filename.

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 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 data.

See Also:

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

getNativeMetadata

public Optional<TreeTable> getNativeMetadata()
                                      throws DataStoreException

Returns HEIF boxes and their fields as a tree for debugging purpose. The boxes appear in the order they are declared in the file. Only the boxes and fields recognized by this HEIF store implementation are shown. The table contains the following columns:

• invalid reference

  TableColumn#NAME

• invalid reference

  TableColumn#VALUE

• invalid reference

  TableColumn#VALUE_AS_TEXT

Usage and performance note

This method should not be invoked during normal operations. The standard metadata are preferred because they allow abstraction of data format details. Native metadata should be used only when an information does not appear in standard metadata, or for debugging purposes.

Since this method should not be invoked in normal operations, it has not been tuned for performance. Invoking this method may cause a lot of seek operations.

Overrides:

get­Native­Metadata in class Data­Store

Returns:

resources information structured in an implementation-specific way.

Throws:

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

"TODO:"

It is sometime possible, through the tree cell values, to modify the content of internal arrays. This is unsafe, we should makes this implementation safer before this module is released.

components

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

Returns the children resources of this aggregate.

Specified by:

components in interface Aggregate

Returns:

all children resources that are components of this aggregate.

Throws:

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

close

public void close()
           throws DataStoreException

Closes this GeoHEIF store and releases any underlying resources. This method can be invoked asynchronously for interrupting a long reading process.

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 GeoHEIF file.

See Also:

• Store­Listeners.close()