| gvSIG desktop 1

import org.gvsig.fmap.dal.DataStoreParameters;

	 /**

	  *

	  * Creates a new instance of the provider associated to the passed parameters.

	  * 

	  * @param store

	  * @param parameters

	  * @return

	  * @throws InitializeException

	  * @throws ProviderNotRegisteredException

	  */

	 public DataStoreProvider createProvider(DataStoreProviderServices providerServices, DataStoreParameters parameters) throws InitializeException, ProviderNotRegisteredException;	 

 * 

 * 

    public static final String METADATA_DEFINITION_NAME = "FeatureStore";

    /** Indicates that this store is in query mode */

    final static int MODE_QUERY = 0;

    /** Indicates that this store is in full edit mode */

    final static int MODE_FULLEDIT = 1;

    /** Indicates that this store is in append mode */

    final static int MODE_APPEND = 2;

    /*

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

     * 

     * information related services

     */

    /**

     * Indicates whether this store allows writing.

     * 

     * @return

     *         true if this store can be written, false if not.

     */

    public boolean allowWrite();

    /**

     * Returns this store's default {@link FeatureType}.

     * 

     * @return

     *         this store's default {@link FeatureType}.

     * 

     * @throws DataException

     */

    public FeatureType getDefaultFeatureType() throws DataException;

    /**

     * Returns this store's featureType {@link FeatureType} matches with

     * featureTypeId.

     * 

     * @param featureTypeId

     * 

     * @return this store's default {@link FeatureType}.

     * 

     * @throws DataException

     */

    public FeatureType getFeatureType(String featureTypeId)

        throws DataException;

    /**

     * Returns this store's {@link FeatureType}(s).

     * 

     * @return a list with this store's {@link FeatureType}(s).

     * 

     * @throws DataException

     */

    public List getFeatureTypes() throws DataException;

    /**

     * Returns this store's parameters.

     * 

     * @return

     *         {@link DataStoreParameters} containing this store's parameters

     */

    public DataStoreParameters getParameters();

    /**

     *@throws DataException

     * @deprecated Mirar de cambiarlo a metadatos

     */

    public boolean canWriteGeometry(int gvSIGgeometryType) throws DataException;

    /**

     * Returns this store's total envelope (extent).

     * 

     * @return this store's total envelope (extent) or <code>null</code> if

     *         store not have geometry information

     */

    public Envelope getEnvelope() throws DataException;

    /**

     * 

     * @deprecated use getDefaultFeatureType().getDefaultSRS()

     * @return

     * @throws DataException

     */

    public IProjection getSRSDefaultGeometry() throws DataException;

    /**

     * Exports this store to another store.

     * 

     * @param explorer

     *            {@link DataServerExplorer} target

     * @param params

     *            New parameters of this store that will be used on the target

     *            explorer

     * 

     * @throws DataException

     * 

     * @Deprecated this method is unstable

     */

    public void export(DataServerExplorer explorer, String provider,

        NewFeatureStoreParameters params) throws DataException;

    /*

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

     * 

     * Query related services

     */

    /**

     * Returns all available features in the store.

     * <p>

     * <em>

     * <strong>NOTE:</strong> if you use this method to get a 

     * {@link FeatureSet}, you  must get sure it is disposed 

     * </p>

     * 

     * @see #accept(org.gvsig.tools.visitor.Visitor)

     * 

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

     * <p>

     * <em>

     * <strong>NOTE:</strong> if you use this method to get a 

     * {@link FeatureSet}, you  must get sure it is disposed 

     * </p>

     * 

     * @see #accept(org.gvsig.tools.visitor.Visitor,

     *      org.gvsig.fmap.dal.DataQuery)

     * 

     * @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;

    /**

     * Returns the feature given its reference.

     * 

     * @param reference

     *            a unique FeatureReference

     * @return

     *         The Feature

     * 

     * @throws DataException

     * 

     */

    public Feature getFeatureByReference(FeatureReference reference)

        throws DataException;

    /**

     * Returns the feature given its reference and feature type.

     * 

     * @param reference

     *            a unique FeatureReference

     * 

     * @param featureType

     *            FeatureType to which the requested Feature belongs

     * 

     * @return

     *         The Feature

     * 

     * @throws DataException

     * 

     */

    public Feature getFeatureByReference(FeatureReference reference,

        FeatureType featureType) throws DataException;

    /*

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

     * 

     * Editing related services

     */

    /**

     * Enters editing state.

     */

    public void edit() throws DataException;

    /**

     * Enters editing state specifying the editing mode.

     * 

     * @param mode

     * 

     * @throws DataException

     */

    public void edit(int mode) throws DataException;

    /**

     * Cancels all editing since the last edit().

     * 

     * @throws DataException

     */

    public void cancelEditing() throws DataException;

    /**

     * Exits editing state.

     * 

     * @throws DataException

     */

    public void finishEditing() throws DataException;

    /**

     * Indicates whether this store is in editing state.

     * 

     * @return

     *         true if this store is in editing state, false if not.

     */

    public boolean isEditing();

    /**

     * Indicates whether this store is in appending state. In this state the new

     * features are automatically inserted at the end of the {@link FeatureSet}.

     * 

     * @return true if this store is in appending state.

     */

    public boolean isAppending();

    /**

     * Updates a {@link FeatureType} in the store with the changes in the

     * {@link EditableFeatureType}.<br>

     * 

     * Any {@link FeatureSet} from this store that are used will be invalidated.

     * 

     * @param featureType

     *            an {@link EditableFeatureType} with the changes.

     * 

     * @throws DataException

     */

    public void update(EditableFeatureType featureType) throws DataException;

    /**

     * Updates a {@link Feature} in the store with the changes in the

     * {@link EditableFeature}.<br>

     * 

     * Any {@link FeatureSet} from this store that was still in use will be

     * invalidated. You can override this using

     * {@link FeatureSet#update(EditableFeature)}.

     * 

     * @param feature

     *            the feature to be updated

     * 

     * @throws DataException

     */

    public void update(EditableFeature feature) throws DataException;

    /**

     * Deletes a {@link Feature} from the store.<br>

     * 

     * Any {@link FeatureSet} from this store that was still in use will be

     * invalidated. You can override this using {@link Iterator#remove()} from

     * {@link FeatureSet}.

     * 

     * @param feature

     *            The feature to be deleted.

     * 

     * @throws DataException

     */

    public void delete(Feature feature) throws DataException;

    /**

     * Inserts a {@link Feature} in the store.<br>

     * 

     * Any {@link FeatureSet} from this store that was still in use will be

     * invalidated. You can override this using

     * {@link FeatureSet#insert(EditableFeature)}.

     * 

     * @param feature

     *            The feature to be inserted

     * 

     * @throws DataException

     */

    public void insert(EditableFeature feature) throws DataException;

    /**

     * Creates a new feature using the default feature type and returns it as an

     * {@link EditableFeature}

     * 

     * @return a new feature in editable state

     * 

     * @throws DataException

     */

    public EditableFeature createNewFeature() throws DataException;

    /**

     * Creates a new feature of the given {@link FeatureType} and uses the given

     * {@link Feature} as default values to initialize it.

     * 

     * @param type

     *            the new feature's feature type

     * 

     * @param defaultValues

     *            a feature whose values are used as default values for the new

     *            feature.

     * 

     * @return the new feature.

     * 

     * @throws DataException

     */

    public EditableFeature createNewFeature(FeatureType type,

        Feature defaultValues) throws DataException;

    /**

     * Creates a new feature of the given {@link FeatureType}. The flag

     * defaultValues is used to indicate whether the new feature should be

     * initialized with default values or not.

     * 

     * @param type

     *            the new feature's feature type

     * 

     * @param defaultValues

     *            if true the new feature is initialized with each attribute's

     *            default value.

     * 

     * @return

     *         the new feature

     * 

     * @throws DataException

     */

    public EditableFeature createNewFeature(FeatureType type,

        boolean defaultValues) throws DataException;

    /**

     * Creates a new feature of default {@link FeatureType}. The flag

     * defaultValues is used to indicate whether the new feature should be

     * initialized with default values or not.

     * 

     * @param defaultValues

     *            if true the new feature is initialized with each attribute's

     *            default value.

     * 

     * @return

     *         the new feature

     * 

     * @throws DataException

     */

    public EditableFeature createNewFeature(boolean defaultValues)

        throws DataException;

    /**

     * Applies the validation rules associated to the given mode to the active

     * {@link FeatureSet}.

     * 

     * @param mode

     *            can be one of {MODE_QUERY, MODE_FULLEDIT, MODE_APPEND}

     * 

     * @throws DataException

     */

    public void validateFeatures(int mode) throws DataException;

    /**

     * Indicates whether this store supports append mode.

     * 

     * @return

     *         true if this store supports append mode.

     */

    public boolean isAppendModeSupported();

    /**

     * Initiates an editing group. This is typically used to group series of

     * store editing operations.

     * 

     * @param description

     *            Description of the editing group.

     * 

     * @throws NeedEditingModeException

     */

    public void beginEditingGroup(String description)

        throws NeedEditingModeException;

    /**

     * Finishes an editing group.

     * 

     * @throws NeedEditingModeException

     */

    public void endEditingGroup() throws NeedEditingModeException;

    /*

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

     * 

     * Index related services

     */

    /**

     * Creates a FeatureIndex with name indexName, given the attributeName and

     * its featureType.

     * 

     * @param featureType

     *            The FeatureType to which the indexed attribute belongs.

     * 

     * @param attributeName

     *            The name of the attributed to be indexed

     * 

     * @param indexName

     *            The index name

     * 

     * @return the resulting FeatureIndex

     * 

     * 

     * @throws FeatureIndexException

     */

    public FeatureIndex createIndex(FeatureType featureType,

        String attributeName, String indexName) throws DataException;

    public FeatureIndex createIndex(String indexTypeName,

        FeatureType featureType, String attributeName, String indexName)

        throws DataException;

    /**

     * Creates a FeatureIndex with name indexName, given the attributeName and

     * its featureType. This method is intended for background indexing. It

     * receives an observer that will be notified by the process.

     * 

     * @param featureType

     *            The FeatureType to which the indexed attribute belongs.

     * 

     * @param attributeName

     *            The name of the attributed to be indexed

     * 

     * @param indexName

     *            The index name

     * 

     * @param observer

     *            an observer that will be notified of the indexing process

     *            progress.

     * 

     * @return the resulting FeatureIndex

     * 

     * 

     * @throws FeatureIndexException

     */

    public FeatureIndex createIndex(FeatureType featureType,

        String attributeName, String indexName, Observer observer)

        throws DataException;

    public FeatureIndex createIndex(String indexTypeName,

        FeatureType featureType, String attributeName, String indexName,

        Observer observer) throws DataException;

    /**

     * Returns a FeatureIndexes structure containing all available indexes in

     * the store.

     * 

     * @return

     */

    public FeatureIndexes getIndexes();

    /*

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

     * 

     * Selection related services

     */

    /**

     * Sets the selection to the passed {@link FeatureSet}

     * 

     * @param selection

     *            A {@link FeatureSet} with the requested selection

     */

    public void setSelection(FeatureSet selection) throws DataException;

    /**

     * Creates a {@link FeatureSelection}

     * 

     * @return

     *         a {@link FeatureSelection}

     * 

     * @throws DataException

     */

    public FeatureSelection createFeatureSelection() throws DataException;

    /**

     * Returns the current {@link FeatureSelection}.

     * 

     * @return

     *         current {@link FeatureSelection}.

     * 

     * @throws DataException

     */

    public FeatureSelection getFeatureSelection() throws DataException;

    /*

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

     * 

     * Lock related services

     */

    /**

     * Indicates whether this store supports locks.

     * 

     * @return

     *         true if this store supports locks, false if not.

     */

    public boolean isLocksSupported();

    /**

     * Returns the set of locked features

     * 

     * @return

     *         set of locked features

     * 

     * @throws DataException

     */

    public FeatureLocks getLocks() throws DataException;

    /*

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

     * Transforms related services

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

     */

    /**

     * Returns this store transforms

     * 

     * @return

     *         this store transforms

     */

    public FeatureStoreTransforms getTransforms();

    /**

     * Returns a new {@link FeatureQuery} associated to this store.

     * 

     * @return

     *         a new {@link FeatureQuery} associated to this store.

     */

    public FeatureQuery createFeatureQuery();

    /**

     * Returns featue count of this store.

     * 

     * @return

     * @throws DataException

     */

    public long getFeatureCount() throws DataException;

    /**

     * Creates a vectorial cache that is used to save and retrieve data.

     * 

     * @param name

     *            the cache name.

     * @param parameters

     *            parameters to create the stores used to save data.

     * @throws DataException

     */

    public void createCache(String name, DynObject parameters)

        throws DataException;

    /**

     * @return the vectorial cache

     */

    public FeatureCache getCache();

    /**

     *         <true> if it knows the real envelope.

    public boolean isKnownEnvelope();

     *         <true> if there is a limit of features.

     * If the {@link FeatureStoreProvider#hasRetrievedFeaturesLimit()} returns

     * true,

     * 

     *         The limit of the retrieved features.

	public Instant getInstant(int index);

	public Instant getInstant(String name);

	public Interval getInterval(int index);

	public Interval getInterval(String name);

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.visitor.Visitor;

    /**

     * Returns an iterator over the elements in this collection, in the order

     * (if any) defined when the collection was obtained.

     * 

     * The iterator starts at the specified position in this collection. The

     * specified index indicates the first element that would be returned by an

     * initial call to the <tt>next</tt> method. An initial call to the

     * <tt>previous</tt> method would return the element with the specified

     * index minus one.

     * 

     * <p>

     * <em>

     * <strong>NOTE:</strong> if you use this method to get the iterator, you

     * must get sure the iterator is disposed (@see

     * {@link DisposableIterator#dispose()}) in any case, even if an error occurs

     * while getting the data. It is recommended to use the <code>accept</code>

     * methods instead, which handle everything for you. 

     * Take into account the accept methods may use a fast iterator to 

     * get the features.

     * </em>

     * </p>

     * 

     * @see #accept(org.gvsig.tools.visitor.Visitor)

     * @see #accept(org.gvsig.tools.visitor.Visitor, long)

     * @see #fastIterator()

     * @see #fastIterator(long)

     * 

     * @param index

     *            index of first element to be returned from the iterator (by a

     *            call to the <tt>next</tt> method).

     * @return an iterator of the elements in this collection (in proper

     *         sequence), starting at the specified position in the collection.

     * @throws DataException

     *             if the index is out of range (index < 0 || index >

     *             size()).

     * @deprecated use {@link #fastIterator(long)} instead

     */

    /**

     * Returns an iterator over the elements in this collection, in the order

     * (if any) defined when the collection was obtained.

     * 

     * <p>

     * <em>

     * <strong>NOTE:</strong> if you use this method to get the iterator, you

     * must get sure the iterator is disposed (@see

     * {@link DisposableIterator#dispose()}) in any case, even if an error occurs

     * while getting the data. It is recommended to use the <code>accept</code>

     * methods instead, which handle everything for you. 

     * Take into account the accept methods may use a fast iterator to 

     * get the features.

     * </em>

     * </p>

     * 

     * @see #accept(org.gvsig.tools.visitor.Visitor)

     * @see #accept(org.gvsig.tools.visitor.Visitor, long)

     * @see #fastIterator()

     * @see #fastIterator(long)

     * 

     * @return an iterator of the elements in this collection (in proper

     *         sequence).

     * 

     * @throws DataException

     *             if there is an error getting the iterator

     * 

     * @deprecated use {@link #fastIterator()} instead

     */

    /**

     * Returns a fast iterator over this set.

     * <p>

     * Fast in this case means that each of the elements returned may be a

     * reused or pooled object instance, so don't use it to be stored in any

     * way.

     * </p>

     * <p>

     * If you need to store one of the {@link Feature} of the iterator, use the

     * {@link Feature#getCopy()} to create a clone of the object.

     * </p>

     * 

     * <p>

     * <em>

     * <strong>NOTE:</strong> if you use this method to get the iterator, you

     * must get sure the iterator is disposed (@see

     * {@link DisposableIterator#dispose()}) in any case, even if an error occurs

     * while getting the data. It is recommended to use the <code>accept</code>

     * methods instead, which handle everything for you. 

     * Take into account the accept methods may use a fast iterator to 

     * get the features.

     * </em>

     * </p>

     * 

     * @see #accept(org.gvsig.tools.visitor.Visitor)

     * @see #accept(org.gvsig.tools.visitor.Visitor, long)

     * 

     * @return an iterator over this set.

     * 

     * @throws DataException

     */

    /**

     * Returns a fast iterator over this set, starting from the given index.

     * <p>

     * Fast in this case means that each of the elements returned may be a

     * reused or pooled object instance, so don't use it to be stored in any