| gvSIG desktop 1

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* 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 2

* 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.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2008 {{Company}}   {{Task}}

*/

package org.gvsig.fmap.data.feature.spi;

import java.util.Iterator;

import java.util.List;

import org.gvsig.fmap.data.exceptions.DataException;

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

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

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

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

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

import org.gvsig.fmap.data.feature.exceptions.DataIndexException;

import org.gvsig.fmap.data.index.QueryParameters;

/**

 * Abstract factory for registering and retrieving available indexing engines. 

 * You can force the use of a specific implementation by passing its key, or you can use the default

 * implementation for a given data type by specifying the {@link AttributeDescriptor} of the column 

 * to be indexed.

 * 

 * @author jyarza

 *

 */

public abstract class AbstractDataIndexProvider implements DataIndexProvider {

        private final FeatureStore featureStore;

        private final FeatureType featureType;

        private final String attributeName;

        private final String name;

        private final int dataType;

        public AbstractDataIndexProvider(FeatureStore featureStore, FeatureType featureType, String attributeName, String indexName) throws DataIndexException {

                if (featureStore == null) throw new IllegalArgumentException("featureStore cannot be null.");

                if (featureType == null) throw new IllegalArgumentException("featureType cannot be null.");

                if (attributeName == null) throw new IllegalArgumentException("attributeName cannot be null.");

                if (indexName == null) throw new IllegalArgumentException("indexName cannot be null.");

                FeatureAttributeDescriptor attr = featureType.getAttributeDescriptor(attributeName);

                if (attr == null) 

                        throw new IllegalArgumentException("Attribute " + attributeName +" not found in FeatureType " + featureType.toString());

                this.featureStore = featureStore;

                this.featureType = featureType;

                this.attributeName = attributeName;

                this.name = indexName;

                this.dataType = attr.getDataType();

        }

        public final FeatureAttributeDescriptor getFeatureAttributeDescriptor() {

                return featureType.getAttributeDescriptor(attributeName);

        }

        public final FeatureStore getFeatureStore() {

                return featureStore;

        }

        public final FeatureType getFeatureType() {

                return featureType;

        }

        public final String getName() {

                return name;

        }

        public final String getAttributeName() {

                return attributeName;

        }

        public final int getDataType() {

                return dataType;

        }

        /**

         * Fills this index with all the data in its FeatureStore

         */

        public final void fill() throws DataIndexException {

                try {

                        insert(getFeatureStore().getFeatureSet());

                } catch (DataException e) {

                        throw new DataIndexException(e);

                }

        }

        public final void insert(FeatureSet data) {

                Iterator it = data.iterator();

                while (it.hasNext()) {

                        Feature feat = (Feature) it.next();

                        insert(feat);

                }

        }

        public void insert(Feature feat) {

                try {

                        insert(feat.get(attributeName), feat.getReference());

                } catch (NullPointerException e) {

                        throw new IllegalArgumentException("Feature does not contain a column with name " + attributeName);

                } catch (ClassCastException e) {

                        throw new IllegalArgumentException("Attribute data type is not valid.");

                }

        }

        public abstract List query(QueryParameters params) throws DataIndexException;

        public abstract void initialize();

        /**

         * FIXME ver que hacemos con estas constantes

         * Convenience constants to identify sets of providers classified by supported data types. 

         */

        public interface PROVIDERS {

                public interface GEOMETRY {

                        public static final String GT2_QUADTREE = "QuadTreeGt2Factory";

                        public static final String JSI_RTREE = "RTreeJsiFactory";

                        public static final String JTS_QUADTREE = "QuadTreeJtsFactory";

                        public static final String SPATIALINDEX_RTREE = "RTreeSptLibFactory";

                        public static final String DEFAULT = GT2_QUADTREE;

                }

                public interface DATE {

                        // added as example

                }

                public interface INTEGER {

                        // added as example

                }                

        }

}