Application: gvSIG desktop

/* 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.index;

import java.util.List;

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

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

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

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

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

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

/**

 * Interface for any Index. 

 * @author jyarza

 *

 */

public interface Index {

        /** Column to which belongs this index */

        public FeatureAttributeDescriptor getFeatureAttributeDescriptor();

        /** FeatureType to which belongs this index */

        public FeatureType getFeatureType();

        /** FeatureStore to which belongs this index */

        public FeatureStore getFeatureStore();

        /** Index name */

        public String getName();

        /** Indicates if this index should overwrite itself on creation, if it exists already */

        public boolean isOverwrite();

        /** 

         * This is the most basic insertion method.

         * Inserts an object into the index, with the specified id. 

         */

        public void insert(Object o, FeatureID fid);

        /**

         * Inserts a Feature in the index.

         * The Feature must contain a column that matches this index's column (name and data type)

         * @param feat

         */

        public void insert(Feature feat);

        /**

         * Inserts a FeatureCollection into this index

         * FeatureType is not checked so it will accept any FeatureType

         * as long as exists a column with a valid name

         */        

        public void insert(FeatureCollection data);

        /** 

         * This is the most basic deletion method.

         * Deletes an object from the index, given its id

         **/

        public void delete(Object o, FeatureID fid);

        /**

         * Deletes a Feature in the index.

         * The Feature must contain a column that matches this index's column (name and data type)

         * @param feat

         */

        public void delete(Feature feat);

        /**

         * Deletes a FeatureCollection from this index

         * FeatureType is not checked so it will accept any FeatureType

         * as long as exists a column with a valid name

         */        

        public void delete(FeatureCollection data) throws IndexException;

        /** Performs a search in the index that meet the given parameters */

        public List query(QueryParameters params) throws IndexException;

}