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.io.File;

/**

 * FIXME This specification is due to change

 *

 * -open()

 * -close()

 * -delete()

 * -getFile()

 *

 * @author azabala

 * @author jyarza

 */

public interface PersistentIndex {

        /**

         * Makes persistent all changes in the index

         */

        public void flush() throws IndexException;

        public void flush(File f) throws IndexException;

        /**

         * Checks if the persistent store of this index exists

         * @return

         */

        public boolean exists();

        /**

         * Loads an index from a file

         * @throws IndexException

         */

        public void load() throws IndexException;

        public void load(File f) throws IndexException;

        /**

         * Frees resources of persistent data store

         * (closes files, etc)

         *

         */

        public void close();

        /**

         * Obtains the index File

         * @return

         */

        public File getFile();

}