sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject [sis] 01/02: Add a clarification in javadoc.
Date Tue, 19 Mar 2019 19:40:59 GMT
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 30bf6470362d34803ec1de0da7c18a9b0d8090f9
Author: Martin Desruisseaux <martin.desruisseaux@geomatys.com>
AuthorDate: Tue Mar 19 20:39:03 2019 +0100

    Add a clarification in javadoc.
---
 .../main/java/org/apache/sis/internal/metadata/AxisDirections.java    | 4 ++++
 .../src/main/java/org/apache/sis/storage/GridCoverageResource.java    | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/AxisDirections.java
b/core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/AxisDirections.java
index 77d92b6..c159f24 100644
--- a/core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/AxisDirections.java
+++ b/core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/AxisDirections.java
@@ -494,6 +494,10 @@ public final class AxisDirections extends Static {
      *   <li>Otherwise the index of the first sequence if returned, regardless axis
names.</li>
      * </ol>
      *
+     * Note that colinear axes are normally not allowed, except if the case of {@link org.opengis.referencing.crs.TemporalCRS}
+     * when one time axis is the runtime (the date where a numerical model has been executed)
and the other time axis is the
+     * forecast time (the date at which a prevision is made).
+     *
      * @param  cs     the coordinate system which contains all axes, or {@code null}.
      * @param  subCS  the coordinate system to search into {@code cs}.
      * @return the first dimension of a sequence of axes colinear with {@code subCS} axes,
or {@code -1} if none.
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/GridCoverageResource.java
b/storage/sis-storage/src/main/java/org/apache/sis/storage/GridCoverageResource.java
index 46fe057..fc632bd 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/storage/GridCoverageResource.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/GridCoverageResource.java
@@ -90,6 +90,10 @@ public interface GridCoverageResource extends DataSet {
      * <i>etc</i>. The general contract is that the returned coverage should
not contain less data than a coverage
      * matching exactly the given geometry.
      *
+     * <p>The returned coverage shall contain the exact set of sample dimensions specified
by the {@code range}
+     * argument, in the specified order. The "best-effort basis" flexibility applies only
to the grid geometry,
+     * not to the range.</p>
+     *
      * <p>While this method name suggests an immediate reading, some implementations
may defer the actual reading
      * at a later stage.</p>
      *


Mime
View raw message