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 2021/05/03 23:15:27 UTC

[sis] 02/02: Add a variant of `HyperRectangleReader.read(Region)` method for returning the data array wrapped in a `java.nio.Buffer`.

This is an automated email from the ASF dual-hosted git repository.

desruisseaux pushed a commit to branch GeoTIFF
in repository https://gitbox.apache.org/repos/asf/sis.git

commit bb9c88b3eeb2149cc3670527e4bb00a2a13a60c8
Author: Martin Desruisseaux <ma...@geomatys.com>
AuthorDate: Tue May 4 01:12:32 2021 +0200

    Add a variant of `HyperRectangleReader.read(Region)` method
    for returning the data array wrapped in a `java.nio.Buffer`.
---
 .../sis/internal/storage/io/ChannelDataInput.java  |  9 +++++++-
 .../sis/internal/storage/io/DataTransfer.java      |  7 ++++++-
 .../internal/storage/io/HyperRectangleReader.java  | 24 ++++++++++++++++++++--
 .../internal/storage/io/MemoryDataTransfer.java    |  3 ++-
 .../org/apache/sis/internal/storage/io/Region.java | 10 ++++-----
 5 files changed, 43 insertions(+), 10 deletions(-)

diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/ChannelDataInput.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/ChannelDataInput.java
index 63eb3d8..ac8e57a 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/ChannelDataInput.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/ChannelDataInput.java
@@ -61,7 +61,7 @@ import static org.apache.sis.util.ArgumentChecks.ensureBetween;
  * {@link javax.imageio} is needed.
  *
  * @author  Martin Desruisseaux (Geomatys)
- * @version 0.7
+ * @version 1.1
  * @since   0.3
  * @module
  */
@@ -614,6 +614,7 @@ public class ChannelDataInput extends ChannelData {
         BytesReader(final byte[] dest)                  {this.dest = dest;}
         @Override public int    dataSizeShift()         {return 0;}
         @Override public Object dataArray()             {return dest;}
+        @Override public Buffer dataArrayAsBuffer()     {return ByteBuffer.wrap(dest);}
         @Override public Buffer view()                  {return buffer;}
         @Override public Buffer createView()            {return buffer;}
         @Override public void   createDataArray(int n)  {dest = new byte[n];}
@@ -635,6 +636,7 @@ public class ChannelDataInput extends ChannelData {
         CharsReader(final char[] dest)                  {this.dest = dest;}
         @Override public int    dataSizeShift()         {return 1;}
         @Override public Object dataArray()             {return dest;}
+        @Override public Buffer dataArrayAsBuffer()     {return CharBuffer.wrap(dest);}
         @Override public Buffer view()                  {return view;}
         @Override public Buffer createView()            {return view = buffer.asCharBuffer();}
         @Override public void   createDataArray(int n)  {dest = new char[n];}
@@ -653,6 +655,7 @@ public class ChannelDataInput extends ChannelData {
         ShortsReader(final short[] dest)                {this.dest = dest;}
         @Override public int    dataSizeShift()         {return 1;}
         @Override public Object dataArray()             {return dest;}
+        @Override public Buffer dataArrayAsBuffer()     {return ShortBuffer.wrap(dest);}
         @Override public Buffer view()                  {return view;}
         @Override public Buffer createView()            {return view = buffer.asShortBuffer();}
         @Override public void   createDataArray(int n)  {dest = new short[n];}
@@ -671,6 +674,7 @@ public class ChannelDataInput extends ChannelData {
         IntsReader(final int[] dest)                    {this.dest = dest;}
         @Override public int    dataSizeShift()         {return 2;}
         @Override public Object dataArray()             {return dest;}
+        @Override public Buffer dataArrayAsBuffer()     {return IntBuffer.wrap(dest);}
         @Override public Buffer view()                  {return view;}
         @Override public Buffer createView()            {return view = buffer.asIntBuffer();}
         @Override public void   createDataArray(int n)  {dest = new int[n];}
@@ -689,6 +693,7 @@ public class ChannelDataInput extends ChannelData {
         LongsReader(final long[] dest)                  {this.dest = dest;}
         @Override public int    dataSizeShift()         {return 3;}
         @Override public Object dataArray()             {return dest;}
+        @Override public Buffer dataArrayAsBuffer()     {return LongBuffer.wrap(dest);}
         @Override public Buffer view()                  {return view;}
         @Override public Buffer createView()            {return view = buffer.asLongBuffer();}
         @Override public void   createDataArray(int n)  {dest = new long[n];}
@@ -707,6 +712,7 @@ public class ChannelDataInput extends ChannelData {
         FloatsReader(final float[] dest)                {this.dest = dest;}
         @Override public int    dataSizeShift()         {return 2;}
         @Override public Object dataArray()             {return dest;}
+        @Override public Buffer dataArrayAsBuffer()     {return FloatBuffer.wrap(dest);}
         @Override public Buffer view()                  {return view;}
         @Override public Buffer createView()            {return view = buffer.asFloatBuffer();}
         @Override public void   createDataArray(int n)  {dest = new float[n];}
@@ -725,6 +731,7 @@ public class ChannelDataInput extends ChannelData {
         DoublesReader(final double[] dest)              {this.dest = dest;}
         @Override public int    dataSizeShift()         {return 3;}
         @Override public Object dataArray()             {return dest;}
+        @Override public Buffer dataArrayAsBuffer()     {return DoubleBuffer.wrap(dest);}
         @Override public Buffer view()                  {return view;}
         @Override public Buffer createView()            {return view = buffer.asDoubleBuffer();}
         @Override public void   createDataArray(int n)  {dest = new double[n];}
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/DataTransfer.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/DataTransfer.java
index d120eaf..2d65ec9 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/DataTransfer.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/DataTransfer.java
@@ -25,7 +25,7 @@ import java.nio.Buffer;
  * The kind of buffer and the primitive type in the array depend on the implementation.
  *
  * @author  Martin Desruisseaux (Geomatys)
- * @version 0.7
+ * @version 1.1
  * @since   0.7
  * @module
  */
@@ -53,6 +53,11 @@ interface DataTransfer {
     Object dataArray();
 
     /**
+     * Returns {@link #dataArray()} wrapped in a buffer.
+     */
+    Buffer dataArrayAsBuffer();
+
+    /**
      * Creates a destination array of the given length.
      */
     void createDataArray(int length);
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/HyperRectangleReader.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/HyperRectangleReader.java
index e0d2041..7cb3c93 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/HyperRectangleReader.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/HyperRectangleReader.java
@@ -31,7 +31,7 @@ import org.apache.sis.storage.DataStoreContentException;
  *
  * @author  Johann Sorel (Geomatys)
  * @author  Martin Desruisseaux (Geomatys)
- * @version 1.0
+ * @version 1.1
  * @since   0.7
  * @module
  */
@@ -123,6 +123,26 @@ public final class HyperRectangleReader {
      * @throws ArithmeticException if the region to read is too large or too far from origin.
      */
     public Object read(final Region region) throws IOException {
+        return read(region, false);
+    }
+
+    /**
+     * Reads data in the given region as a buffer. This method performs the same work
+     * than {@link #read(Region)} except that the array is wrapped in a heap buffer.
+     *
+     * @param  region  the sub-area to read and the subsampling to use.
+     * @return the data in a buffer backed by an array on the heap.
+     * @throws IOException if an error occurred while transferring data from the channel.
+     * @throws ArithmeticException if the region to read is too large or too far from origin.
+     */
+    public Buffer readAsBuffer(final Region region) throws IOException {
+        return (Buffer) read(region, true);
+    }
+
+    /**
+     * Implementation of {@link #read(Region)} and {@link #readAsBuffer(Region)}.
+     */
+    private Object read(final Region region, final boolean asBuffer) throws IOException {
         final int contiguousDataDimension = region.contiguousDataDimension();
         final int contiguousDataLength = region.targetLength(contiguousDataDimension);
         final long[] strides = new long[region.getDimension() - contiguousDataDimension];
@@ -158,7 +178,7 @@ loop:       do {
                 }
                 break;
             } while (true);
-            return reader.dataArray();
+            return asBuffer ? reader.dataArrayAsBuffer() : reader.dataArray();
         } finally {
             reader.setDest(null);
         }
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/MemoryDataTransfer.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/MemoryDataTransfer.java
index 85c8259..a6a81db 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/MemoryDataTransfer.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/MemoryDataTransfer.java
@@ -41,7 +41,7 @@ import org.apache.sis.util.Classes;
  * {@link NullPointerException}.</div>
  *
  * @author  Martin Desruisseaux (Geomatys)
- * @version 0.7
+ * @version 1.1
  * @since   0.7
  * @module
  */
@@ -97,6 +97,7 @@ final class MemoryDataTransfer implements DataTransfer, ReadableByteChannel {
     @Override public String filename()                  {return reader.filename();}
     @Override public int    dataSizeShift()             {return reader.dataSizeShift();}
     @Override public Object dataArray()                 {return reader.dataArray();}
+    @Override public Buffer dataArrayAsBuffer()         {return reader.dataArrayAsBuffer();}
     @Override public Buffer view()                      {return reader.view();}
     @Override public Buffer createView()                {return reader.createView();}
     @Override public void   createDataArray(int length) {reader.createDataArray(length);}
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/Region.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/Region.java
index c6f817c..0bb9c80 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/Region.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/io/Region.java
@@ -92,10 +92,10 @@ public final class Region {
      *   <li>The total length of data to read does not exceed {@link Integer#MAX_VALUE}.</li>
      * </ul>
      *
-     * @param size          the number of elements along each dimension.
-     * @param regionLower   index of the first value to read or write along each dimension.
-     * @param regionUpper   index after the last value to read or write along each dimension.
-     * @param subsamplings  subsampling along each dimension. Shall be greater than zero.
+     * @param  size          the number of elements along each dimension.
+     * @param  regionLower   index of the first value to read or write along each dimension.
+     * @param  regionUpper   index after the last value to read or write along each dimension.
+     * @param  subsamplings  subsampling along each dimension. Shall be greater than zero.
      * @throws ArithmeticException if the size of the region to read exceeds {@link Integer#MAX_VALUE},
      *                             or the total hyper-cube size exceeds {@link Long#MAX_VALUE}.
      */
@@ -125,7 +125,7 @@ public final class Region {
     }
 
     /**
-     * Sets an additional offset between values at two consecutive index in the given dimension of the hyper-cube.
+     * Sets an additional offset between values at two consecutive indices in the given dimension of the hyper-cube.
      * The strides are computed automatically at construction time, but this method can be invoked in some rare cases
      * where those values need to be modified (example: for adapting to the layout of netCDF "unlimited" variable).
      *