Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.fmap.dal.feature.impl;

import java.lang.ref.WeakReference;

import java.util.ArrayList;

import java.util.Date;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import org.apache.commons.lang3.StringUtils;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataTypes;

import org.gvsig.fmap.dal.exception.DataEvaluatorRuntimeException;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.feature.DataProfile;

import org.gvsig.fmap.dal.feature.EditableFeature;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.dal.feature.FeatureAttributeDescriptor;

import org.gvsig.fmap.dal.feature.FeatureAttributeEmulator;

import org.gvsig.fmap.dal.feature.FeatureAttributeGetter;

import org.gvsig.fmap.dal.feature.FeatureReference;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.dal.feature.FeatureType;

import org.gvsig.fmap.dal.feature.exception.IllegalValueException;

import org.gvsig.fmap.dal.feature.exception.SetReadOnlyAttributeException;

import org.gvsig.fmap.dal.feature.impl.dynobjectutils.DynObjectFeatureFacade;

import org.gvsig.fmap.dal.feature.spi.DefaultFeatureProvider;

import org.gvsig.fmap.dal.feature.spi.FeatureProvider;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.timesupport.Instant;

import org.gvsig.timesupport.Interval;

import org.gvsig.timesupport.Time;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dataTypes.CoercionException;

import org.gvsig.tools.dataTypes.DataTypesManager;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.evaluator.Evaluator;

import org.gvsig.tools.evaluator.EvaluatorData;

import org.gvsig.tools.evaluator.EvaluatorException;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.exception.BaseRuntimeException;

import org.gvsig.tools.lang.Cloneable;

public class DefaultFeature implements Feature, EvaluatorData, Cloneable {

        private static DataTypesManager dataTypesManager = null;

        protected FeatureProvider data;

        protected FeatureReference reference;

        private WeakReference storeRef;

        private boolean inserted = false;

    /*

         * Usar con mucha precaucion o mejor no usar. Lo precisa el

         * DefaultFeatureSet en la ordenacion.

         */

        public DefaultFeature(FeatureStore store) {

                this.storeRef = new WeakReference(store);

                this.reference = null;

        }

        public DefaultFeature(FeatureStore store, FeatureProvider data) {

                this.data = data;

                this.storeRef = new WeakReference(store);

                this.reference = null;

                this.inserted = !data.isNew();

        }

        DefaultFeature(DefaultFeature feature) {

                this.data = feature.data.getCopy();

                this.storeRef = feature.storeRef;

                this.reference = feature.reference;

                this.inserted = feature.isInserted();

        }

    public DefaultFeature(FeatureType targetType, Feature sourceFeature) {

        DefaultFeature defaultFeature = (DefaultFeature)sourceFeature;

        this.data = new DefaultFeatureProvider(targetType, (DefaultFeatureProvider)defaultFeature.getData());

        this.storeRef = defaultFeature.storeRef;

        this.reference = defaultFeature.reference;

        this.inserted = defaultFeature.isInserted();

        FeatureType sourceType = sourceFeature.getType();

        for (FeatureAttributeDescriptor targetAttrDescriptor : targetType) {

            if ( targetAttrDescriptor.isAutomatic() ||

                 targetAttrDescriptor.isReadOnly() ||

                 targetAttrDescriptor.getEvaluator() != null) {

                 continue;

            }

            int sourceIndex = sourceType.getIndex(targetAttrDescriptor.getName());

            if (sourceIndex<0){

                continue;

            }

            Object value = sourceFeature.get(sourceIndex);

            if (value == null && !targetAttrDescriptor.allowNull()) {

                continue;

            }

            this.set(targetAttrDescriptor,value);

        }

    }

        public void setData(FeatureProvider data) {

                this.data = data;

                this.reference = null;

                this.inserted = true;

        }

        public FeatureProvider getData() {

                return this.data;

        }

        protected DataTypesManager getDataTypesManager() {

                if( dataTypesManager==null ) {

                        dataTypesManager = ToolsLocator.getDataTypesManager();

                }

                return dataTypesManager;

        }

    void set(FeatureAttributeDescriptor attribute, Object value) {

        int i = attribute.getIndex();

        if ( attribute.isReadOnly() ) {

            throw new SetReadOnlyAttributeException(attribute.getName(), this.getType());

        }

        FeatureAttributeEmulator emulator = attribute.getFeatureAttributeEmulator();

        if( emulator!= null ) {

            emulator.set((EditableFeature) this,value);

            return;

        }

        if ( value == null ) {

            if ( !attribute.allowNull() ) {

                if ( !attribute.isAutomatic() ) {

                    throw new IllegalValueException(attribute, value);

                }

            }

            this.data.set(i, null);

            return;

        }

        if ( attribute.getFeatureAttributeGetter() != null ) {

            value = attribute.getFeatureAttributeGetter().setter(value);

        }

        Class objectClass = attribute.getObjectClass();

        if( objectClass!=null ) {

            if ( objectClass.isInstance(value) ) {

                this.data.set(i, value);

                return;

            }

            if ( !objectClass.isInstance(value) ) {

                try {

                    value

                            = this.getDataTypesManager().coerce(attribute.getType(),

                                    value);

                } catch (CoercionException e) {

                    throw new IllegalArgumentException("Can't convert to "

                            + this.getDataTypesManager().getTypeName(

                                    attribute.getType()) + " from '"

                            + value.getClass().getName() + "' with value '"

                            + value.toString() + "'.");

                }

            }

        }

        this.data.set(i, value);

    }

    private Object get(int index,Class theClass, int type) {

        Object value = this.get(index);

        if( theClass.isInstance(value) ) {

            return value;

        }

        try {

            return this.getDataTypesManager().coerce(type, value);

        } catch (CoercionException e) {

            if (value == null) {

                return null;

            }

            throw new IllegalArgumentException(

                    "Can't convert to "+theClass.getName()+

                    " from '"+value.getClass().getName()+

                    "' with value '"+value.toString()+"'.");

        }

    }

    public void initializeValues() {

        FeatureType type = this.getType();

        for (FeatureAttributeDescriptor attribute : type) {

            if (attribute.isAutomatic() || attribute.isReadOnly()

                    || attribute.isComputed() ) {

                continue;

            }

            if (attribute.getDefaultValue() == null && !attribute.allowNull()) {

                continue;

            }

            this.set(attribute, attribute.getDefaultValue());

        }

    }

    public void clear() {

        initializeValues();

    }

    public void initializeValues(Feature feature) {

        FeatureType myType=this.getType();

        FeatureType type =feature.getType();

        for (FeatureAttributeDescriptor attribute : type) {

            FeatureAttributeDescriptor myAttribute=myType.getAttributeDescriptor(attribute.getName());

            if (myAttribute != null) {

                this.set(myAttribute, feature.get(attribute.getIndex()));

            }

        }

    }

    @Override

    public FeatureStore getStore() {

        return (FeatureStore) this.storeRef.get();

    }

    @Override

    public FeatureType getType() {

        return this.data.getType();

    }

    @Override

    public EditableFeature getEditable() {

        return new DefaultEditableFeature(this);

    }

    @Override

    public Feature getCopy() {

        return new DefaultFeature(this);

    }

    @Override

    @SuppressWarnings("CloneDoesntCallSuperClone")

    public Object clone() throws CloneNotSupportedException {

        return new DefaultFeature(this);

    }

    @Override

    public FeatureReference getReference() {

        if (this.reference == null) {

            if (!isInserted()) {

                return null;

            }

            reference = new DefaultFeatureReference(this);

        }

        return this.reference;

    }

    class UnableToGetReferenceException extends BaseRuntimeException {

        /**

         *

         */

        private static final long serialVersionUID = 1812805035204824163L;

        /**

         * @param exception

         */

        public UnableToGetReferenceException(BaseException exception) {

            super("Unable to get reference", "_UnableToGetReferenceException",

                serialVersionUID);

            this.initCause(exception);

        }

    }

    @Override

    public void validate(int mode) throws DataException  {

        ((DefaultFeatureType) this.data.getType()).validateFeature(this, mode);

    }

    @Override

    public List getSRSs() {

        // TODO Auto-generated method stub

        return null;

    }

    @Override

    public Envelope getDefaultEnvelope() {

        Envelope envelope = this.data.getDefaultEnvelope();

        if( envelope == null ) {

            Geometry geom = this.getDefaultGeometry();

            if( geom!=null ) {

                envelope = geom.getEnvelope();

            }

        }

        return envelope;

    }

    @Override

    public Geometry getDefaultGeometry() {

            Geometry geom = this.data.getDefaultGeometry();

        if( geom == null ) {

            int i = this.data.getType().getDefaultGeometryAttributeIndex();

            Object x = this.get(i);

            if( x instanceof Geometry ) {

                geom = (Geometry) x;

            } else {

                geom = this.getGeometry(i);

            }

        }

        if( geom != null ) {

            if( geom.getProjection()==null ) {

                FeatureType type = this.getType();

                DefaultFeatureAttributeDescriptor attrdesc = (DefaultFeatureAttributeDescriptor) type.get(type.getDefaultGeometryAttributeIndex());

                IProjection proj = attrdesc.getSRS(this.storeRef);

                geom.setProjection(proj);

            }

        }

        return geom;

    }

    @Override

    public Time getDefaultTime() {

            Time time = this.data.getDefaultTime();

        if( time == null ) {

            int i = this.data.getType().getDefaultTimeAttributeIndex();

            Object x = this.get(i);

            if( x instanceof Time ) {

                time = (Time) x;

            } else {

                time = this.getTime(i);

            }

        }

        return time;

    }

    @Override

    public IProjection getDefaultSRS() {

        IProjection srs = this.data.getType().getDefaultSRS();

        if( srs == null ) {

            FeatureType type = this.getType();

            DefaultFeatureAttributeDescriptor attrdesc = (DefaultFeatureAttributeDescriptor) type.get(type.getDefaultGeometryAttributeIndex());

            srs = attrdesc.getSRS(this.storeRef);

        }

        return srs;

    }

    @Override

    public List getGeometries() {

        // TODO Auto-generated method stub

        return null;

    }

    @Override

    public Object getFromProfile(int index) {

        FeatureAttributeDescriptor descriptor = this.data.getType().getAttributeDescriptor(index);

        Object value = this.get(index);

        String profileName = descriptor.getDataProfileName();

        if( StringUtils.isBlank(profileName) ) {

            return value;

        }

        DataProfile profile = DALLocator.getDataManager().getDataProfile(profileName);

        if( profile==null ) {

            return value;

        }

        return profile.createData(value, descriptor.getTags());

    }

    @Override

    public Object getFromProfile(String name) {

        FeatureAttributeDescriptor descriptor = this.data.getType().getAttributeDescriptor(name);

        return this.getFromProfile(descriptor.getIndex());

    }

    @Override

    public Object get(String name) {

        int index = this.data.getType().getIndex(name);

        if( index < 0 ) {

            throw new IllegalArgumentException("Attribute name '"+name+"' not found in the feature.");

        }

        return this.get(index);

    }

    public boolean has_key(String key) {

        Object x = this.getType().get(key);

        return x != null;

    }

    public List<String> keys() {

        List<String> ks = new ArrayList<>();

        for( FeatureAttributeDescriptor attr : this.getType()) {

            ks.add(attr.getName());

        }

        return ks;

    }

    public Iterator<String> iterkeys() {

        final Iterator it = this.getType().iterator();

        return new Iterator<String>() {

            @Override

            public boolean hasNext() {

                return it.hasNext();

            }

            @Override

            public String next() {

                return ((FeatureAttributeDescriptor)it.next()).getName();

            }

            @Override

            public void remove() {

                throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.

            }

        };

    }

    public Iterator iteritems() {

        final Iterator it = this.getType().iterator();

        return new Iterator<Map.Entry>() {

            @Override

            public boolean hasNext() {

                return it.hasNext();

            }

            @Override

            public Map.Entry next() {

                final String name = ((FeatureAttributeDescriptor)it.next()).getName();

                return new Map.Entry<String, Object>() {

                    @Override

                    public String getKey() {

                        return name;

                    }

                    @Override

                    public Object getValue() {

                        return get(name);

                    }

                    @Override

                    public Object setValue(Object value) {

                        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.

                    }

                };

            }

            @Override

            public void remove() {

                throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.

            }

        };

    }

    @Override

    public Object get(int index) {

        FeatureType type = this.data.getType();

        if( index <0 || index >= type.size() ) {

            throw new IllegalArgumentException("Attribute index '"+index+"' out of range (0 to "+this.data.getType().size()+".");

        }

        FeatureAttributeDescriptor attribute = type.getAttributeDescriptor(index);

        if (!this.data.getType().hasEvaluators()) {

            return get(attribute, this.data.get(index));

        }

        Evaluator eval = attribute.getEvaluator();

        if (eval == null) {

            return this.data.get(index);

        } else {

            Object value = this.data.get(index);

            if (value != null) { // FIXME: para comprobar si esta calculado usar

                // un array

                // especifico.

                return get(attribute, this.data.get(index));

            }

            try {

                value = eval.evaluate(this);

            } catch (EvaluatorException e) {

                throw new DataEvaluatorRuntimeException(e);

            }

            this.data.set(index, value);

            return  get(attribute, value);

        }

    }

    private Object get(FeatureAttributeDescriptor featureAttributeDescriptor, Object value){

        FeatureAttributeEmulator emulator = featureAttributeDescriptor.getFeatureAttributeEmulator();

        if( emulator != null ) {

//            int index = featureAttributeDescriptor.getIndex();

//            value = this.data.get(index);

//            if( value==null ) {

                value = emulator.get(this);

//                this.data.set(index,value);

//            }

        } else {

            FeatureAttributeGetter getter = featureAttributeDescriptor.getFeatureAttributeGetter();

            if( getter != null ) {

                value = getter.getter(value);

            }

        }

        if( featureAttributeDescriptor.getType()==DataTypes.GEOMETRY ) {

            if( value != null ) {

                Geometry geom = (Geometry)value;

                if( geom.getProjection()==null ) {

                    IProjection proj = ((DefaultFeatureAttributeDescriptor)featureAttributeDescriptor).getSRS(this.storeRef);

                    geom.setProjection(proj);

                }

            }

        }

        return value;

    }

    @Override

    public byte[] getByteArray(String name) {

        return this.getByteArray(this.data.getType().getIndex(name));

    }

    @Override

    public byte[] getByteArray(int index) {

        return (byte[]) this.get(index);

    }

    @Override

    public Object[] getArray(String name) {

        return this.getArray(this.data.getType().getIndex(name));

    }

    @Override

    public Object[] getArray(int index) {

        return (Object[]) this.get(index);

    }

    @Override

    public boolean getBoolean(String name) {

        return this.getBoolean(this.data.getType().getIndex(name));

    }

    @Override

    public boolean getBoolean(int index) {

        Boolean value = ((Boolean) this.get(index,Boolean.class,DataTypes.BOOLEAN));

        if (value == null) {

            return false;

        }

        return value;

    }

    @Override

    public byte getByte(String name) {

        return this.getByte(this.data.getType().getIndex(name));

    }

    @Override

    public byte getByte(int index) {

        Byte value = ((Byte) this.get(index,Byte.class,DataTypes.BYTE));

        if (value == null) {

            return 0;

        }

        return value;

    }

    @Override

    public Date getDate(String name) {

        return this.getDate(this.data.getType().getIndex(name));

    }

    @Override

    public Date getDate(int index) {

        Date value = ((Date) this.get(index,Date.class,DataTypes.DATE));

        return value;

    }

    @Override

    public double getDouble(String name) {

        return this.getDouble(this.data.getType().getIndex(name));

    }

    @Override

    public double getDouble(int index) {

        Double value = ((Double) this.get(index,Double.class,DataTypes.DOUBLE));

        if (value == null) {

            return 0;

        }

        return value;

    }

    @Override

    public Feature getFeature(String name) {

        return this.getFeature(this.data.getType().getIndex(name));

    }

    @Override

    public Feature getFeature(int index) {

        return (Feature) this.get(index);

    }

    @Override

    public float getFloat(String name) {

        return this.getFloat(this.data.getType().getIndex(name));

    }

    @Override

    public float getFloat(int index) {

        Float value = ((Float) this.get(index,Float.class,DataTypes.FLOAT));

        if (value == null) {

            return 0;

        }

        return value;

    }

    @Override

    public Geometry getGeometry(String name) {

        return this.getGeometry(this.data.getType().getIndex(name));

    }

    @Override

    public Geometry getGeometry(int index) {

        return (Geometry) this.get(index,Geometry.class,DataTypes.GEOMETRY);

    }

    @Override

    public int getInt(String name) {

        return this.getInt(this.data.getType().getIndex(name));

    }

    @Override

    public int getInt(int index) {

        Integer value = ((Integer) this.get(index,Integer.class,DataTypes.INT));

        if (value == null) {

            return 0;

        }

        return value;

    }

    @Override

    public long getLong(String name) {

        return this.getLong(this.data.getType().getIndex(name));

    }

    @Override

    public long getLong(int index) {

        Long value = ((Long) this.get(index,Long.class,DataTypes.LONG));

        if (value == null) {

            return 0;

        }

        return value;

    }

    @Override

    public String getString(String name) {

        return this.getString(this.data.getType().getIndex(name));

    }

    @Override

    public String getString(int index) {

        return (String) this.get(index,String.class,DataTypes.STRING);

    }

    @Override

    public Object getContextValue(String name) {

        name = name.toLowerCase();

        if (name.equals("store")) {

            return this.getStore();

        }

        if (name.equals("featuretype")) {

            return this.data.getType();

        }

        if (name.equals("feature")) {

            return this;

        }

        throw new IllegalArgumentException(name);

    }

    @Override

    public Iterator getDataNames() {

        class DataNamesIterator implements Iterator {

            Iterator attributeIteraror;

            DataNamesIterator(DefaultFeature feature) {

                this.attributeIteraror = feature.getType().iterator();

            }

            @Override

            public boolean hasNext() {

                return this.attributeIteraror.hasNext();

            }

            @Override

            public Object next() {

                return ((FeatureAttributeDescriptor) this.attributeIteraror

                        .next()).getName();

            }

            @Override

            public void remove() {

                throw new UnsupportedOperationException();

            }

        }

        return new DataNamesIterator(this);

    }

    @Override

    public Object getDataValue(String name) {

        name = name.toLowerCase();

        try {

            return get(name);

        } catch (IllegalArgumentException ex) {

            if( "defaultgeometry".equalsIgnoreCase(name )) {

                return this.getDefaultGeometry();

            }

            throw ex;

        }

    }

    @Override

    public Iterator getDataValues() {

        class DataValuesIterator implements Iterator {

            DefaultFeature feature;

            int current = 0;

            DataValuesIterator(DefaultFeature feature) {

                this.feature = feature;

            }

            @Override

            public boolean hasNext() {

                return current < feature.getType().size() - 1;

            }

            @Override

            public Object next() {

                return feature.get(current++);

            }

            @Override

            public void remove() {

                throw new UnsupportedOperationException();

            }

        }

        return new DataValuesIterator(this);

    }

    @Override

    public boolean hasContextValue(String name) {

        name = name.toLowerCase();

        if (name.equals("store")) {

            return true;

        }

        if (name.equals("featuretype")) {

            return true;

        }

        return name.equals("feature");

    }

    @Override

    public boolean hasDataValue(String name) {

        name = name.toLowerCase();

        return this.data.getType().getIndex(name) >= 0;

    }

    @Override

    public Time getTime(int index) {

        return ((Time) this.get(index,Time.class,DataTypes.INSTANT));

    }

    @Override

    public Time getTime(String name) {

        return this.getInstant(this.data.getType().getIndex(name));

    }

    @Override

    public Instant getInstant(int index) {

        return ((Instant) this.get(index,Instant.class,DataTypes.INSTANT));

    }

    @Override

    public Instant getInstant(String name) {

        return this.getInstant(this.data.getType().getIndex(name));

    }

    @Override

    public Interval getInterval(int index) {

        return ((Interval) this.get(index,Interval.class,DataTypes.INTERVAL));

    }

    @Override

    public Interval getInterval(String name) {

        return this.getInterval(this.data.getType().getIndex(name));

    }

    @Override

    public DynObject getAsDynObject() {

        DynObjectFeatureFacade facade = new DynObjectFeatureFacade(this);

        return facade;

    }

    @Override

    public String toString() {

            StringBuilder builder = new StringBuilder();

        FeatureAttributeDescriptor[] attributeDescriptors =

            getType().getAttributeDescriptors();

        for (int i = 0; i < attributeDescriptors.length; i++) {

            String name = attributeDescriptors[i].getName();

            builder.append(get(name));

            if (i < attributeDescriptors.length - 1) {

                builder.append(", ");

            }

        }

        return builder.toString();

    }

        /**

     * @return the inserted

     */

    public boolean isInserted() {

        return inserted;

    }

    /**

     * @param inserted the inserted to set

     */

    public void setInserted(boolean inserted) {

        this.inserted = inserted;

    }

        @Override

    public EvaluatorData getEvaluatorData() {

        return this;

    }

    public int size() {

        return this.data.getType().size();

    }

    public boolean isEmpty() {

        return false;

    }

    public Iterator<String> iterator() {

        final Iterator<FeatureAttributeDescriptor> x = this.data.getType().iterator();

        return new Iterator<String>() {

            @Override

            public boolean hasNext() {

                return x.hasNext();

            }

            @Override

            public String next() {

                return x.next().getName();

            }

        };

    }

    public boolean containsKey(String key) {

        return this.data.getType().get(key)!=null;

    }

}