Package org.apache.sis.internal.storage.gpx

Class WritableStore

java.lang.Object

org.apache.sis.storage.DataStore

org.apache.sis.internal.storage.URIDataStore

org.apache.sis.internal.storage.xml.stream.StaxDataStore

org.apache.sis.internal.storage.gpx.Store

org.apache.sis.internal.storage.gpx.WritableStore

All Implemented Interfaces:

AutoCloseable, ResourceOnFileSystem, StoreResource, DataSet, FeatureSet, Resource, WritableFeatureSet, Localized

public final class WritableStore
extends Store
implements WritableFeatureSet

A GPX store capable to write GPX file.

Since:

1.3

Version:

1.3

Nested Class Summary

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

URIDataStore.Provider

Field Summary

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

types, version

Fields inherited from class org.apache.sis.internal.storage.xml.stream.StaxDataStore

encoding, locale, timezone

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

location

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

listeners, provider

Constructor Summary

Constructors

Constructor	Description
WritableStore(StoreProvider provider, StorageConnector connector)	Creates a new GPX store from the given file, URL or stream object.

Method Summary

Modifier and Type	Method	Description
void	add(Iterator<? extends AbstractFeature> features)	Appends new feature instances in this FeatureSet.
boolean	removeIf(Predicate<? super AbstractFeature> filter)	Removes all feature instances from this FeatureSet which matches the given predicate.
void	replaceIf(Predicate<? super AbstractFeature> filter, UnaryOperator<AbstractFeature> replacement)	Updates all feature instances from this FeatureSet which match the given predicate.
private Updater	updater()	Returns the helper object to use for updating the GPX file.
void	updateType(DefaultFeatureType newType)	Verifies the type of feature instances in this feature set.
void	write(org.opengis.metadata.Metadata metadata, Stream<? extends AbstractFeature> features)	Deprecated. To be replaced by add(Iterator), after we resolved how to specify metadata.

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

close, closeReader, features, getEnvelope, getFeatureType, getFormat, getMetadata, getType, getVersion, setVersion

Methods inherited from class org.apache.sis.internal.storage.xml.stream.StaxDataStore

getFormatName, getProvider

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

addTitleOrIdentifier, getComponentFiles, getIdentifier, getOpenParameters, getOriginator, getSpecifiedPath, location, parameters

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

addListener, findResource, getDisplayName, getLocale, getNativeMetadata, 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.DataSet

getEnvelope

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

features, getType, subset

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

addListener, getIdentifier, getMetadata, removeListener

Constructor Details

WritableStore

public WritableStore(StoreProvider provider,
 StorageConnector connector)
              throws DataStoreException

Creates a new GPX store from the given file, URL or stream object. This constructor invokes StorageConnector.closeAllExcept(Object), keeping open only the needed resource.

Parameters:

provider - the provider of this data store, or null if unspecified.

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

Throws:

DataStoreException - if an error occurred while opening the GPX file.

Method Details

updateType

public void updateType(DefaultFeatureType newType)
                throws DataStoreException

Verifies the type of feature instances in this feature set. This method does nothing if the specified type is equal to Store.getType(), or throws IllegalFeatureTypeException otherwise.

Specified by:

updateType in interface WritableFeatureSet

Parameters:

newType - new feature type definition (not null).

Throws:

DataStoreException - if the given type is not compatible with the types supported by the store.

add

public void add(Iterator<? extends AbstractFeature> features)
         throws DataStoreException

Appends new feature instances in this FeatureSet. Any feature already present in this FeatureSet will remain unmodified.

Specified by:

add in interface WritableFeatureSet

Parameters:

features - feature instances to append in this FeatureSet.

Throws:

DataStoreException - if the feature stream cannot be obtained or updated.

removeIf

public boolean removeIf(Predicate<? super AbstractFeature> filter)
                 throws DataStoreException

Removes all feature instances from this FeatureSet which matches the given predicate.

Specified by:

removeIf in interface WritableFeatureSet

Parameters:

filter - a predicate which returns true for feature instances to be removed.

Returns:

true if any elements were removed.

Throws:

DataStoreException - if the feature stream cannot be obtained or updated.

replaceIf

public void replaceIf(Predicate<? super AbstractFeature> filter,
 UnaryOperator<AbstractFeature> replacement)
               throws DataStoreException

Updates all feature instances from this FeatureSet which match the given predicate. If the given operator returns null, then the filtered feature is removed.

Specified by:

replaceIf in interface WritableFeatureSet

Parameters:

filter - a predicate which returns true for feature instances to be updated.

replacement - operation called for each matching Feature instance. May return null.

Throws:

DataStoreException - if the feature stream cannot be obtained or updated.

updater

private Updater updater()
                 throws DataStoreException

Returns the helper object to use for updating the GPX file.

Throws:

DataStoreException

write

@Deprecated
public void write(org.opengis.metadata.Metadata metadata,
 Stream<? extends AbstractFeature> features)
           throws DataStoreException

Deprecated.

To be replaced by add(Iterator), after we resolved how to specify metadata.

Replaces the content of this GPX file by the given metadata and features.

Parameters:

metadata - the metadata to write, or null if none.

features - the features to write, or null if none.

Throws:

ConcurrentReadException - if the features stream was provided by this data store.

DataStoreException - if an error occurred while writing the data.

See Also:

• SIS-411