[sis] 03/03: Add one more comment about the problem of using statistics for completing coverage metadata.

[de...@apache.org]

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 94f75c15288e03c89dc43fa8c4f447da390f4e11
Author: Martin Desruisseaux <ma...@geomatys.com>
AuthorDate: Thu Sep 29 11:03:50 2022 +0200

    Add one more comment about the problem of using statistics for completing coverage metadata.
---
 .../main/java/org/apache/sis/internal/storage/StoreUtilities.java   | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/StoreUtilities.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/StoreUtilities.java
index eaeb355bab..495ff793e0 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/StoreUtilities.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/StoreUtilities.java
@@ -75,6 +75,12 @@ public final class StoreUtilities extends Static {
      * <p>This flag can be set to {@code true} for exploring data that we can not visualize otherwise.
      * But it should generally stay to {@code false}, because otherwise browsing resource metadata can
      * become as costly (slow and high memory usage) as visualizing the full raster.</p>
+     *
+     * <p>In addition of possible performance degradations, setting this flag to {@code true} can also prevent
+     * {@link org.apache.sis.storage.aggregate.CoverageAggregator} to group coverages that should be together.
+     * This is because using statistics may cause {@link org.apache.sis.coverage.SampleDimension} instances to
+     * have different sample value ranges for each coverage, which cause {@code CoverageAggregator} to consider
+     * that that can not be aggregated together.</p>
      */
     public static final boolean ALLOW_LAST_RESORT_STATISTICS = false;