Package org.apache.sis.internal.storage.folder

Class WritableStore

java.lang.Object

org.apache.sis.storage.DataStore

org.apache.sis.internal.storage.folder.Store

org.apache.sis.internal.storage.folder.WritableStore

All Implemented Interfaces:

AutoCloseable, DirectoryStream.Filter<Path>, UnstructuredAggregate, StoreResource, Aggregate, Resource, WritableAggregate, Localized

final class WritableStore
extends Store
implements WritableAggregate

Writable version of the store which rely on given datastore provider to create new types. Note 1: this implementation is experimental. Note 2: it has not been tested since we do not have writable feature sets yet.

Since:

1.0

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isReadOnly	false if this data store is capable to write FeatureSet.

Fields inherited from class org.apache.sis.internal.storage.folder.Store

children, componentProvider, components, encoding, locale, location, timezone

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

listeners, provider

Constructor Summary

Constructors

Constructor	Description
WritableStore(DataStoreProvider provider, StorageConnector connector, Path path, DataStoreProvider format)	Creates a new folder store from the given file, path or URI.

Method Summary

Modifier and Type	Method	Description
Resource	add(Resource resource)	Create a new file for the given resource.
(package private) static void	deleteRecursively(Path root, boolean deleteRoot)	Deletes all files and sub-directories in the specified directory.
void	remove(Resource resource)	Removes a Resource from this store.

Methods inherited from class org.apache.sis.internal.storage.folder.Store

accept, close, components, getIdentifier, getMetadata, getOpenParameters, getOriginator, getStructuredView, message, messages

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

addListener, findResource, getDisplayName, getLocale, getNativeMetadata, getProvider, removeListener, setLocale, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sis.storage.Aggregate

components

Methods inherited from interface org.apache.sis.storage.Resource

addListener, getIdentifier, getMetadata, removeListener

Field Details

isReadOnly

private boolean isReadOnly

false if this data store is capable to write FeatureSet. We currently have no easy way to determine that from the provider only, so this flag may be set after the first attempt to add a new resource.

Constructor Details

WritableStore

WritableStore(DataStoreProvider provider,
 StorageConnector connector,
 Path path,
 DataStoreProvider format)
       throws DataStoreException,
IOException

Creates a new folder store from the given file, path or URI. Contrarily to the Store parent class, the format is mandatory for writable stores. This is not verified by this constructor; it should be verified by StoreProvider instead.

Throws:

DataStoreException

IOException

Method Details

add

public Resource add(Resource resource)
             throws DataStoreException

Create a new file for the given resource. This implementation uses the provider specified at creation time.

Specified by:

add in interface WritableAggregate

Parameters:

resource - the resource to copy in this Aggregate.

Returns:

the effectively added resource. May be resource itself if it has been added verbatim.

Throws:

DataStoreException - if the given resource cannot be stored in this Aggregate.

remove

public void remove(Resource resource)
            throws DataStoreException

Removes a Resource from this store. The resource must be a part of this Aggregate. For a folder store, this means that the resource must be a direct children of the directory managed by this store. This operation is destructive: the Resource and it's related files will be deleted.

Specified by:

remove in interface WritableAggregate

Parameters:

resource - child resource to remove from this Aggregate.

Throws:

DataStoreException - if the given resource could not be removed.

deleteRecursively

static void deleteRecursively(Path root,
 boolean deleteRoot)
                       throws IOException

Deletes all files and sub-directories in the specified directory. This method does nothing if the given root is a file rather than a directory. The root directory is left in place (after being emptied) if deleteRoot is false.

Parameters:

root - the directory to delete with all sub-directories.

deleteRoot - true for deleting also root, or false for leaving it empty.

Throws:

IOException