sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1722677 - in /sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql: EPSGDataAccess.java EPSGFactory.java
Date Sat, 02 Jan 2016 23:11:40 GMT
Author: desruisseaux
Date: Sat Jan  2 23:11:40 2016
New Revision: 1722677

URL: http://svn.apache.org/viewvc?rev=1722677&view=rev
Log:
Documentation fixes.

Modified:
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGFactory.java

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java?rev=1722677&r1=1722676&r2=1722677&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java
[UTF-8] Sat Jan  2 23:11:40 2016
@@ -113,13 +113,14 @@ import org.apache.sis.measure.Measuremen
  * The EPSG database is freely available at <a href="http://www.epsg.org">http://www.epsg.org</a>.
  * Current version of this class requires EPSG database version 6.6 or above.
  *
- * <p>EPSG codes are numerical identifiers. For example code 3395 stands for <cite>"WGS
84 / World Mercator"</cite>.
+ * <div class="section">Object identifier (code or name)</div>
+ * EPSG codes are numerical identifiers. For example code 3395 stands for <cite>"WGS
84 / World Mercator"</cite>.
  * Coordinate Reference Objects are normally created from their numerical codes, but this
factory accepts also names.
  * For example {@code createProjectedCRS("3395")} and {@code createProjectedCRS("WGS 84 /
World Mercator")} both fetch
  * the same object.
  * However, names may be ambiguous since the same name may be used for more than one object.
  * This is the case of <cite>"WGS 84"</cite> for instance.
- * If such an ambiguity is found, an exception will be thrown.</p>
+ * If such an ambiguity is found, an exception will be thrown.
  *
  * <div class="section">Life cycle and caching</div>
  * {@code EPSGDataAccess} instances should be short-lived since they may hold a significant
amount of JDBC resources.
@@ -130,6 +131,11 @@ import org.apache.sis.measure.Measuremen
  * in the common case where only a few EPSG codes are used by an application.
  * {@code EPSGDataAccess.createFoo(String)} methods do not cache by themselves and query
the database on every invocation.
  *
+ * <div class="section">SQL dialects</div>
+ * Because the primary distribution format for the EPSG dataset is MS-Access, this class
uses SQL statements formatted
+ * for the MS-Access dialect. For usage with other database softwares like PostgreSQL or
Derby, a {@link SQLTranslator}
+ * instance is provided to the constructor.
+ *
  * @author  Yann C├ęzard (IRD)
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @author  Rueben Schulz (UBC)
@@ -279,10 +285,10 @@ public class EPSGDataAccess extends Geod
      * Creates a factory using the given connection. The connection will be {@linkplain Connection#close()
closed}
      * when this factory will be {@linkplain #close() closed}.
      *
-     * <div class="note"><b>Design note:</b>
+     * <div class="note"><b>API design note:</b>
      * this constructor is protected because {@code EPSGDataAccess} instances should not
be created as standalone factories.
-     * This constructor is invoked either by {@link EPSGFactory#createBackingStore(Connection)},
or by the constructor
-     * of an {@code EPSGDataAccess} subclass which is itself invoked by a corresponding {@code
EPSGFactory} subclass.</div>
+     * This constructor is invoked either by {@link EPSGFactory#createBackingStore()}, or
by the constructor of an
+     * {@code EPSGDataAccess} subclass which is itself invoked by a corresponding {@code
EPSGFactory} subclass.</div>
      *
      * @param parent      The {@code EPSGFactory} which is creating this Data Access Object
(DAO).
      * @param connection  The connection to the underlying EPSG database.

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGFactory.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGFactory.java?rev=1722677&r1=1722676&r2=1722677&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGFactory.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGFactory.java
[UTF-8] Sat Jan  2 23:11:40 2016
@@ -46,9 +46,9 @@ import org.apache.sis.util.Localized;
  * for reuse and the idle connections are closed after a timeout.
  *
  * <div class="section">Note for subclasses</div>
- * If there is no cached object for a given code, then {@code EPSGFactory} creates an {@link
EPSGDataAccess} instance for
- * performing the actual creation work. Developers who need to customize the geodetic object
creation can override the
- * {@link #createBackingStore(Connection)} method in order to return their own {@link EPSGDataAccess}
subclass.
+ * If there is no cached object for a given code, then {@code EPSGFactory} creates an {@link
EPSGDataAccess} instance
+ * for performing the actual creation work. Developers who need to customize the geodetic
object creation can override
+ * the {@link #createBackingStore()} method in order to return their own {@link EPSGDataAccess}
subclass.
  *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.7



Mime
View raw message