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.featureset;

import java.util.ArrayList;

import java.util.Collections;

import java.util.Iterator;

import java.util.List;

import java.util.NoSuchElementException;

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

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

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

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

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

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

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

import org.gvsig.fmap.dal.feature.FeatureQueryOrder.FeatureQueryOrderMember;

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

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

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

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

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

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

import org.gvsig.fmap.dal.feature.impl.DefaultFeatureStore;

import org.gvsig.fmap.dal.feature.impl.DefaultFeatureStoreTransforms;

import org.gvsig.fmap.dal.feature.impl.DefaultFeatureType;

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

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dispose.DisposableIterator;

import org.gvsig.tools.dispose.DisposeUtils;

import org.gvsig.tools.evaluator.Evaluator;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.observer.Observer;

public class DefaultFeatureSet extends AbstractFeatureSet implements

    FeatureSet, Observer {

    protected static final int NO_CHECKED = -1;

    protected static final int DEFAULT = 0;

    protected static final int FILTERED = 1;

    protected static final int ORDERED = 2;

    protected static final int ORDERED_FILTERED = 3;

    protected static final int EDITED = 4;

    protected static final int EDITED_FILTERED = 5;

    protected static final int ORDERD_EDITED = 6;

    protected static final int ORDERED_EDITED_FILTER = 7;

    protected Throwable sourceStoreModifiedCause;

    protected boolean sourceStoreModified;

    protected boolean ownFeaturesModified;

    protected DefaultFeatureStore store;

    protected List featureTypes;

    protected FeatureQuery query;

    protected FeatureSetProvider provider;

    protected long size;

    protected int iteratorMode;

    protected List orderedData;

    protected Feature featureToIgnoreNotification;

    protected DefaultFeatureStoreTransforms transform;

    protected FeatureQuery queryForProvider;

    protected FeatureType defaultFeatureType;

    protected FeatureType defatulFeatureTypeForProvider;

    protected boolean ignoreChanges;

    private boolean disposed = false;

    public DefaultFeatureSet(DefaultFeatureStore store, FeatureQuery query)

        throws DataException {

        DisposeUtils.bind(this);

        this.featureToIgnoreNotification = null;

        this.iteratorMode = NO_CHECKED;

        this.sourceStoreModified = false;

        this.ownFeaturesModified = false;

        this.size = -1;

        this.orderedData = null;

        this.store = store;

        DisposeUtils.bind(this.store);

        if (this.store.isEditing()) {

            this.transform = this.store.getFeatureTypeManager().getTransforms();

        } else {

            this.transform =

                (DefaultFeatureStoreTransforms) store.getTransforms();

        }

        this.query = query;

        try {

            this.queryForProvider = (FeatureQuery) query.clone();

        } catch (CloneNotSupportedException e) {

            throw new FeatureSetInitializeException(e);

        }

        this.featureTypes = new ArrayList();

        if (this.query.getFeatureTypeId() == null

            && this.query.getAttributeNames() == null) {

            this.defaultFeatureType = this.store.getDefaultFeatureType();

            this.featureTypes.addAll(this.store.getFeatureTypes());

        } else {

            this.defaultFeatureType = this.store.getFeatureType(this.query);

            List<EditableFeatureAttributeDescriptor> cols = this.query.getExtraColumn().getColumns();

            if (this.query!=null && cols!=null && !cols.isEmpty()) {

                DefaultFeatureType featureTypeExtraCols = (DefaultFeatureType) this.defaultFeatureType.getCopy();

                featureTypeExtraCols.setExtraColumn(this.query.getExtraColumn());

                this.defaultFeatureType = featureTypeExtraCols;

            }

            this.featureTypes.add(this.defaultFeatureType);

        }

        if (this.transform != null && !this.transform.isEmpty()) {

            this.fixQueryForProvider(this.queryForProvider, this.transform);

        } else {

            this.defatulFeatureTypeForProvider = this.defaultFeatureType;

        }

        FeatureIndexes indexes = store.getIndexes();

        if (this.queryForProvider.hasFilter() && indexes != null

            && indexes.areValid()) {

            this.provider =

                (FeatureSetProvider) indexes

                    .getFeatureSet(this.queryForProvider.getFilter());

        }

        if (this.provider == null) {

            this.provider =

                this.store.getProvider().createSet(this.queryForProvider,

                    this.defatulFeatureTypeForProvider);

        }

        this.store.addObserver(this);

    }

    private void fixQueryForProvider(FeatureQuery theQueryForProvider,

        DefaultFeatureStoreTransforms transformsToUse) throws DataException {

        theQueryForProvider.clearAttributeNames();

        FeatureType ftype =

            transformsToUse.getSourceFeatureTypeFrom(this.defaultFeatureType);

        theQueryForProvider.setFeatureTypeId(ftype.getId());

        this.defatulFeatureTypeForProvider = ftype;

        if (transformsToUse.isTransformsOriginalValues()) {

            theQueryForProvider.clearFilter();

            FeatureQueryOrder fqo = theQueryForProvider.getOrder();

            if (fqo != null) {

                fqo.clear();

            }

            return;

        }

        // Filter

        Evaluator filter = theQueryForProvider.getFilter();

        if (filter != null) {

            boolean canUseFilter;

            if (filter.getFieldsInfo() == null) {

                canUseFilter = false;

            } else {

                canUseFilter = areEvaluatorFieldsInAttributes(filter, ftype);

            }

            if (!canUseFilter) {

                theQueryForProvider.clearFilter();

            }

        }

        // Order

        if (theQueryForProvider.hasOrder()) {

            boolean canUseOrder = true;

            Iterator iter = theQueryForProvider.getOrder().iterator();

            FeatureQueryOrderMember item;

            while (iter.hasNext()) {

                item = (FeatureQueryOrderMember) iter.next();

                if (item.hasEvaluator()) {

                    if (!areEvaluatorFieldsInAttributes(item.getEvaluator(),

                        ftype)) {

                        canUseOrder = false;

                        break;

                    }

                } else {

                    if (ftype.get(item.getAttributeName()) == null) {

                        canUseOrder = false;

                        break;

                    }

                }

            }

            if (!canUseOrder) {

                theQueryForProvider.getOrder().clear();

            }

        }

    }

    private boolean areEvaluatorFieldsInAttributes(Evaluator evaluator,

        FeatureType fType) {

        if (evaluator.getFieldsInfo() == null) {

            return false;

        }

        String[] fieldNames = evaluator.getFieldsInfo().getFieldNames();

        if (fieldNames.length == 0) {

            return false;

        } else {

            for (String fieldName : fieldNames) {

                if (fType.get(fieldName) == null) {

                    return false;

                }

            }

        }

        return true;

    }

    @Override

    public FeatureType getDefaultFeatureType() {

        return this.defaultFeatureType;

    }

    @Override

    public List getFeatureTypes() {

        return Collections.unmodifiableList(this.featureTypes);

    }

    @Override

    public long getSize() throws DataException {

        this.checkSourceStoreModified();

        if (size < 0) {

            size = calculateSize();

        }

        return size;

    }

    private long calculateSize() throws DataException {

        boolean hasLimit = this.query.hasLimit();

        long limit = this.query.getLimit();

        if(hasLimit && limit == 0){

            return 0;

        }

        long mySize = 0;

        int mode = this.getIteratorMode();

        DisposableIterator iter = null;

        switch (mode) {

        case DEFAULT:

        case ORDERED:

            if (this.provider.isEmpty()) {

                return 0;

            }

            mySize = provider.getSize();

            return (hasLimit && mySize>limit)? limit:mySize;

        case FILTERED:

        case ORDERED_FILTERED:

            try {

                iter = this.fastIterator();

                while ((hasLimit && (mySize<limit)) || !hasLimit ) {

                    iter.next();

                    mySize++;

                }

            } catch (NoSuchElementException e) {

            } finally {

                DisposeUtils.disposeQuietly(iter);

            }

            return (limit>=0 && mySize>limit)? limit:mySize;

        case EDITED:

        case ORDERD_EDITED:

            mySize = provider.getSize()

                + store.getFeatureManager().getDeltaSize();

            return (hasLimit && mySize>limit)? limit:mySize;

        case EDITED_FILTERED:

        case ORDERED_EDITED_FILTER:

            try {

                iter = this.fastIterator();

                while ((hasLimit && (mySize<limit)) || !hasLimit ) {

                    iter.next();

                    mySize++;

                }

            } catch (NoSuchElementException e) {

            } finally {

                DisposeUtils.disposeQuietly(iter);

            }

            return (hasLimit && mySize>limit)? limit:mySize;

        default:

            throw new IllegalArgumentException();

        }

    }

    @Override

    public synchronized final void dispose() {

        // Check if we have already been disposed, and don't do it again

        if (!disposed) {

            if (DisposeUtils.release(this)) {

                try {

                    doDispose();

                } catch (Exception ex) {

                    LOG.error("Error performing dispose", ex);

                } finally {

                    disposed = true;

                }

            }

        }

    }

    public void doDispose() {

        if( this.store!=null ) {

            this.store.deleteObserver(this);

            DisposeUtils.dispose(this.store);

            this.store = null;

        }

        if( this.provider!=null ) {

            this.provider.dispose();

            this.provider = null;

        }

        if (orderedData != null) {

            orderedData.clear();

            this.orderedData = null;

        }

        this.featureToIgnoreNotification = null;

        this.transform = null;

        this.query = null;

        this.queryForProvider = null;

        this.featureTypes = null;

        this.defaultFeatureType = null;

        this.defatulFeatureTypeForProvider = null;

    }

    public void update(Observable obsevable, Object notification) {

        if (sourceStoreModified) {

            return;

        }

        String type = ((FeatureStoreNotification) notification).getType();

        if (type.equalsIgnoreCase(FeatureStoreNotification.AFTER_INSERT)

            || type.equalsIgnoreCase(FeatureStoreNotification.AFTER_DELETE)

            || type.equalsIgnoreCase(FeatureStoreNotification.AFTER_UPDATE)) {

            if (this.featureToIgnoreNotification == ((FeatureStoreNotification) notification)

                .getFeature()) {

                return;

            }

            sourceStoreModified = true;

            sourceStoreModifiedCause = new Throwable();

            return;

        }

        if (type.equalsIgnoreCase(FeatureStoreNotification.AFTER_UPDATE_TYPE)

            || type.equalsIgnoreCase(FeatureStoreNotification.AFTER_REDO)

            || type.equalsIgnoreCase(FeatureStoreNotification.AFTER_UNDO)

            || type.equalsIgnoreCase(FeatureStoreNotification.AFTER_REFRESH)

            || type.equalsIgnoreCase(FeatureStoreNotification.COMPLEX_NOTIFICATION)

//            || type.equalsIgnoreCase(FeatureStoreNotification.AFTER_CLOSE)

//            || type.equalsIgnoreCase(FeatureStoreNotification.AFTER_DISPOSE)

            || type.equalsIgnoreCase(FeatureStoreNotification.TRANSFORM_CHANGE)) {

            sourceStoreModified = true;

            sourceStoreModifiedCause = new Throwable();

            return;

        }

        if (type.equalsIgnoreCase(FeatureStoreNotification.RESOURCE_CHANGED)) {

            if(!this.ignoreChanges) {

                sourceStoreModified = true;

                sourceStoreModifiedCause = new Throwable();

                return;

            }

        }

        if (type.equalsIgnoreCase(FeatureStoreNotification.AFTER_CANCELEDITING)) {

            if (ownFeaturesModified) {

                sourceStoreModified = true;

                sourceStoreModifiedCause = new Throwable();

                return;

            }

        }

    }

    protected void checkSourceStoreModified() {

        if (sourceStoreModified) {

            LOG.debug("ConcurrentDataModification in featureSet "+this.hashCode()+" of store '"+(store == null ? "": store.getName())+"'");

            ConcurrentDataModificationException ex = new ConcurrentDataModificationException(

                    store == null ? "": store.getName()

            );

            ex.initCause(sourceStoreModifiedCause);

            throw ex;

        }

    }

    @Override

    public DisposableIterator fastIterator(long index) throws DataException {

        return fastIterator(index, 0);

    }

    @Override

    public DisposableIterator fastIterator(long index, long elements) throws DataException {

        if (index < 0) {

            throw new IndexOutOfBoundsException("The index (" + index

                + ") is less than 0");

        }

        DisposableIterator it;

        int mode = this.getIteratorMode();

        switch (mode) {

        case DEFAULT:

            it = new FastDefaultIterator(this, index, elements);

            break;

        case FILTERED:

            it = new FastFilteredIterator(this, index, elements);

            break;

        case ORDERED:

            if(this.provider.canOrder() && this.provider.canIterateFromIndex()){

                it = new FastDefaultIterator(this, index, elements);

            } else {

                if (this.orderedData != null) {

                    it = new FastOrderedIterator(this, index);

                } else {

                    it = new FastOrderedIterator(this, new FastDefaultIterator(this, 0, -1), index);

                }

            }

            break;

        case ORDERED_FILTERED:

            if(this.provider.canOrder() && this.provider.canFilter() && this.provider.canIterateFromIndex()){

                it = new FastFilteredIterator(this, index, elements);

            } else {

                if (this.orderedData != null) {

                    it = new FastOrderedIterator(this, index);

                } else {

                    it = new FastOrderedIterator(this, new FastFilteredIterator(

                        this, 0, -1), index);

                }

            }

            break;

        case EDITED:

            it = new FastEditedIterator(this, index, elements);

            break;

        case EDITED_FILTERED:

            it = new FastEditedFilteredIterator(this, index, elements);

            break;

        case ORDERD_EDITED:

            if(this.provider.canOrder() && this.provider.canIterateFromIndex() && !this.store.getFeatureManager().hasDeleteds()){

                it = new FastEditedIterator(this, index, elements);

            } else {

                if (this.orderedData != null) {

                    it = new FastOrderedIterator(this, index);

                } else {

                    it = new FastOrderedIterator(this, new FastEditedIterator(

                        this, 0, -1), index);

                }

            }

            break;

        case ORDERED_EDITED_FILTER:

            if(this.provider.canOrder() && this.provider.canFilter() && this.provider.canIterateFromIndex() && !this.store.getFeatureManager().hasDeleteds()){

                it = new FastEditedFilteredIterator(this, index, elements);

            } else {

                if (this.orderedData != null) {

                    it = new FastOrderedIterator(this, index);

                } else {

                    it = new FastOrderedIterator(this,

                        new FastEditedFilteredIterator(this, 0, -1), index);

                }

            }

            break;

        default:

            throw new IllegalArgumentException();

        }

        if( this.query!=null && this.query.getLimit()>0 ) {

            it = new LimitIterator(it,this.query.getLimit());

        }

        return it;

    }

    private class LimitIterator implements DisposableIterator {

        private final DisposableIterator it;

        private final long limit;

        private int count;

        private LimitIterator(DisposableIterator it, long limit) {

            this.it = it;

            this.limit = limit;

            this.count = 0;

        }

        @Override

        public void dispose() {

            this.it.dispose();

        }

        @Override

        public boolean hasNext() {

            if( this.count>=this.limit ) {

                return false;

            }

            return this.it.hasNext();

        }

        @Override

        public Object next() {

            if( this.count>=this.limit ) {

                return null;

            }

            this.count++;

            return this.it.next();

        }

        @Override

        public void remove() {

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

        }

    }

    @Override

    public DisposableIterator iterator(long index) throws DataException {

        return iterator(index,0);

    }

    @Override

    public DisposableIterator iterator(long index, long elements) throws DataException {        

        if (index < 0) {

            throw new IndexOutOfBoundsException("The index (" + index

                + ") is less than 0");

        }

        DisposableIterator it;

        int mode = this.getIteratorMode();

        switch (mode) {

        case DEFAULT:

            it = new DefaultIterator(this, index, elements);

            break;

        case FILTERED:

            it = new FilteredIterator(this, index, elements);

            break;

        case ORDERED:

            if(this.provider.canOrder() && this.provider.canIterateFromIndex()){

                it = new DefaultIterator(this, index, elements);

            } else {

                if (orderedData != null) {

                    it = new OrderedIterator(this, index);

                } else {

                    it = new OrderedIterator(this, new DefaultIterator(this, 0, elements),index);

                }

            }

            break;

        case ORDERED_FILTERED:

            if(this.provider.canOrder() && this.provider.canFilter() && this.provider.canIterateFromIndex()){

                it = new FilteredIterator(this, index, elements);

            } else {

                if (orderedData != null) {

                    it = new OrderedIterator(this, index);

                } else {

                    it = new OrderedIterator(this, new FilteredIterator(this, 0, -1),index);

                }

            }

            break;

        case EDITED:

            it = new EditedIterator(this, index, elements);

            break;

        case EDITED_FILTERED:

            it = new EditedFilteredIterator(this, index, elements);

            break;

        case ORDERD_EDITED:

            if(this.provider.canOrder() && this.provider.canIterateFromIndex() && !this.store.getFeatureManager().hasDeleteds()){

                it = new EditedIterator(this, index, elements);

            } else {

                if (orderedData != null) {

                    it = new OrderedIterator(this, index);

                } else {

                    it = new OrderedIterator(this,

                        new EditedIterator(this, 0, -1), index);

                }

            }

            break;

        case ORDERED_EDITED_FILTER:

            if(this.provider.canOrder() && this.providerCanFilter() && this.provider.canIterateFromIndex() && !this.store.getFeatureManager().hasDeleteds()){

                it = new EditedFilteredIterator(this, index, elements);

            } else {

                if (orderedData != null) {

                    it = new OrderedIterator(this, index);

                } else {

                    it = new OrderedIterator(this,

                        new EditedFilteredIterator(this, 0, -1), index);

                }

            }

            break;

        default:

            throw new IllegalArgumentException();

        }

        if( this.query!=null && this.query.getLimit()>0 ) {

            it = new LimitIterator(it,this.query.getLimit());

        }

        return it;

    }

    private boolean providerCanOrder() {

        return this.provider.canOrder();

    }

    private boolean providerCanFilter() {

        return this.provider.canFilter();

    }

    private int getIteratorMode() {

        if (this.iteratorMode != NO_CHECKED) {

            return this.iteratorMode;

        }

        // TODO Tener en cuenta las transformaciones ???

        if (store.isEditing() && (store.getFeatureTypeManager().hasChanges() || store.getFeatureManager().hasChanges())) {

            if (this.query.hasOrder()) { // En edicion siempre ordeno yo.

                if (this.query.hasFilter()) {

                    return ORDERED_EDITED_FILTER;

                } else {

                    return ORDERD_EDITED;

                }

            } else {

                if (this.query.hasFilter()) {

                    return EDITED_FILTERED;

                } else {

                    return EDITED;

                }

            }

        } else {

            boolean useMyFilter = this.query.hasFilter();

            boolean useMyOrder = this.query.hasOrder();

            if (this.providerCanOrder() && this.transform.isEmpty()) {

                useMyOrder = false;

            }

            if (this.providerCanFilter() && this.transform.isEmpty()) {

                useMyFilter = false;

            }

            if (useMyOrder) {

                if (useMyFilter) {

                    return ORDERED_FILTERED;

                } else {

                    return ORDERED;

                }

            } else {

                if (useMyFilter) {

                    return FILTERED;

                } else {

                    return DEFAULT;

                }

            }

        }

    }

    @Override

    public void delete(Feature feature) throws DataException {

        this.featureToIgnoreNotification = feature;

        this.store.delete(feature);

        if (this.size > 0) {

            this.size--;

        }

        this.featureToIgnoreNotification = null;

        this.ownFeaturesModified = true;

    }

    @Override

    public void insert(EditableFeature feature) throws DataException {

        this.featureToIgnoreNotification = feature;

        this.store.insert(feature);

        if (this.size >= 0) {

            this.size++;

        }

        this.featureToIgnoreNotification = null;

        this.ownFeaturesModified = true;

    }

    @Override

    public void update(EditableFeature feature) throws DataException {

        this.featureToIgnoreNotification = feature;

        this.store.update(feature);

        this.featureToIgnoreNotification = null;

        this.ownFeaturesModified = true;

    }

    @Override

    public void commitChanges() throws DataException {

        this.ignoreChanges = true;

        this.store.commitChanges();

        this.ignoreChanges = false;

    }

    @Override

    public FeatureStore getFeatureStore() {

        return store;

    }

}