You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2021/09/22 16:26:08 UTC
[sis] 03/07: Rename `FolderStoreProvider` as `StoreProvider` for
consistency with other internal store provider. The `Folder` prefix is
redundant with package names and these providers are no expected to be used
directly.
This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch geoapi-4.0
in repository https://gitbox.apache.org/repos/asf/sis.git
commit 93868d77c9613c67ed22a1c75925043c9b4a7739
Author: Martin Desruisseaux <ma...@geomatys.com>
AuthorDate: Wed Sep 22 15:09:30 2021 +0200
Rename `FolderStoreProvider` as `StoreProvider` for consistency with other internal store provider.
The `Folder` prefix is redundant with package names and these providers are no expected to be used directly.
---
.../main/java/org/apache/sis/internal/storage/folder/Store.java | 4 ++--
.../folder/{FolderStoreProvider.java => StoreProvider.java} | 8 ++++----
.../org/apache/sis/internal/storage/folder/WritableStore.java | 4 ++--
.../META-INF/services/org.apache.sis.storage.DataStoreProvider | 2 +-
.../java/org/apache/sis/internal/storage/folder/StoreTest.java | 4 ++--
5 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java
index 524c206..d03cbf3 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java
@@ -90,7 +90,7 @@ class Store extends DataStore implements StoreResource, Aggregate, DirectoryStre
private final Store originator;
/**
- * The {@link FolderStoreProvider#LOCATION} parameter value.
+ * The {@link StoreProvider#LOCATION} parameter value.
*/
protected final Path location;
@@ -213,7 +213,7 @@ class Store extends DataStore implements StoreResource, Aggregate, DirectoryStre
@Override
public Optional<ParameterValueGroup> getOpenParameters() {
final String format = StoreUtilities.getFormatName(componentProvider);
- final ParameterValueGroup pg = (provider != null ? provider.getOpenParameters() : FolderStoreProvider.PARAMETERS).createValue();
+ final ParameterValueGroup pg = (provider != null ? provider.getOpenParameters() : StoreProvider.PARAMETERS).createValue();
pg.parameter(DataStoreProvider.LOCATION).setValue(location);
if (locale != null) pg.parameter("locale" ).setValue(locale );
if (timezone != null) pg.parameter("timezone").setValue(timezone);
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/FolderStoreProvider.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/StoreProvider.java
similarity index 98%
rename from storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/FolderStoreProvider.java
rename to storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/StoreProvider.java
index f85f93e..9561f58 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/FolderStoreProvider.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/StoreProvider.java
@@ -62,11 +62,11 @@ import org.apache.sis.setup.OptionKey;
* @since 0.8
* @module
*/
-@StoreMetadata(formatName = FolderStoreProvider.NAME,
+@StoreMetadata(formatName = StoreProvider.NAME,
capabilities = {Capability.READ, Capability.WRITE},
resourceTypes = {Aggregate.class, FeatureSet.class, GridCoverageResource.class},
yieldPriority = true)
-public final class FolderStoreProvider extends DataStoreProvider {
+public final class StoreProvider extends DataStoreProvider {
/**
* A short name or abbreviation for the data format.
*/
@@ -119,7 +119,7 @@ public final class FolderStoreProvider extends DataStoreProvider {
/**
* Creates a new provider.
*/
- public FolderStoreProvider() {
+ public StoreProvider() {
}
/**
@@ -159,7 +159,7 @@ public final class FolderStoreProvider extends DataStoreProvider {
return ProbeResult.SUPPORTED;
}
} catch (FileSystemNotFoundException e) {
- Logging.recoverableException(getLogger(), FolderStoreProvider.class, "probeContent", e);
+ Logging.recoverableException(getLogger(), StoreProvider.class, "probeContent", e);
// Nothing we can do, may happen often.
}
return ProbeResult.UNSUPPORTED_STORAGE;
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/WritableStore.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/WritableStore.java
index 8a53cc2..add465c 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/WritableStore.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/WritableStore.java
@@ -62,7 +62,7 @@ final class WritableStore extends Store implements WritableAggregate {
/**
* Creates a new folder store from the given file, path or URI.
* Contrarily to the {@link Store} parent class, the {@code format} is mandatory for writable stores.
- * This is not verified by this constructor; it should be verified by {@link FolderStoreProvider} instead.
+ * This is not verified by this constructor; it should be verified by {@link StoreProvider} instead.
*/
WritableStore(DataStoreProvider provider, StorageConnector connector, Path path, DataStoreProvider format)
throws DataStoreException, IOException
@@ -79,7 +79,7 @@ final class WritableStore extends Store implements WritableAggregate {
ArgumentChecks.ensureNonNull("resource", resource);
if (!(resource instanceof FeatureSet)) {
throw new DataStoreException(message(Resources.Keys.CanNotStoreResourceType_2, new Object[] {
- FolderStoreProvider.NAME, StoreUtilities.getInterface(resource.getClass())
+ StoreProvider.NAME, StoreUtilities.getInterface(resource.getClass())
}));
}
/*
diff --git a/storage/sis-storage/src/main/resources/META-INF/services/org.apache.sis.storage.DataStoreProvider b/storage/sis-storage/src/main/resources/META-INF/services/org.apache.sis.storage.DataStoreProvider
index 5c1a70f..821d25b 100644
--- a/storage/sis-storage/src/main/resources/META-INF/services/org.apache.sis.storage.DataStoreProvider
+++ b/storage/sis-storage/src/main/resources/META-INF/services/org.apache.sis.storage.DataStoreProvider
@@ -1,4 +1,4 @@
org.apache.sis.internal.storage.xml.StoreProvider
org.apache.sis.internal.storage.wkt.StoreProvider
org.apache.sis.internal.storage.csv.StoreProvider
-org.apache.sis.internal.storage.folder.FolderStoreProvider
+org.apache.sis.internal.storage.folder.StoreProvider
diff --git a/storage/sis-storage/src/test/java/org/apache/sis/internal/storage/folder/StoreTest.java b/storage/sis-storage/src/test/java/org/apache/sis/internal/storage/folder/StoreTest.java
index 1f04666..54b98c6 100644
--- a/storage/sis-storage/src/test/java/org/apache/sis/internal/storage/folder/StoreTest.java
+++ b/storage/sis-storage/src/test/java/org/apache/sis/internal/storage/folder/StoreTest.java
@@ -89,9 +89,9 @@ public final strictfp class StoreTest extends TestCase {
*/
@Test
public void testSearchProviderParameter() throws URISyntaxException, DataStoreException, IOException {
- final FolderStoreProvider provider = new FolderStoreProvider();
+ final StoreProvider provider = new StoreProvider();
final Set<String> identifiers = new HashSet<>(Arrays.asList("Sample 1", "Sample 2", "Sample 3", "data4"));
- final ParameterValueGroup params = FolderStoreProvider.PARAMETERS.createValue();
+ final ParameterValueGroup params = StoreProvider.PARAMETERS.createValue();
params.parameter("location").setValue(testDirectory());
params.parameter("format").setValue("XML");
try (Store store = (Store) provider.open(params)) {