sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1667001 - in /sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis: internal/referencing/provider/ referencing/datum/ referencing/operation/ referencing/operation/builder/
Date Mon, 16 Mar 2015 14:01:25 GMT
Author: desruisseaux
Date: Mon Mar 16 14:01:25 2015
New Revision: 1667001

URL: http://svn.apache.org/r1667001
Log:
Minor Javadoc updates (include formatting fixes).

Modified:
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/LongitudeRotation.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/MapProjection.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/builder/package-info.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/package-info.java

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/LongitudeRotation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/LongitudeRotation.java?rev=1667001&r1=1667000&r2=1667001&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/LongitudeRotation.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/LongitudeRotation.java
[UTF-8] Mon Mar 16 14:01:25 2015
@@ -96,9 +96,12 @@ public final class LongitudeRotation ext
      * Creates a transform from the specified group of parameter values.
      * The parameter value is unconditionally converted to degrees.
      *
-     * <p>The operation is created as an affine transform. We do not override the
+     * <p>The operation is created as an affine transform between two two-dimensional
CRS. We do not override the
      * {@link AffineTransform2D#getParameterDescriptors()} and {@link AffineTransform2D#getParameterValues()}
methods
-     * in order to make that fact clearer.</p>
+     * in order to make that fact clearer, in the hope to reduce ambiguity about the nature
of the transform.
+     * Note also that the "Longitude rotation" operation has unit of measurement while the
"Affine" operation
+     * does not, so maybe our unconditional conversion to degrees would be more surprising
for the user if the
+     * operation was shown as a "Longitude rotation".</p>
      *
      * @param  values The group of parameter values.
      * @return The created math transform.

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/MapProjection.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/MapProjection.java?rev=1667001&r1=1667000&r2=1667001&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/MapProjection.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/provider/MapProjection.java
[UTF-8] Mon Mar 16 14:01:25 2015
@@ -20,7 +20,10 @@ import java.util.Map;
 import java.util.HashMap;
 import javax.measure.unit.SI;
 import org.opengis.util.GenericName;
+import org.opengis.parameter.ParameterValueGroup;
 import org.opengis.parameter.ParameterDescriptorGroup;
+import org.opengis.parameter.ParameterNotFoundException;
+import org.opengis.referencing.operation.MathTransform2D;
 import org.opengis.referencing.operation.Projection;
 import org.apache.sis.internal.util.Constants;
 import org.apache.sis.measure.MeasurementRange;
@@ -31,7 +34,9 @@ import static org.apache.sis.metadata.is
 
 
 /**
- * Base class for all map projection providers defined in this package.
+ * Base class for all map projection providers defined in this package. This base class defines
some descriptors
+ * for the most commonly used parameters. Subclasses will declare additional parameters and
group them in a
+ * {@linkplain ParameterDescriptorGroup descriptor group} named {@code PARAMETERS}.
  *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.6
@@ -108,4 +113,14 @@ public abstract class MapProjection exte
     public Class<? extends Projection> getOperationType() {
         return Projection.class;
     }
+
+    /**
+     * Creates a map projection from the specified group of parameter values.
+     *
+     * @param  values The group of parameter values.
+     * @return The created map projection.
+     * @throws ParameterNotFoundException if a required parameter was not found.
+     */
+    @Override
+    public abstract MathTransform2D createMathTransform(ParameterValueGroup values) throws
ParameterNotFoundException;
 }

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java?rev=1667001&r1=1667000&r2=1667001&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java
[UTF-8] Mon Mar 16 14:01:25 2015
@@ -43,7 +43,7 @@ import java.util.Objects;
 
 
 /**
- * Specifies the relationship of a coordinate system to the earth.
+ * Specifies the relationship of a {@linkplain org.apache.sis.referencing.cs.AbstractCS Coordinate
System} to the earth.
  * A datum can be defined as a set of real points on the earth that have coordinates.
  * Each datum subtype can be associated with only specific types of
  * {@linkplain org.apache.sis.referencing.cs.AbstractCS coordinate systems}, thus creating
specific types of

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/builder/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/builder/package-info.java?rev=1667001&r1=1667000&r2=1667001&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/builder/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/builder/package-info.java
[UTF-8] Mon Mar 16 14:01:25 2015
@@ -16,7 +16,8 @@
  */
 
 /**
- * Helper classes for creating {@code MathTransform}s from a set of points.
+ * Helper classes for creating {@linkplain org.apache.sis.referencing.operation.transform.AbstractMathTransform
+ * Math Transforms} from a set of points.
  * The builder classes require a matched set of known positions, one from a "source" data
set and another
  * from a "target" data set. The builder will then provide a transformation positions from
the "source" CRS
  * to the "target" CRS.

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/package-info.java?rev=1667001&r1=1667000&r2=1667001&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/package-info.java
[UTF-8] Mon Mar 16 14:01:25 2015
@@ -34,7 +34,7 @@
  * than the behavior found in other softwares. Those particularities apply only when the
math transform is
  * {@linkplain org.apache.sis.referencing.operation.transform.DefaultMathTransformFactory#createParameterizedTransform
  * created directly}. Users do not need to care about them when the coordinate operation
is
- * {@link org.apache.sis.referencing.operation.DefaultCoordinateOperationFactory#createOperation
+ * {@linkplain org.apache.sis.referencing.operation.DefaultCoordinateOperationFactory#createOperation
  * inferred by Apache SIS for a given pair of CRS}.
  *
  * <ul>



Mime
View raw message