change: make MDAbstractArray extend Serializable

add: methods toString() and getAsFlatArray() to MDAbstractArray

SVN: 15705

base/source/java/ch/systemsx/cisd/base/mdarray/MDAbstractArray.java

@@ -16,15 +16,22 @@
 
 package ch.systemsx.cisd.base.mdarray;
 
+import java.io.Serializable;
+
+import org.apache.commons.lang.ArrayUtils;
+import org.apache.commons.lang.ClassUtils;
+
 /**
  * Base class of a multi-dimensional array. The <var>dimensions</var> of an array are provided
  * separately from the data as a <code>int[]</code>.
  * 
  * @author Bernd Rinn
  */
-public abstract class MDAbstractArray<T>
+public abstract class MDAbstractArray<T> implements Serializable
 {
 
+    private static final long serialVersionUID = 1L;
+    
     protected final int[] dimensions;
 
     protected MDAbstractArray(int[] dimensions)
@@ -90,6 +97,12 @@ public abstract class MDAbstractArray<T>
      */
     public abstract void setToObject(T value, int... indices);
 
+    /**
+     * Returns the array in flattened form. Changes to the returned object will change the
+     * multi-dimensional array directly.
+     */
+    public abstract Object getAsFlatArray();
+
     /**
      * Computes the linear index for the multi-dimensional <var>indices</var> provided.
      */
@@ -216,4 +229,25 @@ public abstract class MDAbstractArray<T>
         return intLength;
     }
 
+    //
+    // Object
+    //
+    
+    @Override
+    public String toString()
+    {
+        final int length = getLength(dimensions);
+        final StringBuilder b = new StringBuilder();
+        b.append(ClassUtils.getShortCanonicalName(this.getClass()));
+        b.append('(');
+        b.append(ArrayUtils.toString(dimensions));
+        b.append(')');
+        if (length <= 100)
+        {
+            b.append(": ");
+            b.append(ArrayUtils.toString(getAsFlatArray()));
+        }
+        return b.toString();
+    }
+
 }

base/source/java/ch/systemsx/cisd/base/mdarray/MDArray.java

@@ -26,6 +26,8 @@ import java.util.Arrays;
 public class MDArray<T> extends MDAbstractArray<T>
 {
 
+    private static final long serialVersionUID = 1L;
+
     private final T[] flattenedArray;
 
     /**
@@ -50,7 +52,7 @@ public class MDArray<T> extends MDAbstractArray<T>
 
     /**
      * Creates a {@link MDArray} from the given <var>flattenedArray</var> and <var>dimensions</var>.
-     * If <var>checkDimensions/var>} is {@code true}, it is checked that the arguments are
+     * If <var>checkDimensions</var> is {@code true}, it is checked that the arguments are
      * compatible. Convenience method if <var>dimensions</var> are available as {@code long[]}.
      */
     public MDArray(T[] flattenedArray, long[] dimensions, boolean checkdimensions)
@@ -78,7 +80,7 @@ public class MDArray<T> extends MDAbstractArray<T>
 
     /**
      * Creates a {@link MDArray} from the given <var>flattenedArray</var> and <var>dimensions</var>.
-     * If <var>checkDimensions/var>} is {@code true}, it is checked that the arguments are
+     * If <var>checkDimensions</var> is {@code true}, it is checked that the arguments are
      * compatible.
      */
     public MDArray(T[] flattenedArray, int[] dimensions, boolean checkdimensions)
@@ -127,6 +129,7 @@ public class MDArray<T> extends MDAbstractArray<T>
      * Returns the array in flattened form. Changes to the returned object will change the
      * multi-dimensional array directly.
      */
+    @Override
     public T[] getAsFlatArray()
     {
         return flattenedArray;

base/source/java/ch/systemsx/cisd/base/mdarray/MDByteArray.java

@@ -25,6 +25,8 @@ import java.util.Arrays;
  */
 public final class MDByteArray extends MDAbstractArray<Byte>
 {
+    private static final long serialVersionUID = 1L;
+    
     private final byte[] flattenedArray;
 
     /**
@@ -160,6 +162,7 @@ public final class MDByteArray extends MDAbstractArray<Byte>
      * Returns the array in flattened form. Changes to the returned object will change the
      * multi-dimensional array directly.
      */
+    @Override
     public byte[] getAsFlatArray()
     {
         return flattenedArray;

base/source/java/ch/systemsx/cisd/base/mdarray/MDDoubleArray.java

@@ -25,6 +25,8 @@ import java.util.Arrays;
  */
 public final class MDDoubleArray extends MDAbstractArray<Double>
 {
+    private static final long serialVersionUID = 1L;
+    
     private final double[] flattenedArray;
 
     /**
@@ -48,7 +50,7 @@ public final class MDDoubleArray extends MDAbstractArray<Double>
 
     /**
      * Creates a {@link MDDoubleArray} from the given <var>flattenedArray</var> and
-     * <var>dimensions</var>. If <var>checkDimensions/var>} is {@code true}, it is checked that the
+     * <var>dimensions</var>. If <var>checkDimensions</var> is {@code true}, it is checked that the
      * arguments are compatible. Convenience method if <var>dimensions</var> are available as
      * {@code long[]}.
      */
@@ -76,7 +78,7 @@ public final class MDDoubleArray extends MDAbstractArray<Double>
 
     /**
      * Creates a {@link MDDoubleArray} from the given <var>flattenedArray</var> and
-     * <var>dimensions</var>. If <var>checkDimensions/var>} is {@code true}, it is checked that the
+     * <var>dimensions</var>. If <var>checkDimensions</var> is {@code true}, it is checked that the
      * arguments are compatible.
      */
     public MDDoubleArray(double[] flattenedArray, int[] dimensions, boolean checkdimensions)
@@ -160,6 +162,7 @@ public final class MDDoubleArray extends MDAbstractArray<Double>
      * Returns the array in flattened form. Changes to the returned object will change the
      * multi-dimensional array directly.
      */
+    @Override
     public double[] getAsFlatArray()
     {
         return flattenedArray;

base/source/java/ch/systemsx/cisd/base/mdarray/MDFloatArray.java

@@ -25,6 +25,8 @@ import java.util.Arrays;
  */
 public final class MDFloatArray extends MDAbstractArray<Float>
 {
+    private static final long serialVersionUID = 1L;
+    
     private final float[] flattenedArray;
 
     /**
@@ -159,6 +161,7 @@ public final class MDFloatArray extends MDAbstractArray<Float>
      * Returns the array in flattened form. Changes to the returned object will change the
      * multi-dimensional array directly.
      */
+    @Override
     public float[] getAsFlatArray()
     {
         return flattenedArray;

base/source/java/ch/systemsx/cisd/base/mdarray/MDIntArray.java

@@ -25,6 +25,8 @@ import java.util.Arrays;
  */
 public final class MDIntArray extends MDAbstractArray<Integer>
 {
+    private static final long serialVersionUID = 1L;
+    
     private final int[] flattenedArray;
 
     /**
@@ -159,6 +161,7 @@ public final class MDIntArray extends MDAbstractArray<Integer>
      * Returns the array in flattened form. Changes to the returned object will change the
      * multi-dimensional array directly.
      */
+    @Override
     public int[] getAsFlatArray()
     {
         return flattenedArray;

base/source/java/ch/systemsx/cisd/base/mdarray/MDLongArray.java

@@ -25,6 +25,8 @@ import java.util.Arrays;
  */
 public final class MDLongArray extends MDAbstractArray<Long>
 {
+    private static final long serialVersionUID = 1L;
+    
     private final long[] flattenedArray;
 
     /**
@@ -159,6 +161,7 @@ public final class MDLongArray extends MDAbstractArray<Long>
      * Returns the array in flattened form. Changes to the returned object will change the
      * multi-dimensional array directly.
      */
+    @Override
     public long[] getAsFlatArray()
     {
         return flattenedArray;

base/source/java/ch/systemsx/cisd/base/mdarray/MDShortArray.java

@@ -25,6 +25,8 @@ import java.util.Arrays;
  */
 public final class MDShortArray extends MDAbstractArray<Short>
 {
+    private static final long serialVersionUID = 1L;
+    
     private final short[] flattenedArray;
 
     /**
@@ -159,6 +161,7 @@ public final class MDShortArray extends MDAbstractArray<Short>
      * Returns the array in flattened form. Changes to the returned object will change the
      * multi-dimensional array directly.
      */
+    @Override
     public short[] getAsFlatArray()
     {
         return flattenedArray;

base/sourceTest/java/ch/systemsx/cisd/base/mdarray/MDArraytest.java

@@ -35,6 +35,8 @@ public class MDArraytest
 
     static class TestMDArray extends MDAbstractArray<Void>
     {
+        private static final long serialVersionUID = 1L;
+
         protected TestMDArray(int[] shape)
         {
             super(shape);
@@ -56,6 +58,12 @@ public class MDArraytest
         {
             return 0;
         }
+
+        @Override
+        public Object getAsFlatArray()
+        {
+            return null;
+        }
     }
 
     @Test