Class GeoHeifStoreProvider

Object

DataStoreProvider

GeoHeifStoreProvider

public class GeoHeifStoreProvider
extends DataStoreProvider

The provider of Geo­Heif­Store instances. Given a Storage­Connector input, this class tries to instantiate a Geo­Heif­Store.

Nested Class Summary

Nested classes/interfaces inherited from class DataStoreProvider

Data­Store­Provider.Prober<S>

Modifier and Type	Class	Description
protected static interface	Data­Store­Provider.Prober<S>	An action to execute for testing if a Storage­Connector input can be read.

Field Summary

Fields inherited from class DataStoreProvider

CREATE, LOCATION

Modifier and Type	Field	Description
static final String	CREATE	Name of the parameter that specifies whether to allow creation of a new Data­Store if none exist at the given location.
static final String	LOCATION	Name of the parameter that specifies the data store location.

Constructor Summary

Constructors

Constructor	Description
Geo­Heif­Store­Provider()	Creates a new provider.

Method Summary

Modifier and Type	Method	Description
Parameter­Descriptor­Group	get­Open­Parameters()	Returns a description of all parameters accepted by this provider for opening a GeoHEIF file.
String	get­Short­Name()	Returns a generic name for this data store, used mostly in warnings or error messages.
Data­Store	open(Storage­Connector connector)	Creates a Geo­Heif­Store instance associated with this provider.
Probe­Result	probe­Content(Storage­Connector connector)	Returns the MIME type if the given storage appears to be supported by Geo­Heif­Store.

Methods inherited from class DataStoreProvider

get­Format, get­Logger, get­Supported­Versions, open, probe­Content

Modifier and Type	Method	Description
Format	get­Format()	Returns a description of the data format.
Logger	get­Logger()	Returns the logger where to report warnings or loading operations.
Range<Version>	get­Supported­Versions()	Returns the range of versions supported by the data store, or null if unspecified.
Data­Store	open(Parameter­Value­Group parameters)	Creates a data store instance associated with this provider for the given parameters.
protected <S> Probe­Result	probe­Content(Storage­Connector connector, Class<S> type, Data­Store­Provider.Prober<? super S> prober)	Applies the specified test on the storage content without modifying buffer or input stream position.

Methods inherited from class Object

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

Constructor Details

GeoHeifStoreProvider

public GeoHeifStoreProvider()

Creates a new provider.

Method Details

getShortName

public String getShortName()

Returns a generic name for this data store, used mostly in warnings or error messages.

Specified by:

get­Short­Name in class Data­Store­Provider

Returns:

a short name or abbreviation for the data format.

See Also:

• Data­Store­Provider.get­Format()

getOpenParameters

public ParameterDescriptorGroup getOpenParameters()

Returns a description of all parameters accepted by this provider for opening a GeoHEIF file.

Specified by:

get­Open­Parameters in class Data­Store­Provider

Returns:

description of available parameters for opening a GeoHEIF file.

See Also:

• Data­Store­Provider.LOCATION
• Data­Store­Provider.CREATE
• Data­Store­Provider.open(Parameter­Value­Group)
• Data­Store.get­Open­Parameters()

probeContent

public ProbeResult probeContent(StorageConnector connector)
                         throws DataStoreException

Returns the MIME type if the given storage appears to be supported by Geo­Heif­Store. A supported status does not guarantee that reading or writing will succeed, only that there appears to be a reasonable chance of success based on a brief inspection of the file header.

Specified by:

probe­Content in class Data­Store­Provider

Parameters:

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

Returns:

a supported status with the MIME type if the given storage seems to be readable by Geo­Heif­Store instances.

Throws:

Data­Store­Exception - if an I/O error occurred.

open

public DataStore open(StorageConnector connector)
               throws DataStoreException

Creates a Geo­Heif­Store instance associated with this provider.

Specified by:

open in class Data­Store­Provider

Parameters:

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

Returns:

a data store instance associated with this provider for the given storage.

Throws:

Data­Store­Exception - if an error occurred while creating the data store instance.

See Also:

• Data­Stores.open(Object)