/*
 * Copyright 1998-2014 University Corporation for Atmospheric Research/Unidata
 *
 *   Portions of this software were developed by the Unidata Program at the
 *   University Corporation for Atmospheric Research.
 *
 *   Access and use of this software shall impose the following obligations
 *   and understandings on the user. The user is granted the right, without
 *   any fee or cost, to use, copy, modify, alter, enhance and distribute
 *   this software, and any derivative works thereof, and its supporting
 *   documentation for any purpose whatsoever, provided that this entire
 *   notice appears in all copies of the software, derivative works and
 *   supporting documentation.  Further, UCAR requests that the user credit
 *   UCAR/Unidata in any publications that result from the use of this
 *   software or in any product that includes this software. The names UCAR
 *   and/or Unidata, however, may not be used in any advertising or publicity
 *   to endorse or promote any products or commercial entity unless specific
 *   written permission is obtained from UCAR/Unidata. The user also
 *   understands that UCAR/Unidata is not obligated to provide the user with
 *   any support, consulting, training or assistance of any kind with regard
 *   to the use, operation and performance of this software nor to provide
 *   the user with any updates, revisions, new versions or "bug fixes."
 *
 *   THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
 *   IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *   DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
 *   INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
 *   FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 *   NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 *   WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
 */
package org.meteoinfo.ndarray;

import java.time.LocalDateTime;

/**
 * Concrete implementation of Array specialized for Objects. Data storage is
 * with 1D java array of Objects.
 *
 * @see Array
 * @author caron
 */
public class ArrayObject extends Array {

    /** package private. use Array.factory() */
    static ArrayObject factory(DataType dtype, Class elemType, boolean isVlen, Index index) {
        return ArrayObject.factory(dtype, elemType, isVlen, index, null);
    }

    /*
     * Create new ArrayObject with given indexImpl and backing store.
     * Should be private.
     *
     * @param index use this Index
     *
     * @param stor. use this storage. if null, allocate.
     *
     * @return. new ArrayObject.D<rank> or ArrayObject object.
     */
    static ArrayObject factory(DataType dtype, Class elemType, boolean isVlen, Index index, Object[] storage) {
        if (index instanceof Index0D) {
            return new D0(dtype, elemType, isVlen, index, storage);
        } else if (index instanceof Index1D) {
            return new D1(dtype, elemType, isVlen, index, storage);
        } else if (index instanceof Index2D) {
            return new D2(dtype, elemType, isVlen, index, storage);
        } else if (index instanceof Index3D) {
            return new D3(dtype, elemType, isVlen, index, storage);
        } else if (index instanceof Index4D) {
            return new D4(dtype, elemType, isVlen, index, storage);
        } else if (index instanceof Index5D) {
            return new D5(dtype, elemType, isVlen, index, storage);
        } else if (index instanceof Index6D) {
            return new D6(dtype, elemType, isVlen, index, storage);
        } else if (index instanceof Index7D) {
            return new D7(dtype, elemType, isVlen, index, storage);
        } else {
            return new ArrayObject(dtype, elemType, isVlen, index, storage);
        }
    }

    ///////////////////////////////////////////////////////////////////////////////
    protected final boolean isVlen;
    protected final Class elementType;
    protected final Object[] storage;

    /**
     * Create a new Array of type Object and the given shape.
     * dimensions.length determines the rank of the new Array.
     *
     * @param elementType the type of element, eg String
     * @param shape the shape of the Array.
     */
    public ArrayObject(DataType dtype, Class elementType, boolean isVlen, int[] shape) {
        super(dtype, shape);
        this.elementType = elementType;
        storage = new Object[(int) indexCalc.getSize()];
        this.isVlen = isVlen;
    }


    /**
     * Create a new Array of type Object and the given shape and storage.
     * dimensions.length determines the rank of the new Array.
     *
     * @param elementType the type of element, eg String
     * @param shape the shape of the Array.
     */
    public ArrayObject(DataType dtype, Class elementType, boolean isVlen, int[] shape, Object[] storage) {
        super(dtype, shape);
        this.elementType = elementType;
        this.storage = storage;
        this.isVlen = isVlen;
    }

    /**
     * Create a new Array using the given IndexArray and backing store.
     * used for sections, and factory. Trusted package private.
     *
     * @param elementType the type of element, eg String
     * @param ima use this IndexArray as the index
     * @param data use this as the backing store. if null, allocate
     */
    ArrayObject(DataType dtype, Class elementType, boolean isVlen, Index ima, Object[] data) {
        super(dtype, ima);
        this.elementType = elementType;
        this.isVlen = isVlen;

        if (data != null) {
            storage = data;
        } else {
            storage = new Object[(int) indexCalc.getSize()];
        }
    }

    /**
     * create new Array with given indexImpl and the same backing store
     */
    protected Array createView(Index index) {
        return factory(elementType, index, storage);
    }

    /**
     * Get underlying primitive array storage. CAUTION! You may invalidate your
     * warrentee!
     * @return
     */
    public Object[] getStorage() {
        return storage;
    }

    // copy from javaArray to storage using the iterator: used by factory( Object);
    protected void copyFrom1DJavaArray(IndexIterator iter, Object javaArray) {
        Object[] ja = (Object[]) javaArray;
        for (Object aJa : ja) {
            iter.setObjectNext(aJa);
        }
    }

    // copy to javaArray from storage using the iterator: used by copyToNDJavaArray;
    protected void copyTo1DJavaArray(IndexIterator iter, Object javaArray) {
        Object[] ja = (Object[]) javaArray;
        for (int i = 0; i < ja.length; i++) {
            ja[i] = iter.getObjectNext();
        }
    }

    /**
     * Return the element class type
     * @return Element type
     */
    @Override
    public Class getElementType() {
        if (elementType == null) {
            return this.storage[0].getClass();
        }
        return elementType;
    }

    /**
     * get the value at the specified index. public Object get(Index i) { return
     * storage[i.currentElement()]; } /** set the value at the specified index.
     * public void set(Index i, Object value) { storage[i.currentElement()] =
     * value; }
     */
    /**
     * not legal, throw ForbiddenConversionException
     */
    public double getDouble(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setDouble(Index i, double value) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public float getFloat(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setFloat(Index i, float value) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public long getLong(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setLong(Index i, long value) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public int getInt(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setInt(Index i, int value) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public short getShort(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setShort(Index i, short value) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public byte getByte(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setByte(Index i, byte value) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public boolean getBoolean(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setBoolean(Index i, boolean value) {
        throw new ForbiddenConversionException();
    }
    
    /**
     * not legal, throw ForbiddenConversionException
     */
    public String getString(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setString(Index i, String value) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public Complex getComplex(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setComplex(Index i, Complex value) {
        throw new ForbiddenConversionException();
    }

    public LocalDateTime getDate(Index i) { throw new ForbiddenConversionException(); }

    public void setDate(Index i, LocalDateTime value) { throw new ForbiddenConversionException(); }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public char getChar(Index i) {
        throw new ForbiddenConversionException();
    }

    /**
     * not legal, throw ForbiddenConversionException
     */
    public void setChar(Index i, char value) {
        throw new ForbiddenConversionException();
    }

    public Object getObject(Index i) {
        return storage[i.currentElement()];
    }

    public void setObject(Index i, Object value) {
        storage[i.currentElement()] = value;
    }

    // trusted, assumes that individual dimension lengths have been checked
    // package private : mostly for iterators
    public double getDouble(int index) {
        throw new ForbiddenConversionException();
    }

    public void setDouble(int index, double value) {
        throw new ForbiddenConversionException();
    }

    public float getFloat(int index) {
        throw new ForbiddenConversionException();
    }

    public void setFloat(int index, float value) {
        throw new ForbiddenConversionException();
    }

    public long getLong(int index) {
        throw new ForbiddenConversionException();
    }

    public void setLong(int index, long value) {
        throw new ForbiddenConversionException();
    }

    public int getInt(int index) {
        throw new ForbiddenConversionException();
    }

    public void setInt(int index, int value) {
        throw new ForbiddenConversionException();
    }

    public short getShort(int index) {
        throw new ForbiddenConversionException();
    }

    public void setShort(int index, short value) {
        throw new ForbiddenConversionException();
    }

    public byte getByte(int index) {
        throw new ForbiddenConversionException();
    }

    public void setByte(int index, byte value) {
        throw new ForbiddenConversionException();
    }

    public char getChar(int index) {
        throw new ForbiddenConversionException();
    }

    public void setChar(int index, char value) {
        throw new ForbiddenConversionException();
    }

    public boolean getBoolean(int index) {
        throw new ForbiddenConversionException();
    }

    public void setBoolean(int index, boolean value) {
        throw new ForbiddenConversionException();
    }

    public String getString(int index) {
        throw new ForbiddenConversionException();
    }

    public void setString(int index, String value) {
        throw new ForbiddenConversionException();
    }

    public Complex getComplex(int index) {
        throw new ForbiddenConversionException();
    }

    public void setComplex(int index, Complex value) {
        throw new ForbiddenConversionException();
    }

    public LocalDateTime getDate(int index) { throw new ForbiddenConversionException(); }

    public void setDate(int index, LocalDateTime value) { throw new ForbiddenConversionException(); }

    public Object getObject(int index) {
        return storage[index];
    }

    public void setObject(int index, Object value) {
        storage[index] = value;
    }

    /**
     * Concrete implementation of Array specialized for Objects, rank 0.
     */
    public static class D0 extends ArrayObject {

        private Index0D ix;

        /**
         * Constructor.
         */
        public D0(DataType dtype, Class classType, boolean isVLen) {
            super(dtype, classType, isVLen, new int[]{});
            ix = (Index0D) indexCalc;
        }

        private D0(DataType dtype, Class classType, boolean isVLen, Index i, Object[] store) {
            super(dtype, classType, isVLen, i, store);
            ix = (Index0D) indexCalc;
        }

        /**
         * get the value.
         */
        public Object get() {
            return storage[ix.currentElement()];
        }

        /**
         * set the value.
         */
        public void set(Object value) {
            storage[ix.currentElement()] = value;
        }
    }

    /**
     * Concrete implementation of Array specialized for Objects, rank 1.
     */
    public static class D1 extends ArrayObject {

        private Index1D ix;

        /**
         * Constructor for array of shape {len0}.
         */
        public D1(DataType dtype, Class classType, boolean isVLen, int len0) {
            super(dtype, classType, isVLen, new int[]{len0});
            ix = (Index1D) indexCalc;
        }

        private D1(DataType dtype, Class classType, boolean isVLen, Index i, Object[] store) {
            super(dtype, classType, isVLen, i, store);
            ix = (Index1D) indexCalc;
        }

        /**
         * get the value.
         */
        public Object get(int i) {
            return storage[ix.setDirect(i)];
        }

        /**
         * set the value.
         */
        public void set(int i, Object value) {
            storage[ix.setDirect(i)] = value;
        }
    }

    /**
     * Concrete implementation of Array specialized for Objects, rank 2.
     */
    public static class D2 extends ArrayObject {

        private Index2D ix;

        /**
         * Constructor for array of shape {len0,len1}.
         */
        public D2(DataType dtype, Class classType, boolean isVLen, int len0, int len1) {
            super(dtype, classType, isVLen, new int[]{len0, len1});
            ix = (Index2D) indexCalc;
        }

        private D2(DataType dtype, Class classType, boolean isVLen, Index i, Object[] store) {
            super(dtype, classType, isVLen, i, store);
            ix = (Index2D) indexCalc;
        }

        /**
         * get the value.
         */
        public Object get(int i, int j) {
            return storage[ix.setDirect(i, j)];
        }

        /**
         * set the value.
         */
        public void set(int i, int j, Object value) {
            storage[ix.setDirect(i, j)] = value;
        }
    }

    /**
     * Concrete implementation of Array specialized for Objects, rank 3.
     */
    public static class D3 extends ArrayObject {

        private Index3D ix;

        /**
         * Constructor for array of shape {len0,len1,len2}.
         */
        public D3(DataType dtype, Class classType, boolean isVLen, int len0, int len1, int len2) {
            super(dtype, classType, isVLen, new int[]{len0, len1, len2});
            ix = (Index3D) indexCalc;
        }

        private D3(DataType dtype, Class classType, boolean isVLen, Index i, Object[] store) {
            super(dtype, classType, isVLen, i, store);
            ix = (Index3D) indexCalc;
        }

        /**
         * get the value.
         */
        public Object get(int i, int j, int k) {
            return storage[ix.setDirect(i, j, k)];
        }

        /**
         * set the value.
         */
        public void set(int i, int j, int k, Object value) {
            storage[ix.setDirect(i, j, k)] = value;
        }
    }

    /**
     * Concrete implementation of Array specialized for Objects, rank 4.
     */
    public static class D4 extends ArrayObject {

        private Index4D ix;

        /**
         * Constructor for array of shape {len0,len1,len2,len3}.
         */
        public D4(DataType dtype, Class classType, boolean isVLen, int len0, int len1, int len2, int len3) {
            super(dtype, classType, isVLen, new int[]{len0, len1, len2, len3});
            ix = (Index4D) indexCalc;
        }

        private D4(DataType dtype, Class classType, boolean isVLen, Index i, Object[] store) {
            super(dtype, classType, isVLen, i, store);
            ix = (Index4D) indexCalc;
        }

        /**
         * get the value.
         */
        public Object get(int i, int j, int k, int l) {
            return storage[ix.setDirect(i, j, k, l)];
        }

        /**
         * set the value.
         */
        public void set(int i, int j, int k, int l, Object value) {
            storage[ix.setDirect(i, j, k, l)] = value;
        }
    }

    /**
     * Concrete implementation of Array specialized for Objects, rank 5.
     */
    public static class D5 extends ArrayObject {

        private Index5D ix;

        /**
         * Constructor for array of shape {len0,len1,len2,len3,len4}.
         */
        public D5(DataType dtype, Class classType, boolean isVLen, int len0, int len1, int len2, int len3, int len4) {
            super(dtype, classType, isVLen, new int[]{len0, len1, len2, len3, len4});
            ix = (Index5D) indexCalc;
        }

        private D5(DataType dtype, Class classType, boolean isVLen, Index i, Object[] store) {
            super(dtype, classType, isVLen, i, store);
            ix = (Index5D) indexCalc;
        }

        /**
         * get the value.
         */
        public Object get(int i, int j, int k, int l, int m) {
            return storage[ix.setDirect(i, j, k, l, m)];
        }

        /**
         * set the value.
         */
        public void set(int i, int j, int k, int l, int m, Object value) {
            storage[ix.setDirect(i, j, k, l, m)] = value;
        }
    }

    /**
     * Concrete implementation of Array specialized for Objects, rank 6.
     */
    public static class D6 extends ArrayObject {

        private Index6D ix;

        /**
         * Constructor for array of shape {len0,len1,len2,len3,len4,len5,}.
         */
        public D6(DataType dtype, Class classType, boolean isVLen, int len0, int len1, int len2, int len3, int len4, int len5) {
            super(dtype, classType, isVLen, new int[]{len0, len1, len2, len3, len4, len5});
            ix = (Index6D) indexCalc;
        }

        private D6(DataType dtype, Class classType, boolean isVLen, Index i, Object[] store) {
            super(dtype, classType, isVLen, i, store);
            ix = (Index6D) indexCalc;
        }

        /**
         * get the value.
         */
        public Object get(int i, int j, int k, int l, int m, int n) {
            return storage[ix.setDirect(i, j, k, l, m, n)];
        }

        /**
         * set the value.
         */
        public void set(int i, int j, int k, int l, int m, int n, Object value) {
            storage[ix.setDirect(i, j, k, l, m, n)] = value;
        }
    }

    /**
     * Concrete implementation of Array specialized for Objects, rank 7.
     */
    public static class D7 extends ArrayObject {

        private Index7D ix;

        /**
         * Constructor for array of shape {len0,len1,len2,len3,len4,len5,len6}.
         */
        public D7(DataType dtype, Class classType, boolean isVLen, int len0, int len1, int len2, int len3, int len4, int len5, int len6) {
            super(dtype, classType, isVLen, new int[]{len0, len1, len2, len3, len4, len5, len6});
            ix = (Index7D) indexCalc;
        }

        private D7(DataType dtype, Class classType, boolean isVLen, Index i, Object[] store) {
            super(dtype, classType, isVLen, i, store);
            ix = (Index7D) indexCalc;
        }

        /**
         * get the value.
         */
        public Object get(int i, int j, int k, int l, int m, int n, int o) {
            return storage[ix.setDirect(i, j, k, l, m, n, o)];
        }

        /**
         * set the value.
         */
        public void set(int i, int j, int k, int l, int m, int n, int o, Object value) {
            storage[ix.setDirect(i, j, k, l, m, n, o)] = value;
        }
    }

}
