| gvSIG desktop 1

package org.gvsig.fmap.dal.feature;

import java.util.List;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

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

import org.gvsig.fmap.dal.exceptions.ReadException;

import org.gvsig.fmap.dal.feature.exceptions.FeatureIndexException;

import org.gvsig.fmap.dal.feature.exceptions.NeedEditingModeException;

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

import org.gvsig.tools.observer.Observer;

/**

 * <p>Is a specialization of DataStore to use alfanumeric and

 * vectorial data.</p>

 * <ul>

 *   <il>It has suport to the diferent <i>Feature</i> definitions

 *   (or types) represented by <i>FeatureType</i>, but always

 *   use one by default. (The GML format, for example, can use

 *   diferent <i>Feature</i> types.</il>

 *   <il>Allows access to a subcollection data filtered and/or

 *   sort it (as well load in a background mode).

 *   </il>

 *   <il>Allowed filters will be <i>alfanumerics</i> and/or

 *   <i>Spatial</i> and/or <i>Feature type</i>.</il>

 *   <il>Adds support to <i>Feature</i> edition level.</il>

 *   <il>Adds support to modify structure (<i>FeatureType</i>).</il>

 *   <il>Give information about contained geometry types.</il>

 *

 * </ul>

 *

 * @author

 *

 */

public interface FeatureStore extends DataStore {

        final static int MODE_QUERY = 0;

        final static int MODE_FULLEDIT = 1;

        final static int MODE_APPEND = 2;

        /*

         * =============================================================

         *

         * information related services

         */

        public boolean allowWrite();

        public FeatureType getDefaultFeatureType() throws DataException;

        public List getFeatureTypes() throws DataException;

        public DataStoreParameters getParameters();

        /**

         *@throws DataException

         * @deprecated Mirar de cambiarlo a metadatos

         */

        public boolean canWriteGeometry(int gvSIGgeometryType) throws DataException;

        public Envelope getEnvelope();

        /**

         *

         * @deprecated use getDefaultFeatureType().getDefaultSRS()

         * @return

         * @throws DataException

         */

        public String getSRSDefaultGeometry() throws DataException;

        public void export(FeatureExplorer explorer, FeatureStoreParameters params)

                        throws DataException;

        /*

         * =============================================================

         *

         * Query related services

         */

        /**

         * Returns all available features in the store.

         *

         * @return a collection of features

         * @throws ReadException

         *             if there is any error while reading the features

         */

        FeatureSet getFeatureSet() throws DataException;

        /**

         * Returns a subset of features taking into account the properties and

         * restrictions of the FeatureQuery.

         *

         * @param featureQuery

         *            defines the characteristics of the features to return

         * @return a collection of features

         * @throws ReadException

         *             if there is any error while reading the features

         */

        FeatureSet getFeatureSet(FeatureQuery featureQuery)

         throws DataException;

        /**

         * Loads a subset of features taking into account the properties and

         * restrictions of the FeatureQuery. Feature loading is performed by calling

         * the Observer, once each loaded Feature.

         *

         * @param featureQuery

         *            defines the characteristics of the features to return

         * @param observer

         *            to be notified of each loaded Feature

         * @throws DataException

         *             if there is any error while loading the features

         */

        void getFeatureSet(FeatureQuery featureQuery, Observer observer)

        throws DataException;

        /**

         * Loads all available feature in the store. The loading of Features is

         * performed by calling the Observer, once each loaded Feature.

         *

         * @param observer

         *            to be notified of each loaded Feature

         * @throws DataException

         *             if there is any error while loading the features

         */

        void getFeatureSet(Observer observer) throws DataException;

        /**

         * Return the feature asociated with the passed reference.

         *

         * @param reference

         * @return

         * @throws DataException

         */

        public Feature getFeatureByReference(FeatureReference reference) throws DataException;

        public Feature getFeatureByReference(FeatureReference reference, FeatureType featureType)

                        throws DataException;

        /*

         * =============================================================

         *

         * Editing related services

         */

        public void edit() throws DataException;

        public void edit(int mode) throws DataException;

        public void cancelEditing() throws DataException;

        public void finishEditing() throws DataException;

        public boolean isEditing();

        public boolean isAppending();

        public void update(EditableFeatureType featureType) throws DataException;

        public void update(EditableFeature feature) throws DataException;

        public void delete(Feature feature) throws DataException;

        public void insert(EditableFeature feature) throws DataException;

        public void undo() throws DataException;

        public void redo() throws DataException;

        public CommandsRecord getCommandsRecord() throws DataException;

        public EditableFeature createNewFeature() throws DataException;

        public EditableFeature createNewFeature(FeatureType type,

                        Feature defaultValues) throws DataException;

        public EditableFeature createNewFeature(FeatureType type,

                        boolean defaultValues) throws DataException;

        public EditableFeature createNewFeature(boolean defaultValues)

                        throws DataException;

        public void validateFeatures(int mode) throws DataException;

        public boolean isAppendModeSupported();

        /*

         * =============================================================

         *

         * Index related services

         */

        /**

         * Creates a DataIndex with name indexName, given the attributeName and its featureType.

         * @param featureType

         * @param attributeName

         * @param indexName

         * @return

         * @throws FeatureIndexException

         */

        public FeatureIndex createIndex(FeatureType featureType,

                        String attributeName, String indexName) throws DataException;

        /**

         * Returns a FeatureIndexes structure containing all available indexes in

         * the store.

         *

         * @return

         */

        public FeatureIndexes getIndexes();

        /*

         * =============================================================

         *

         * Selection related services

         */

        public void setSelection(FeatureSet selection) throws DataException;

        public FeatureSelection createFeatureSelection() throws DataException;

        public FeatureSelection getFeatureSelection() throws DataException;

        /*

         * =============================================================

         *

         * Lock related services

         */

        public boolean isLocksSupported();

        public FeatureSet getLocks() throws DataException;

        public void beginEditingGroup(String description)

                        throws NeedEditingModeException;

        public void endEditingGroup() throws NeedEditingModeException;

}