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 2013/10/27 20:35:08 UTC
svn commit: r1536187 - in /sis/branches/JDK7/core:
sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/
sis-referencing/src/main/java/org/apache/sis/io/wkt/
sis-referencing/src/main/java/org/apache/sis/referencing/datum/
Author: desruisseaux
Date: Sun Oct 27 19:35:07 2013
New Revision: 1536187
URL: http://svn.apache.org/r1536187
Log:
Minor javadoc changes (making some provision for planetary CRS).
Moved some code for keeping static method together (no real code change).
Modified:
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/Convention.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java?rev=1536187&r1=1536186&r2=1536187&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java [UTF-8] Sun Oct 27 19:35:07 2013
@@ -73,16 +73,17 @@ import java.util.Objects;
*
* {@section Relationship with Envelope classes}
* The {@link org.apache.sis.geometry} package provides various {@code Envelope} classes serving a simular purpose.
- * The main difference is that envelopes can be expressed in any Coordinate Reference System (for example using any
- * map projection), may have any number of dimensions, axes may have any orientation (some map are south-oriented)
+ * The main difference is that envelopes can be expressed in any {@linkplain org.apache.sis.referencing.crs.AbstractCRS
+ * Coordinate Reference System} (for example using any map projection), may have any number of dimensions, axes may have
+ * any {@linkplain org.apache.sis.referencing.cs.DefaultCoordinateSystemAxis#getDirection() direction} (some maps are south-oriented)
* and may use any units of measurement. By contrast, geographic bounding box are restricted to two-dimensional
* geographic CRS with latitude and longitude in decimal degrees, inside the [-90 … +90]° and [-180 … +180]° range
- * respectively, increasing toward north and east respectively, and longitude measured from the Greenwich meridian.
- *
- * <p>However {@code GeographicBoundingBox} said nothing about the
+ * respectively, increasing toward north and east respectively, and longitude measured from the <cite>international
+ * reference meridian</cite> (Greenwich on Earth). However {@code GeographicBoundingBox} said nothing about the
* {@linkplain org.apache.sis.referencing.datum.DefaultGeodeticDatum geodetic datum}. Consequently this bounding
* box should be used only as a convenient way to give an <em>approximate</em> description of a location.
- * Users can assume a precision of about 0.01° for the latitude and longitude values in this class.</p>
+ * Users can assume a precision of about 0.01° for the latitude and longitude values in this class.
+ * If more precision is desired, an {@code Envelope} should be considered instead.
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/Convention.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/Convention.java?rev=1536187&r1=1536186&r2=1536187&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/Convention.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/Convention.java [UTF-8] Sun Oct 27 19:35:07 2013
@@ -246,36 +246,6 @@ public enum Convention {
}
/**
- * Returns the citation for the organization, standard of project that defines this convention.
- *
- * @return The organization, standard or project that defines this convention.
- *
- * @see WKTFormat#getAuthority()
- */
- public Citation getAuthority() {
- return authority;
- }
-
- /**
- * If non-null, {@code PRIMEM} and {@code PARAMETER} values shall unconditionally use the returned units.
- * The standard value is {@code null}, which means that units are inferred from the context as required by the
- * <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/doc-files/WKT.html#PRIMEM">WKT specification</a>.
- * However some conventions ignore the above WKT specification and use hard-coded units instead.
- *
- * @param <T> The compile-time type specified by the {@code quantity} argument.
- * @param quantity The kind of quantity for which to get the unit.
- * The most typical value for this argument is <code>{@linkplain Angle}.class</code>.
- * @return The unit to use for the given kind of quantity, or {@code null} for inferring the unit in the standard way.
- */
- @SuppressWarnings("unchecked")
- public <T extends Quantity> Unit<T> getForcedUnit(final Class<T> quantity) {
- if (quantity == Angle.class) {
- return (Unit) forcedAngularUnit;
- }
- return null;
- }
-
- /**
* Returns the convention for the organization, standard or project specified by the given citation.
*
* @param authority The organization, standard or project for which to get the convention, or {@code null}.
@@ -314,6 +284,36 @@ public enum Convention {
}
/**
+ * Returns the citation for the organization, standard of project that defines this convention.
+ *
+ * @return The organization, standard or project that defines this convention.
+ *
+ * @see WKTFormat#getAuthority()
+ */
+ public Citation getAuthority() {
+ return authority;
+ }
+
+ /**
+ * If non-null, {@code PRIMEM} and {@code PARAMETER} values shall unconditionally use the returned units.
+ * The standard value is {@code null}, which means that units are inferred from the context as required by the
+ * <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/doc-files/WKT.html#PRIMEM">WKT specification</a>.
+ * However some conventions ignore the above WKT specification and use hard-coded units instead.
+ *
+ * @param <T> The compile-time type specified by the {@code quantity} argument.
+ * @param quantity The kind of quantity for which to get the unit.
+ * The most typical value for this argument is <code>{@linkplain Angle}.class</code>.
+ * @return The unit to use for the given kind of quantity, or {@code null} for inferring the unit in the standard way.
+ */
+ @SuppressWarnings("unchecked")
+ public <T extends Quantity> Unit<T> getForcedUnit(final Class<T> quantity) {
+ if (quantity == Angle.class) {
+ return (Unit) forcedAngularUnit;
+ }
+ return null;
+ }
+
+ /**
* Makes the given coordinate system conform to this convention. This method is used mostly
* for converting between the legacy (OGC 01-009) {@link GeocentricCRS} axis directions,
* and the new (ISO 19111) directions. Those directions are:
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java?rev=1536187&r1=1536186&r2=1536187&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java [UTF-8] Sun Oct 27 19:35:07 2013
@@ -65,8 +65,8 @@ import java.util.Objects;
* instance associated to this {@code DefaultGeodeticDatum}. Only if no datum shift method is found in the database,
* then the {@code BursaWolfParameters} associated to the datum may be used as a fallback.</p>
*
- * <p>The Bursa-Wolf parameters association serves an other purpose: when a CRS is formatted in
- * <cite>Well Known Text</cite> (WKT) format, the formatted string may contain a {@code TOWGS84[…]} element
+ * <p>The Bursa-Wolf parameters association serves an other purpose: when a CRS is formatted in the older
+ * <cite>Well Known Text</cite> (WKT 1) format, the formatted string may contain a {@code TOWGS84[…]} element
* with the parameter values of the transformation to the WGS 84 datum. This element is provided as a help
* for other Geographic Information Systems that support only the <cite>early-binding</cite> approach.
* Apache SIS usually does not need the {@code TOWGS84} element, except as a fallback for datum that