com.luciad.fusion.tilestore

LuciadLightspeedClass TLfnFileSystemTileStore

java.lang.Object

com.luciad.fusion.tilestore.ALfnTileStore

com.luciad.fusion.tilestore.TLfnFileSystemTileStore

All Implemented Interfaces:

ILfnResourceMetadataResolver, Closeable, AutoCloseable

public class TLfnFileSystemTileStore
extends ALfnTileStore

The main entry point for accessing a Luciad TileStore directly on the file system. All Tile Store operations are supported, except for TLfnTileStoreOperation.IMPORT_COVERAGE_OPERATION.

This class is thread-safe.

Since:

10.0

See Also:

ALfnTileStore

Nested Class Summary

Nested classes/interfaces inherited from class com.luciad.fusion.tilestore.ALfnTileStore

ALfnTileStore.CommitPolicy, ALfnTileStore.ReadResult, ALfnTileStore.Result, ALfnTileStore.WriteResult

Constructor Summary

Constructors

Constructor and Description
TLfnFileSystemTileStore(File aHome, boolean aCreate, ALfnEnvironment aEnvironment) Opens a Tile Store on the file system, optionally creating it first.
TLfnFileSystemTileStore(File aHome, boolean aCreate, ALfnEnvironment aEnvironment, ALfnBinaryMetadataStore aAssetStore, ALfnBinaryMetadataStore aCoverageStore, ALfnBinaryMetadataStore aThemeStore) Opens a Tile Store on the file system, optionally creating it first.
TLfnFileSystemTileStore(File aHome, boolean aCreate, ALfnEnvironment aEnvironment, ALfnTileStore.CommitPolicy aCommitPolicy) Opens a Tile Store on the file system, optionally creating it first.
TLfnFileSystemTileStore(File aHome, boolean aCreate, ALfnEnvironment aEnvironment, ALfnTileStore.CommitPolicy aCommitPolicy, ALfnBinaryMetadataStore aAssetStore, ALfnBinaryMetadataStore aCoverageStore, ALfnBinaryMetadataStore aThemeStore) Opens a Tile Store on the file system, optionally creating it first.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this Tile Store instance.
boolean	deleteResource(String aID) Deletes both the data and metadata of a resource.
Future<ALfnTileStore.WriteResult>	deleteUserData(String aKey, ILfnCallback<ALfnTileStore.WriteResult> aCallback) Deletes binary user data from this Tile Store with a given key.
ALfnAsset	getAsset(String aID) Gets an asset from the Tile Store.
TLfnTileStoreCapabilities	getCapabilities() Gets the capabilities offered by the Tile Store.
ALfnCoverage	getCoverage(String aID) Gets a coverage from the Tile Store.
List<String>	getCoverageIds() Gets the IDs of all this Tile Store's coverage metadatas.
File	getHome() Gets the home dir of this Tile Store.
<T extends ALfnResourceMetadata> T	getResourceMetadata(String aID) Gets the metadata of a resource.
ALfnTheme	getTheme(String aID) Gets a theme from the Tile Store.
URI	getURI() Gets the Tile Store home as a URI.
Future<ALfnTileStore.ReadResult>	getUserData(String aKey, WritableByteChannel aSink, ILfnCallback<ALfnTileStore.ReadResult> aCallback) Gets binary user data from this Tile Store with a given key.
void	putMetadata(TLfnTileStoreMetadata aTileStoreMetadata) Updates the metadata of this Tile Store.
<T extends ALfnResourceMetadata> T	putResourceMetadata(T aMetadata) Adds or updates the metadata of a resource.
Future<ALfnTileStore.WriteResult>	putUserData(String aKey, ReadableByteChannel aSource, ILfnCallback<ALfnTileStore.WriteResult> aCallback) Puts binary user data in this Tile Store with a given key.
Future<?>	query(ILfnQueryHandler aQueryHandler, TLfnQuery aQuery) Queries the Tile Store for resources' metadata.

Methods inherited from class com.luciad.fusion.tilestore.ALfnTileStore

getMetadata, getRasterAssetMetadata, getRasterCoverageMetadata, getThemeMetadata, getVectorAssetMetadata, getVectorCoverageMetadata, putRasterAssetMetadata, putRasterCoverageMetadata, putThemeMetadata, putVectorAssetMetadata, putVectorCoverageMetadata, query, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TLfnFileSystemTileStore

public TLfnFileSystemTileStore(File aHome,
                               boolean aCreate,
                               ALfnEnvironment aEnvironment)
                        throws IOException

Opens a Tile Store on the file system, optionally creating it first.

A Tile Store created using this constructor uses the file-system based metadata store for storing and retrieving metadata, in which each metadata is stored in a separate XML file.

Parameters:

aHome - the home directory of the Tile Store

aCreate - true the Tile Store may be created on the file system if missing, false the Tile Store must not be created if missing and should throw FileNotFoundException

aEnvironment - the core environment

Throws:

FileNotFoundException - when the Tile Store is missing and must not be created

IOException - when the Tile Store cannot be opened

TLfnFileSystemTileStore

public TLfnFileSystemTileStore(File aHome,
                               boolean aCreate,
                               ALfnEnvironment aEnvironment,
                               ALfnTileStore.CommitPolicy aCommitPolicy)
                        throws IOException

Opens a Tile Store on the file system, optionally creating it first.

A Tile Store created using this constructor uses the file-system based metadata store for storing and retrieving metadata, in which each metadata is stored in a separate XML file.

Parameters:

aHome - the home directory of the Tile Store

aCreate - true the Tile Store may be created on the file system if missing, false the Tile Store must not be created if missing and should throw FileNotFoundException

aEnvironment - the core environment

aCommitPolicy - if PER_COVERAGE, tiles will not be visible until the whole coverage is completely fused. This contrasts with the default PER_TILE, where new tiles are immediately visible. Use the former if you want a consistent view of the tiles in a coverage.

Throws:

FileNotFoundException - when the Tile Store is missing and must not be created

IOException - when the Tile Store cannot be opened

TLfnFileSystemTileStore

public TLfnFileSystemTileStore(File aHome,
                               boolean aCreate,
                               ALfnEnvironment aEnvironment,
                               ALfnBinaryMetadataStore aAssetStore,
                               ALfnBinaryMetadataStore aCoverageStore,
                               ALfnBinaryMetadataStore aThemeStore)
                        throws IOException,
                               TLfnServiceException

Opens a Tile Store on the file system, optionally creating it first.

The metadata stores provided in the constructor are not closed upon shutdown of the environment; you should close them explicitly once they are no longer needed.

Parameters:

aHome - the home directory of the Tile Store

aCreate - true the Tile Store may be created on the file system if missing, false the Tile Store must not be created if missing and should throw FileNotFoundException

aEnvironment - the core environment

aAssetStore - the metadata store to store and retrieve asset metadata

aCoverageStore - the metadata store to store and retrieve coverage metadata

aThemeStore - the metadata store to store and retrieve theme metadata

Throws:

FileNotFoundException - when the Tile Store is missing and must not be created

IOException - when the Tile Store cannot be opened

TLfnServiceException

TLfnFileSystemTileStore

public TLfnFileSystemTileStore(File aHome,
                               boolean aCreate,
                               ALfnEnvironment aEnvironment,
                               ALfnTileStore.CommitPolicy aCommitPolicy,
                               ALfnBinaryMetadataStore aAssetStore,
                               ALfnBinaryMetadataStore aCoverageStore,
                               ALfnBinaryMetadataStore aThemeStore)
                        throws IOException,
                               TLfnServiceException

Opens a Tile Store on the file system, optionally creating it first.

The metadata stores provided in the constructor are not closed upon shutdown of the environment; you should close them explicitly once they are no longer needed.

Parameters:

aHome - the home directory of the Tile Store

aCreate - true the Tile Store may be created on the file system if missing, false the Tile Store must not be created if missing and should throw FileNotFoundException

aEnvironment - the core environment

aCommitPolicy - if PER_COVERAGE, tiles will not be visible until the whole coverage is completely fused. This contrasts with the default PER_TILE, where new tiles are immediately visible. Use the former if you want a consistent view of the tiles in a coverage.

aAssetStore - the metadata store to store and retrieve asset metadata

aCoverageStore - the metadata store to store and retrieve coverage metadata

aThemeStore - the metadata store to store and retrieve theme metadata

Throws:

FileNotFoundException - when the Tile Store is missing and must not be created

IOException - when the Tile Store cannot be opened

TLfnServiceException

Method Detail

getHome

public File getHome()

Gets the home dir of this Tile Store.

Returns:

the path of the Tile Store home

getURI

public URI getURI()

Gets the Tile Store home as a URI.

Specified by:

getURI in class ALfnTileStore

Returns:

Tile Store home URI

deleteResource

public boolean deleteResource(String aID)
                       throws IOException,
                              TLfnServiceException

Description copied from class: ALfnTileStore

Deletes both the data and metadata of a resource. As soon as this method returns, the resource can be considered deleted for all practical purposes. Note however that space reclamation may or may not be immediate, since it is taken care of by a background process.

Overrides:

deleteResource in class ALfnTileStore

Parameters:

aID - the ID of a resource to be deleted

Returns:

true if the resource has been deleted, false if the resource does not exist

Throws:

IOException - in case of an I/O failure

TLfnServiceException - in case of a service processing failure

getCoverage

public ALfnCoverage getCoverage(String aID)
                         throws IOException,
                                TLfnServiceException

Description copied from class: ALfnTileStore

Gets a coverage from the Tile Store. Coverage IDs can be found using either:

• ALfnTileStore.getCoverageIds()
• ALfnTileStore.query(ILfnQueryHandler, TLfnQuery) and get the ID from the metadata

Overrides:

getCoverage in class ALfnTileStore

Parameters:

aID - the ID of the desired coverage

Returns:

the coverage or null if it does not exist

Throws:

IOException - in case of an I/O failure

TLfnServiceException - in case of a service processing failure

See Also:

ALfnCoverage

getAsset

public ALfnAsset getAsset(String aID)
                   throws IOException,
                          TLfnServiceException

Description copied from class: ALfnTileStore

Gets an asset from the Tile Store. Asset IDs can be found using either:

• query(ELfnResourceType.ASSET) and get the ID from the metadata
• ALfnTileStore.query(ILfnQueryHandler, TLfnQuery) and get the ID from the metadata

Overrides:

getAsset in class ALfnTileStore

Parameters:

aID - the ID of the desired asset

Returns:

the asset or null if it does not exist

Throws:

IOException - in case of an I/O failure

TLfnServiceException - in case of a service processing failure

getTheme

public ALfnTheme getTheme(String aID)
                   throws IOException,
                          TLfnServiceException

Description copied from class: ALfnTileStore

Gets a theme from the Tile Store. Theme IDs can be found using either:

• query(ELfnResourceType.THEME) and get the ID from the metadata
• ALfnTileStore.query(ILfnQueryHandler, TLfnQuery) and get the ID from the metadata

Overrides:

getTheme in class ALfnTileStore

Parameters:

aID - the ID of the desired theme

Returns:

the theme, or null if it does not exist

Throws:

IOException - in case of an I/O failure

TLfnServiceException - in case of a service processing failure

query

public Future<?> query(ILfnQueryHandler aQueryHandler,
                       TLfnQuery aQuery)

Description copied from class: ALfnTileStore

Queries the Tile Store for resources' metadata. The query returns the metadata of resources that match a given filter and type. Even though the API is asynchronous, implementations may be synchronous or asynchronous. The default implementations are in fact synchronous, but that is an implementation detail which may change at any time.

Overrides:

query in class ALfnTileStore

Parameters:

aQueryHandler - the handler for the results

aQuery - the query to be performed

Returns:

the future of the request, which could be asynchronous

getResourceMetadata

public <T extends ALfnResourceMetadata> T getResourceMetadata(String aID)
                                                       throws IOException,
                                                              TLfnServiceException

Description copied from class: ALfnTileStore

Gets the metadata of a resource.

This implementation throws UnsupportedOperationException. Subclasses should override it to do something useful.

Specified by:

getResourceMetadata in interface ILfnResourceMetadataResolver

Overrides:

getResourceMetadata in class ALfnTileStore

Parameters:

aID - the ID of the desired resource

Returns:

the resource corresponding to the given ID, or null if it does not exist

Throws:

IOException - in case of an I/O failure

TLfnServiceException - in case of a service processing failure

putResourceMetadata

public <T extends ALfnResourceMetadata> T putResourceMetadata(T aMetadata)
                                                       throws IOException,
                                                              TLfnServiceException

Description copied from class: ALfnTileStore

Adds or updates the metadata of a resource.

The put sequence is verified:

• addition of a new resource will fail if a resource with the same ID already exists;
• put of an existing resource will fail if the version of the updated metadata does not match the metadata on the LuciadFusion service.

In addition, the writability of the service is also verified. In these cases, a TLfnServiceException exception will be thrown.

This implementation throws UnsupportedOperationException. Subclasses should override it to do something useful.

Overrides:

putResourceMetadata in class ALfnTileStore

Parameters:

aMetadata - the metadata describing the resource to be put

Returns:

the resource metadata with the new put sequence

Throws:

IOException - in case of an I/O failure

TLfnServiceException - in case of a service processing failure or conflict

getCapabilities

public TLfnTileStoreCapabilities getCapabilities()
                                          throws IOException,
                                                 TLfnServiceException

Description copied from class: ALfnTileStore

Gets the capabilities offered by the Tile Store.

The capabilities provide the Tile Store metadata and the supported operations. The operations are defined as constants on this class.

Specified by:

getCapabilities in class ALfnTileStore

Returns:

the Tile Store capabilities

Throws:

IOException - in case of an I/O failure

TLfnServiceException - in case of a service processing failure

putMetadata

public void putMetadata(TLfnTileStoreMetadata aTileStoreMetadata)
                 throws IOException,
                        TLfnServiceException

Description copied from class: ALfnTileStore

Updates the metadata of this Tile Store.

Specified by:

putMetadata in class ALfnTileStore

Parameters:

aTileStoreMetadata - The new metadata for this Tile Store

Throws:

IOException - in case of an I/O failure

TLfnServiceException - in case of a service processing failure

getCoverageIds

public List<String> getCoverageIds()

Description copied from class: ALfnTileStore

Gets the IDs of all this Tile Store's coverage metadatas. This is a blocking call. It is a convenience method for the asynchronous ALfnTileStore.query(ILfnQueryHandler, TLfnQuery). Any checked exceptions on the asynchronous handler will be wrapped in a RuntimeException.

Overrides:

getCoverageIds in class ALfnTileStore

Returns:

the IDs of all this Tile Store's coverages, possibly empty but never null

close

public void close()
           throws IOException

Description copied from class: ALfnTileStore

Closes this Tile Store instance. This method does nothing, but subclasses may override it to do something useful.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class ALfnTileStore

Throws:

IOException - in case of an I/O failure

putUserData

public Future<ALfnTileStore.WriteResult> putUserData(String aKey,
                                                     ReadableByteChannel aSource,
                                                     ILfnCallback<ALfnTileStore.WriteResult> aCallback)

Description copied from class: ALfnTileStore

Puts binary user data in this Tile Store with a given key. User data is opaque binary data, and is used internally to store checkpoints and replication settings.

The user data is read from the given channel. If user data with the given key already exists, it is overwritten and this call returns true.

The user data key is an arbitrary string, but you are encouraged to use a java-like hierarchical naming scheme, for example "com.luciad.fusion.yourUniqueKey".

This operation is asynchronous. Callers can use the returned Future to wait for the result, or use a handler to be notified of the result.

This operation is optional. Use TLfnTileStoreOperation.isUserDataSupported(com.luciad.fusion.tilestore.TLfnTileStoreCapabilities) to check if this operation is supported.

Overrides:

putUserData in class ALfnTileStore

Parameters:

aKey - A key associated with the user data.

aSource - The input channel the user data is read from.

aCallback - A callback that will be invoked when the operation is finished. May be null.

Returns:

A future, with result code ALfnTileStore.WriteResult.PUT if data with the given key already existed, ALfnTileStore.WriteResult.CREATED if it is new.

getUserData

public Future<ALfnTileStore.ReadResult> getUserData(String aKey,
                                                    WritableByteChannel aSink,
                                                    ILfnCallback<ALfnTileStore.ReadResult> aCallback)

Description copied from class: ALfnTileStore

Gets binary user data from this Tile Store with a given key.

The user data is written to the given channel, if it exists.

The user data key is an arbitrary string, but you are encouraged to use a java-like hierarchical naming scheme, for example "com.luciad.fusion.youruniquekey".

This operation is asynchronous. Callers can use the returned Future to wait for the result, or use a handler to be notified of the result.

This operation is optional. Use TLfnTileStoreOperation.isUserDataSupported(com.luciad.fusion.tilestore.TLfnTileStoreCapabilities) to check if this operation is supported.

Overrides:

getUserData in class ALfnTileStore

Parameters:

aKey - A key associated with the user data.

aSink - The output channel the data is written to, if it exists.

aCallback - A callback that will be invoked when the operation is finished. May be null.

Returns:

A future, with result value ALfnTileStore.ReadResult.FOUND if data with the given key exists, ALfnTileStore.Result.Code.NOT_FOUND otherwise.

deleteUserData

public Future<ALfnTileStore.WriteResult> deleteUserData(String aKey,
                                                        ILfnCallback<ALfnTileStore.WriteResult> aCallback)

Description copied from class: ALfnTileStore

Deletes binary user data from this Tile Store with a given key.

The user data key is an arbitrary string, but you should use a java-like hierarchical naming scheme.

This operation is asynchronous. Callers can use the returned Future to wait for the result, or use a handler to be notified of the result.

This operation is optional. User TLfnTileStoreOperation.isUserDataSupported(com.luciad.fusion.tilestore.TLfnTileStoreCapabilities) to check if this operation is supported.

Overrides:

deleteUserData in class ALfnTileStore

Parameters:

aKey - A key associated with the user data.

aCallback - A callback that will be invoked when the operation is finished. May be null.

Returns:

A future, with result value ALfnTileStore.WriteResult.DELETED if data existed, ALfnTileStore.WriteResult.NOT_FOUND otherwise.