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 2023/09/30 16:05:26 UTC
[sis] 04/05: Replace some Maven artifact names by JPMS names in documentation.
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 f81541ca43ada86b415763a9cbee17bab05fe6ad
Author: Martin Desruisseaux <ma...@geomatys.com>
AuthorDate: Sat Sep 30 17:44:20 2023 +0200
Replace some Maven artifact names by JPMS names in documentation.
---
.../main/org/apache/sis/metadata/sql/MetadataSource.java | 2 +-
.../main/org/apache/sis/metadata/sql/util/Initializer.java | 6 +++---
.../main/org/apache/sis/metadata/sql/util/LocalDataSource.java | 2 +-
.../main/org/apache/sis/referencing/factory/sql/EPSGFactory.java | 4 ++--
.../main/org/apache/sis/referencing/factory/sql/EPSG_README.md | 2 +-
.../main/org/apache/sis/referencing/factory/sql/package-info.java | 2 +-
.../test/org/apache/sis/referencing/factory/sql/epsg/README.md | 2 +-
.../main/org/apache/sis/setup/Configuration.java | 2 +-
.../main/org/apache/sis/setup/InstallationResources.java | 4 ++--
9 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/MetadataSource.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/MetadataSource.java
index 645a806202..a5eaf97428 100644
--- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/MetadataSource.java
+++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/MetadataSource.java
@@ -446,7 +446,7 @@ public class MetadataSource implements AutoCloseable {
* <li>The schema name must be {@code "metadata"}, as this is the name used unquoted in SQL scripts.</li>
* </ul>
*
- * Maintenance note: this method is invoked by reflection in {@code non-free:sis-embedded-data} module.
+ * Maintenance note: this method is invoked by reflection in the {@code org.apache.sis.referencing.database} module.
* If we make this method public in a future Apache SIS version, then we can remove the reflection code.
*
* @throws SQLException if an error occurred while inserting the metadata.
diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/util/Initializer.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/util/Initializer.java
index de9dcd185e..6270026111 100644
--- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/util/Initializer.java
+++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/util/Initializer.java
@@ -71,7 +71,7 @@ public abstract class Initializer {
* the {@code derby.system.home} property.
*
* <h4>Dependency note</h4>
- * This field is public for the needs of {@code non-free:sis-embedded-data} module.
+ * This field is public for the needs of {@code org.apache.sis.referencing.database} module.
*/
public static final String DATABASE = "SpatialMetadata";
@@ -249,7 +249,7 @@ public abstract class Initializer {
* use the data source for {@code "jdbc:derby:$SIS_DATA/Databases/SpatialMetadata"}.
* That database will be created if it does not exist. Note that this is the only case where
* Apache SIS may create the database since it is located in the directory managed by Apache SIS.</li>
- * <li>Otherwise if the {@code non-free:sis-embedded-data} module is present on the module path,
+ * <li>Otherwise if the {@code org.apache.sis.referencing.database} module is present on the module path,
* use the embedded database.</li>
* <li>Otherwise if the {@code "derby.system.home"} property is defined,
* use the data source for {@code "jdbc:derby:SpatialMetadata"}.
@@ -368,7 +368,7 @@ public abstract class Initializer {
}
/**
- * If the {@code non-free:sis-embedded-data} module is present on the module path,
+ * If the {@code org.apache.sis.referencing.database} module is present on the module path,
* returns the data source for embedded Derby database. Otherwise returns {@code null}.
*
* @see <a href="https://issues.apache.org/jira/browse/SIS-337">SIS-337</a>
diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/util/LocalDataSource.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/util/LocalDataSource.java
index c03a285934..31923006a7 100644
--- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/util/LocalDataSource.java
+++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/util/LocalDataSource.java
@@ -304,7 +304,7 @@ public final class LocalDataSource implements DataSource, Comparable<LocalDataSo
* While this method is primarily used for Derby shutdown, the error code tested may be applicable to other systems.
*
* <h4>Dependency note</h4>
- * This method is public for the needs of {@code non-free:sis-embedded-data} module.
+ * This method is public for the needs of {@code org.apache.sis.referencing.database} module.
*
* @param e the exception thrown by Derby.
* @return {@code true} if the exception indicates a successful shutdown.
diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/EPSGFactory.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/EPSGFactory.java
index c815234681..7153ac61cf 100644
--- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/EPSGFactory.java
+++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/EPSGFactory.java
@@ -360,9 +360,9 @@ public class EPSGFactory extends ConcurrentAuthorityFactory<EPSGDataAccess> impl
* </ul>
*
* <h4>Legal constraint</h4>
- * The EPSG dataset cannot be distributed with Apache SIS at this time for licensing reasons.
+ * The EPSG dataset cannot be distributed with Apache SIS for licensing reasons.
* Users need to either install the dataset manually (for example with the help of this method),
- * or add on the module path to a separated bundle like {@code org.apache.sis:non-free:sis-epsg.jar}.
+ * or add on the module path a separated bundle such as the {@code org.apache.sis.referencing.epsg} module.
* See <a href="https://sis.apache.org/epsg.html">How to use EPSG geodetic dataset</a> for more information.
*
* @param connection connection to the database where to create the EPSG schema.
diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/EPSG_README.md b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/EPSG_README.md
index f75310480f..9e36a858ca 100644
--- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/EPSG_README.md
+++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/EPSG_README.md
@@ -1,6 +1,6 @@
Do not create an `epsg` sub-package (except for tests or maintenance tasks only)
because the `org.apache.sis.referencing.factory.sql.epsg` package name is owned
-by the `org.apache.sis.non-free:sis-epsg` module and we should not put anything
+by the `org.apache.sis.referencing.epsg` module and we should not put anything
in a package owned by another module.
We make this separation for licensing reason because the EPSG geodetic dataset
diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/package-info.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/package-info.java
index fe7348a73d..d94e97d28f 100644
--- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/package-info.java
+++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/sql/package-info.java
@@ -35,7 +35,7 @@
* a JDBC connection for the {@code "jdbc:derby:$SIS_DATA/Databases/SpatialMetadata"} URL.</li>
* <li>If the {@code "derby.system.home"} {@linkplain java.lang.System#getProperty(String) property} is defined,
* a JDBC connection for the {@code "jdbc:derby:SpatialMetadata"} URL.</li>
- * <li>If the {@code org.apache.sis.non-free:sis-embedded-data} module is present on the module path,
+ * <li>If the {@code org.apache.sis.referencing.database} module is present on the module path,
* a read-only connection to the database in the JAR file.</li>
* </ol>
*
diff --git a/endorsed/src/org.apache.sis.referencing/test/org/apache/sis/referencing/factory/sql/epsg/README.md b/endorsed/src/org.apache.sis.referencing/test/org/apache/sis/referencing/factory/sql/epsg/README.md
index 73d583a49e..42f030d594 100644
--- a/endorsed/src/org.apache.sis.referencing/test/org/apache/sis/referencing/factory/sql/epsg/README.md
+++ b/endorsed/src/org.apache.sis.referencing/test/org/apache/sis/referencing/factory/sql/epsg/README.md
@@ -1,6 +1,6 @@
# EPSG dataset update procedure
-The `org.apache.sis.referencing.factory.sql.epsg` package in the `non-free:sis-epsg` module
+The `org.apache.sis.referencing.factory.sql.epsg` package in the `non-free:sis-epsg` Maven artifact
provides SQL scripts for installing a local copy of the [EPSG geodetic dataset](https://epsg.org/).
This dataset provides definitions for thousands of Coordinate Reference Systems (CRS),
together with parameter values for thousands of Coordinate Operations between various pairs of CRS.
diff --git a/endorsed/src/org.apache.sis.util/main/org/apache/sis/setup/Configuration.java b/endorsed/src/org.apache.sis.util/main/org/apache/sis/setup/Configuration.java
index 5666a10570..341720d978 100644
--- a/endorsed/src/org.apache.sis.util/main/org/apache/sis/setup/Configuration.java
+++ b/endorsed/src/org.apache.sis.util/main/org/apache/sis/setup/Configuration.java
@@ -91,7 +91,7 @@ public final class Configuration {
* use the data source for {@code "jdbc:derby:$SIS_DATA/Databases/SpatialMetadata"}.
* That database will be created if it does not exist. Note that this is the only case where
* Apache SIS may create the database since it is located in the directory managed by Apache SIS.</li>
- * <li>Otherwise if the {@code non-free:sis-embedded-data} module is present on the module path,
+ * <li>Otherwise if the {@code org.apache.sis.referencing.database} module is present on the module path,
* use the embedded database.</li>
* <li>Otherwise if the "{@systemProperty derby.system.home}" property is defined,
* use the data source for {@code "jdbc:derby:SpatialMetadata"} database.
diff --git a/endorsed/src/org.apache.sis.util/main/org/apache/sis/setup/InstallationResources.java b/endorsed/src/org.apache.sis.util/main/org/apache/sis/setup/InstallationResources.java
index 79475a7141..b6920612f7 100644
--- a/endorsed/src/org.apache.sis.util/main/org/apache/sis/setup/InstallationResources.java
+++ b/endorsed/src/org.apache.sis.util/main/org/apache/sis/setup/InstallationResources.java
@@ -51,7 +51,7 @@ import org.apache.sis.system.Reflect;
*
* <table class="sis">
* <caption>Authorities supported by Apache SIS</caption>
- * <tr><th>Authority</th> <th>Provided by Maven module</th> <th>Used by class</th></tr>
+ * <tr><th>Authority</th> <th>Provided by Maven artifact</th> <th>Used by class</th></tr>
* <tr><td>{@code "EPSG"}</td> <td>{@code org.apache.sis.non-free:sis-epsg}</td> <td>{@link org.apache.sis.referencing.factory.sql.EPSGFactory}</td></tr>
* <tr><td>{@code "Embedded"}</td> <td>{@code org.apache.sis.non-free:sis-embedded-data}</td> <td>All the above</td></tr>
* </table>
@@ -100,7 +100,7 @@ public abstract class InstallationResources {
*
* <div class="note"><b>Note:</b>
* {@code "Embedded"} is a pseudo-authority for an embedded database containing EPSG and other data.
- * This embedded database is provided by the {@code org.apache.sis.non-free:sis-embedded-data} module
+ * This embedded database is provided by the {@code org.apache.sis.referencing.database} module
* as a convenience for avoiding the need to define a {@code SIS_DATA} directory on the local machine.
* In this particular case, the resource is more for execution than for installation.
* </div>