Package org.apache.sis.internal.storage.image

Class WorldFileStoreProvider

java.lang.Object

org.apache.sis.storage.DataStoreProvider

org.apache.sis.internal.storage.URIDataStore.Provider

org.apache.sis.internal.storage.PRJDataStore.Provider

org.apache.sis.internal.storage.image.WorldFileStoreProvider

public final class WorldFileStoreProvider
extends PRJDataStore.Provider

The provider of WorldFileStore instances.

Since:

1.2

Version:

1.2

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sis.storage.DataStoreProvider

DataStoreProvider.Prober<S>

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	allowSingleton	Whether the provider is allowed to create GridCoverageResource instances instead of Aggregate instances.
(package private) static final String	NAME	The format name.
private static final String[]	SINGLE_IMAGE_FORMATS	Name of image formats that are considered to allow only one image.

Fields inherited from class org.apache.sis.internal.storage.PRJDataStore.Provider

DEFAULT_CRS

Fields inherited from class org.apache.sis.internal.storage.URIDataStore.Provider

CREATE_PARAM, ENCODING, LOCATION_PARAM

Fields inherited from class org.apache.sis.storage.DataStoreProvider

CREATE, LOCATION

Constructor Summary

Constructors

Constructor	Description
WorldFileStoreProvider()	Creates a new provider.
WorldFileStoreProvider(boolean allowSingleton)	Creates a new provider with the given configuration.

Method Summary

Modifier and Type	Method	Description
String	getShortName()	Returns a generic name for this data store, used mostly in warnings or error messages.
WorldFileStore	open(StorageConnector connector)	Returns a WorldFileStore implementation associated with this provider.
ProbeResult	probeContent(StorageConnector connector)	Returns the MIME type if the image file is recognized by an Image I/O reader.

Methods inherited from class org.apache.sis.internal.storage.PRJDataStore.Provider

build, open

Methods inherited from class org.apache.sis.internal.storage.URIDataStore.Provider

connector, descriptor, getOpenParameters, isWritable

Methods inherited from class org.apache.sis.storage.DataStoreProvider

getFormat, getLogger, getSupportedVersions, probeContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

static final String NAME

The format name.

See Also:

• Constant Field Values

SINGLE_IMAGE_FORMATS

private static final String[] SINGLE_IMAGE_FORMATS

Name of image formats that are considered to allow only one image. There is no public Image I/O API giving this information, so we have to use a hard-coded list. All formats not in this list are assumed to allow more than one image.

Case of JPEG

The JPEG image reader implementation in standard JDK seems to count a number of images that can be anything. However, documentation on the web often describes the JPEG format as a container for a single image. It is not clear if we should include JPEG in this list or not.

allowSingleton

private final boolean allowSingleton

Whether the provider is allowed to create GridCoverageResource instances instead of Aggregate instances.

Constructor Details

WorldFileStoreProvider

public WorldFileStoreProvider()

Creates a new provider.

WorldFileStoreProvider

public WorldFileStoreProvider(boolean allowSingleton)

Creates a new provider with the given configuration. If allowSingleton is false, then this provider will unconditionally create WorldFileStore instances that implement the Aggregate interface, regardless if the image format allows many pictures or not.

Parameters:

allowSingleton - whether the provider is allowed to create GridCoverageResource instances instead of Aggregate instances.

Method Details

getShortName

public String getShortName()

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

Specified by:

getShortName in class DataStoreProvider

Returns:

a short name or abbreviation for the data format.

See Also:

• DataStoreProvider.getFormat()

open

public WorldFileStore open(StorageConnector connector)
                    throws DataStoreException

Returns a WorldFileStore implementation associated with this provider. The data store will be writable if StandardOpenOption.WRITE is provided, or if the storage is a writable object such as ImageOutputStream.

Specified by:

open in class DataStoreProvider

Parameters:

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

Returns:

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

Throws:

DataStoreException - if an error occurred while creating the data store instance.

See Also:

• DataStores.open(Object)

probeContent

public ProbeResult probeContent(StorageConnector connector)
                         throws DataStoreException

Returns the MIME type if the image file is recognized by an Image I/O reader. 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:

probeContent in class DataStoreProvider

Parameters:

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

Returns:

a supported status with the MIME type if the given storage seems to be readable as an image.

Throws:

DataStoreException - if an I/O error occurred.