Application: gvSIG desktop

package org.gvsig.fmap.data;

import java.util.Iterator;

import org.gvsig.fmap.data.commands.CommandsRecord;

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

import org.gvsig.fmap.data.operation.DataStoreOperationContext;

import org.gvsig.fmap.data.operation.DataStoreOperationException;

import org.gvsig.fmap.data.operation.DataStoreOperationNotSupportedException;

import org.gvsig.metadata.IMetadatable;

import org.gvsig.tools.observer.Observable;

import com.iver.utiles.IPersistence;

import com.iver.utiles.XMLEntity;

import com.iver.utiles.XMLException;

/**

 * <p>This is the basic interface of data sources. DataStore

 * offers generic services like:

 *   <ul>

 *     <li>Open, close, reject data source</li>

 *     <li>Access data collections, with the posibility of

 *     load data in background.</li>

 *     <li>Use of selection and blocks, as well as data

 *     collections</li>

 *     <li>Edition</li>

 *     <li>Register of events observers through the public

 *     methoths of Observable interface</li>

 *     <li>Access to data sources embebed into itself (like GML)</li>

 *     <li>Information about Spatial Reference Sistems that data

 *     source use</li>

 *   </ul>

 * </p>

 * <br>

 * @author

 *

 */

public interface DataStore extends Observable, IMetadatable, IPersistence{

        public String getName();

        /**

         * Return the of parameters of this store

         * 

         * @return parameters of this store

         */

        public DataStoreParameters getParameters();

        public void init(DataStoreParameters parameters) throws InitializeException;

        public void setXMLEntity(XMLEntity xmlEntity) throws XMLException;

        /*

         * FIXME: Comprobar el valor de retorno de las funciones Deberan de ser booleanas?

         */

        /**

         * Indica que se va a comenzar a hacer una serie de operaciones sobre el

         * origen de datos con la finalidad de que dicho origen de datos se

         * prepare (abra el fichero, comience una transaccin, conecte al

         * servidor, ...). Abre el fichero de ndices en caso de que exista.

         * @throws OpenException

         * @throws IsNotFeatureSettingException

         *

         */

        /**

         * Shows that a operation series will start on the data source

         * with the finallite that the data source will prepare

         * (open file, start transaction, connect to the server, ...)

         * Open index file if exists.

         * @throws OpenException

         * @throws IsNotFeatureSettingException

         *

         */

//        public void open() throws OpenException;

        public void refresh() throws OpenException,InitializeException;

        /**

         * Hace que se cierre el soporte fsico de la capa. Cierra el fichero de

         * ndices en caso de que exista.

         *

         */

        /**

         * <p>

         * Close the fisic layer souport. Close index file if exists.

         * </p>

         * 

         * @throws CloseException

         */

//        public void close() throws CloseException;

        public void dispose() throws CloseException;

        /**

         * 

         * @return DataCollection

         * @throws ReadException

         */

        public DataCollection getDataCollection() throws ReadException;

        /**

         * 

         * @return DataCollection

         */

        public DataCollection getSelection();

        /**

         * 

         * @param DataCollection

         *            selection

         * @throws DataException

         */

        public void setSelection(DataCollection selection) throws DataException;

        /**

         * 

         * @return DataCollection

         */

        public DataCollection createSelection();

        public Iterator getChilds(); // Iterator of DataStore

        /*

         * TODO: Falta comprobar si el tema de edicin lo dejamos aqui o

         *              volvemos a bajarlo al FeatureStore

         *

         * FIXME: Comprobar el valor de retorno de las funciones Deberan de ser booleanas?

        */

        /**

         * return boolean

         */

        public boolean isEditable();

        /**

         * @throws ReadException

         */

        public void startEditing() throws ReadException;

        public void cancelEditing();

        /**

         * 

         * @throws WriteException

         * @throws ReadException

         */

        public void finishEditing() throws WriteException, ReadException;

        public boolean isEditing();

        public void undo();

        public void redo();

        /**

         * 

         * @return CommandsRecord

         */

        public CommandsRecord getCommandsRecord();

        public void beginComplexNotification();

        public void endComplexNotification();

        //Bloqueo en edicin similar a la seleccin

        public DataCollection getLocked();

        /**

         * <p>Blocks the data collection like selection do.</p>

         */

        public void setLocked(DataCollection locked);

        public DataCollection createLocked();

        /**

         * 

         * @return DataExplorer

         * @throws ReadException

         */

        public DataExplorer getExplorer() throws ReadException;

        /**

         * 

         * @param int code

         * @param DataStoreOperationContext

         *            context

         * @return Object

         * @throws DataStoreOperationException

         * @throws DataStoreOperationNotSupportedException

         */

        public Object invokeOperation(int code,DataStoreOperationContext context) throws DataStoreOperationException, DataStoreOperationNotSupportedException;

        /**

         * 

         * @param String

         *            name

         * @param DataStoreOperationContext

         *            context

         * @return Object

         * @throws DataStoreOperationException

         * @throws DataStoreOperationNotSupportedException

         */

        public Object invokeOperation(String name,DataStoreOperationContext context) throws DataStoreOperationException, DataStoreOperationNotSupportedException;

        public boolean implementsOperation(int code);

        public boolean implementsOperation(String name);

}