Interface GettersAndSetters

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.math.BigDecimal getAsBigDecimal​(long... coordinates)  
      java.math.BigInteger getAsBigInteger​(long... coordinates)  
      boolean getAsBoolean​(long... coordinates)
      Returns a byte representation of an entry in the matrix.
      byte getAsByte​(long... coordinates)
      Returns a byte representation of an entry in the matrix.
      byte[] getAsByteArray​(long... coordinates)
      Returns a byte array representation of an entry in the matrix.
      char getAsChar​(long... coordinates)
      Returns a char representation of an entry in the matrix.
      java.util.Date getAsDate​(long... coordinates)
      Returns a Date representation of an entry in the matrix.
      double getAsDouble​(long... coordinates)
      Returns a double representation of an entry in the matrix.
      float getAsFloat​(long... coordinates)
      Returns a float representation of an entry in the matrix.
      int getAsInt​(long... coordinates)
      Returns an int representation of an entry in the matrix.
      long getAsLong​(long... coordinates)
      Returns a long representation of an entry in the matrix.
      Matrix getAsMatrix​(long... coordinates)  
      java.lang.Object getAsObject​(long... coordinates)
      Returns a raw entry in the matrix as it is stored.
      short getAsShort​(long... coordinates)
      Returns a short representation of an entry in the matrix.
      java.lang.String getAsString​(long... coordinates)
      Returns a String representation of an entry in the matrix.
      java.lang.Object getPreferredObject​(long... coordinates)
      Returns a representation of the entry in the matrix that reflects the true object best.
      void setAsBigDecimal​(java.math.BigDecimal value, long... coordinates)  
      void setAsBigInteger​(java.math.BigInteger value, long... coordinates)  
      void setAsBoolean​(boolean value, long... coordinates)
      Sets an entry in the matrix to a boolean value.
      void setAsByte​(byte value, long... coordinates)
      Sets an entry in the matrix to a byte value.
      void setAsByteArray​(byte[] value, long... coordinates)
      Sets an entry in the matrix to a byte array.
      void setAsChar​(char value, long... coordinates)
      Sets an entry in the matrix to a char value.
      void setAsDate​(java.util.Date date, long... coordinates)
      Sets an entry in the matrix to a Date value.
      void setAsDouble​(double value, long... coordinates)
      Sets an entry in the matrix to a double value.
      void setAsFloat​(float value, long... coordinates)
      Sets an entry in the matrix to a float value.
      void setAsInt​(int value, long... coordinates)
      Sets an entry in the matrix to an int value.
      void setAsLong​(long value, long... coordinates)
      Sets an entry in the matrix to a long value.
      void setAsMatrix​(Matrix m, long... coordinates)  
      void setAsObject​(java.lang.Object o, long... coordinates)
      Sets an entry in the matrix to an object.
      void setAsShort​(short value, long... coordinates)
      Sets an entry in the matrix to a short value.
      void setAsString​(java.lang.String string, long... coordinates)
      Sets an entry in the matrix to a String value.
      java.math.BigDecimal[][] toBigDecimalArray()  
      java.math.BigInteger[][] toBigIntegerArray()  
      boolean[][] toBooleanArray()
      Converts the content of a matrix into a 2-dimensional array of boolean values.
      byte[][] toByteArray()
      Converts the content of a matrix into a 2-dimensional array of byte values.
      char[][] toCharArray()
      Converts the content of a matrix into a 2-dimensional array of char values.
      java.util.Date[][] toDateArray()
      Converts the content of a matrix into a 2-dimensional array of Date values.
      double[][] toDoubleArray()
      Converts the content of a matrix into a 2-dimensional array of double values.
      float[][] toFloatArray()
      Converts the content of a matrix into a 2-dimensional array of float values.
      int[][] toIntArray()
      Converts the content of a matrix into a 2-dimensional array of int values.
      long[][] toLongArray()
      Converts the content of a matrix into a 2-dimensional array of long values.
      java.lang.Object[][] toObjectArray()
      Converts the content of a matrix into a 2-dimensional array of Objects.
      short[][] toShortArray()
      Converts the content of a matrix into a 2-dimensional array of short values.
      java.lang.String[][] toStringArray()
      Converts the content of a matrix into a 2-dimensional array of Strings.
    • Method Detail

      • getAsDouble

        double getAsDouble​(long... coordinates)
        Returns a double representation of an entry in the matrix. The stored value will be converted to a double as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a double representation of the entry @
      • setAsDouble

        void setAsDouble​(double value,
                         long... coordinates)
        Sets an entry in the matrix to a double value. If the matrix cannot store double values, the value will be represented as good as possible.
        Parameters:
        value - double value
        coordinates - location of the entry @
      • getAsObject

        java.lang.Object getAsObject​(long... coordinates)
        Returns a raw entry in the matrix as it is stored. If the matrix supports Generics, the return type will match the type that is stored.
        Parameters:
        coordinates - location of the entry
        Returns:
        entry object @
      • setAsObject

        void setAsObject​(java.lang.Object o,
                         long... coordinates)
        Sets an entry in the matrix to an object. If the matrix cannot store this object type, the value will be represented as good as possible.
        Parameters:
        o - the object to store
        coordinates - location of the entry @
      • getAsString

        java.lang.String getAsString​(long... coordinates)
        Returns a String representation of an entry in the matrix. The stored value will be converted to a String as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a String representation of the entry @
      • setAsString

        void setAsString​(java.lang.String string,
                         long... coordinates)
        Sets an entry in the matrix to a String value. If the matrix cannot store Strings, the value will be represented as good as possible.
        Parameters:
        value - String value
        coordinates - location of the entry @
      • toDoubleArray

        double[][] toDoubleArray()
        Converts the content of a matrix into a 2-dimensional array of double values.
        Returns:
        double array with matrix entries @
      • getAsByte

        byte getAsByte​(long... coordinates)
        Returns a byte representation of an entry in the matrix. The stored value will be converted to a byte as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a byte representation of the entry @
      • getAsByteArray

        byte[] getAsByteArray​(long... coordinates)
        Returns a byte array representation of an entry in the matrix. The stored value will be converted to a byte array as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a byte array representation of the entry @
      • setAsByte

        void setAsByte​(byte value,
                       long... coordinates)
        Sets an entry in the matrix to a byte value. If the matrix cannot store byte values, the value will be represented as good as possible.
        Parameters:
        value - byte value
        coordinates - location of the entry @
      • setAsByteArray

        void setAsByteArray​(byte[] value,
                            long... coordinates)
        Sets an entry in the matrix to a byte array. If the matrix cannot store byte array, the value will be represented as good as possible.
        Parameters:
        value - byte array
        coordinates - location of the entry @
      • toBooleanArray

        boolean[][] toBooleanArray()
        Converts the content of a matrix into a 2-dimensional array of boolean values.
        Returns:
        boolean array with matrix entries @
      • toBigDecimalArray

        java.math.BigDecimal[][] toBigDecimalArray()
      • toBigIntegerArray

        java.math.BigInteger[][] toBigIntegerArray()
      • toByteArray

        byte[][] toByteArray()
        Converts the content of a matrix into a 2-dimensional array of byte values.
        Returns:
        byte array with matrix entries @
      • getAsBoolean

        boolean getAsBoolean​(long... coordinates)
        Returns a byte representation of an entry in the matrix. The stored value will be converted to a boolean as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a boolean representation of the entry @
      • getAsBigInteger

        java.math.BigInteger getAsBigInteger​(long... coordinates)
      • getAsBigDecimal

        java.math.BigDecimal getAsBigDecimal​(long... coordinates)
      • setAsBoolean

        void setAsBoolean​(boolean value,
                          long... coordinates)
        Sets an entry in the matrix to a boolean value. If the matrix cannot store byte values, the value will be represented as good as possible.
        Parameters:
        value - boolean value
        coordinates - location of the entry @
      • setAsBigInteger

        void setAsBigInteger​(java.math.BigInteger value,
                             long... coordinates)
      • setAsBigDecimal

        void setAsBigDecimal​(java.math.BigDecimal value,
                             long... coordinates)
      • getAsChar

        char getAsChar​(long... coordinates)
        Returns a char representation of an entry in the matrix. The stored value will be converted to a char as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a char representation of the entry @
      • setAsChar

        void setAsChar​(char value,
                       long... coordinates)
        Sets an entry in the matrix to a char value. If the matrix cannot store char values, the value will be represented as good as possible.
        Parameters:
        value - char value
        coordinates - location of the entry @
      • toCharArray

        char[][] toCharArray()
        Converts the content of a matrix into a 2-dimensional array of char values.
        Returns:
        char array with matrix entries @
      • getAsDate

        java.util.Date getAsDate​(long... coordinates)
        Returns a Date representation of an entry in the matrix. The stored value will be converted to a Date object as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a String representation of the entry @
      • setAsDate

        void setAsDate​(java.util.Date date,
                       long... coordinates)
        Sets an entry in the matrix to a Date value. If the matrix cannot store Date objects, the value will be represented as good as possible.
        Parameters:
        value - Date object to store
        coordinates - location of the entry @
      • toDateArray

        java.util.Date[][] toDateArray()
        Converts the content of a matrix into a 2-dimensional array of Date values.
        Returns:
        Date array with matrix entries @
      • getAsFloat

        float getAsFloat​(long... coordinates)
        Returns a float representation of an entry in the matrix. The stored value will be converted to a float as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a float representation of the entry @
      • setAsFloat

        void setAsFloat​(float value,
                        long... coordinates)
        Sets an entry in the matrix to a float value. If the matrix cannot store float values, the value will be represented as good as possible.
        Parameters:
        value - float value
        coordinates - location of the entry @
      • toFloatArray

        float[][] toFloatArray()
        Converts the content of a matrix into a 2-dimensional array of float values.
        Returns:
        float array with matrix entries @
      • getAsInt

        int getAsInt​(long... coordinates)
        Returns an int representation of an entry in the matrix. The stored value will be converted to an int as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        an int representation of the entry @
      • setAsInt

        void setAsInt​(int value,
                      long... coordinates)
        Sets an entry in the matrix to an int value. If the matrix cannot store int values, the value will be represented as good as possible.
        Parameters:
        value - int value
        coordinates - location of the entry @
      • toIntArray

        int[][] toIntArray()
        Converts the content of a matrix into a 2-dimensional array of int values.
        Returns:
        int array with matrix entries @
      • getAsLong

        long getAsLong​(long... coordinates)
        Returns a long representation of an entry in the matrix. The stored value will be converted to a long as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a long representation of the entry @
      • setAsLong

        void setAsLong​(long value,
                       long... coordinates)
        Sets an entry in the matrix to a long value. If the matrix cannot store long values, the value will be represented as good as possible.
        Parameters:
        value - long value
        coordinates - location of the entry @
      • toLongArray

        long[][] toLongArray()
        Converts the content of a matrix into a 2-dimensional array of long values.
        Returns:
        long array with matrix entries @
      • toObjectArray

        java.lang.Object[][] toObjectArray()
        Converts the content of a matrix into a 2-dimensional array of Objects.
        Returns:
        Object array with matrix entries @
      • getAsShort

        short getAsShort​(long... coordinates)
        Returns a short representation of an entry in the matrix. The stored value will be converted to a short as good as possible.
        Parameters:
        coordinates - location of the entry
        Returns:
        a short representation of the entry @
      • setAsShort

        void setAsShort​(short value,
                        long... coordinates)
        Sets an entry in the matrix to a short value. If the matrix cannot store short values, the value will be represented as good as possible.
        Parameters:
        value - short value
        coordinates - location of the entry @
      • toShortArray

        short[][] toShortArray()
        Converts the content of a matrix into a 2-dimensional array of short values.
        Returns:
        short array with matrix entries @
      • toStringArray

        java.lang.String[][] toStringArray()
        Converts the content of a matrix into a 2-dimensional array of Strings.
        Returns:
        String array with matrix entries @
      • getPreferredObject

        java.lang.Object getPreferredObject​(long... coordinates)
        Returns a representation of the entry in the matrix that reflects the true object best. E.g. if the entry is a String "-5.3", this method returns a double with the equivalent value. For a String "text" the string itself is returned.
        Parameters:
        coordinates - location of the entry
        Returns:
        object that represents the matrix entry best @
      • getAsMatrix

        Matrix getAsMatrix​(long... coordinates)
      • setAsMatrix

        void setAsMatrix​(Matrix m,
                         long... coordinates)