| gvSIG desktop 1

/*

 * Created on 16-may-2006

 *

 * gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

 *

 * $Id: QuadtreeGt2.java 10627 2007-03-06 17:10:21Z caballero $

 * $Log$

 * Revision 1.3  2007-03-06 17:08:59  caballero

 * Exceptions

 *

 * Revision 1.2  2006/11/29 19:27:59  azabala

 * bug fixed (caused when we query for a bbox which is greater or equal to a layer bbox)

 *

 * Revision 1.1  2006/05/24 21:58:04  azabala

 * *** empty log message ***

 *

 *

 */

package org.gvsig.fmap.data.index.spatial.gt2;

import java.io.File;

import java.util.List;

import java.util.Stack;

import org.geotools.index.quadtree.Node;

import org.geotools.index.quadtree.QuadTree;

import org.geotools.index.quadtree.StoreException;

import org.geotools.index.quadtree.fs.FileSystemIndexStore;

import org.geotools.index.quadtree.fs.IndexHeader;

import org.gvsig.fmap.data.index.IndexException;

import org.gvsig.fmap.data.index.AbstractIntBasedSpatialIndex;

import org.gvsig.fmap.data.index.PersistentSpatialIndex;

import com.vividsolutions.jts.geom.Envelope;

/**

 * This Quadtree spatial index implementation is based in a fork of

 * org.geotools.index.quadtree.Quadtree implementation. <br>

 * This implementation offers us:

 * <ol>

 * <li>Persistence of spatial index</li>

 * </ol>

 * We had to fork geotools quadtree for many reasons:

 * <ol>

 * <li>It was strongly dependent of SHP format, so it returned not only a num

 * of rectangle, it also returned byte offset of this rectangle in shp file</li>

 * <li> Query artifact wasnt run well at all </li>

 * </ol>

 * 

 * @author azabala

 * 

 */

public class QuadtreeGt2 extends AbstractIntBasedSpatialIndex implements PersistentSpatialIndex {

	/**

	 * Geotools quadtree implementation

	 */

	QuadTree quadtree;

	/**

	 * Persistent storage

	 */

	String quadtreeFile;

	/**

	 * Spatial index file extension

	 */

	final String qExt = ".qix";

	/**

	 * qix format has many versions, and allows different byte orders.

	 */

	String byteOrder;

	/**

	 * Bounds of the layer to index

	 */

	Envelope bounds;

	/**

	 * Number of records of the layer to index

	 */

	int numRecs = 0;

	boolean inMemory = false;

	/**

	 * Constructor. You must say a qix file path, and if you want to overwrite

	 * this file if exists. Also, you must specify how many geometries are going

	 * to index, and the bounding box of all the geometries.

	 * 

	 * 

	 * @param quadtreeFile

	 *            qix file path

	 * @param byteOrder

	 *            byte order (bigendian, etc)

	 * @param bounds

	 *            Envelope of all the geometries to index

	 * @param numRecords

	 *            num of geometries to index

	 * @param overwrite

	 *            if we want to overwrite a possible existing qix file

	 * @throws IndexException

	 */

	public QuadtreeGt2(String quadtreeFile, String byteOrder,

			org.gvsig.fmap.geom.primitive.Envelope bounds, int numRecords,

			boolean overwrite) throws IndexException {

		this.quadtreeFile = quadtreeFile + qExt;

		this.byteOrder = byteOrder;

		this.bounds = toJtsEnvelope(bounds);

		this.numRecs = numRecords;

		if (exists()) {

			if (!overwrite) {

				load();

				return;

			}

		}

		quadtree = new QuadTree(numRecs, this.bounds);

	}

	/**

	 * If the spatial index file exists and has content

	 */

	public boolean exists() {

		return (new File(quadtreeFile).length() != 0);

	}

	public void load() throws IndexException {

		if (quadtree == null) {

			load(new File(quadtreeFile));

		}

	}

	public void load(File f) throws IndexException {

		try {

			FileSystemIndexStore store = new FileSystemIndexStore(f);

			quadtree = store.load();

			this.quadtreeFile = f.getAbsolutePath();

		} catch (StoreException e) {

			throw new IndexException(e);

		}

	}

	/**

	 * 

	 * 

	 */

	public List query(org.gvsig.fmap.geom.primitive.Envelope env) {

		if (quadtree == null)

			throw new IllegalStateException("This quadtree is null.");

		if (env == null)

			throw new IllegalArgumentException("Envelope cannot be null.");

		return quadtree.query(toJtsEnvelope(env));

	}

	/**

	 * Inserts an object in the index

	 */

	public void insert(org.gvsig.fmap.geom.primitive.Envelope env, int index) {

		if (env == null)

			throw new IllegalArgumentException("Envelope cannot be null");

		Envelope e = toJtsEnvelope(env);

		if (e == null)

			throw new IllegalStateException(

					"JTS Envelope conversion returns null");

		System.out.println("recno=" + index);

		if (quadtree == null)

			throw new IllegalStateException("quadtree is null");

		try {

			quadtree.insert(index, toJtsEnvelope(env));

		} catch (StoreException se) {

			// TODO Auto-generated catch block

			se.printStackTrace();

		}

	}

	public void delete(org.gvsig.fmap.geom.primitive.Envelope env, int index) {

		if (inMemory)

			quadtree.delete(toJtsEnvelope(env), index);

	}

	public Envelope toJtsEnvelope(org.gvsig.fmap.geom.primitive.Envelope env) {

		if (env == null)

			return null;

		double[] min = env.getLowerCorner();

		double[] max = env.getUpperCorner();

		return new Envelope(min[0], max[0], min[1], max[1]);

	}

	/**

	 * 

	 * @throws StoreException

	 * @deprecated

	 */

	void openQuadTree() throws StoreException {

		if (quadtree == null) {

			File file = new File(quadtreeFile);

			// Intento de cargar todo el quadtree en memoria

			FileSystemIndexStore store = new FileSystemIndexStore(file);

			quadtree = store.load();

		}

	}

	void openQuadTreeInMemory() throws StoreException {

		if (quadtree == null) {

			File file = new File(quadtreeFile);

			// Intento de cargar todo el quadtree en memoria

			FileSystemIndexStore store = new FileSystemIndexStore(file);

			QuadTree filequadtree = store.load();

			quadtree = new QuadTree(filequadtree.getNumShapes(), filequadtree

					.getMaxDepth(), filequadtree.getRoot().getBounds());

			Stack nodes = new Stack();

			nodes.push(filequadtree.getRoot());

			while (nodes.size() != 0) {

				Node node = (Node) nodes.pop();

				Envelope nodeEnv = node.getBounds();

				int[] shapeIds = node.getShapesId();

				for (int i = 0; i < shapeIds.length; i++) {

					quadtree.insert(shapeIds[i], nodeEnv);

				}

				int numSubnodes = node.getNumSubNodes();

				for (int i = 0; i < numSubnodes; i++) {

					nodes.push(node.getSubNode(i));

				}

			}// while

			filequadtree.close();

		}

	}

	public void flush() throws IndexException {

		flush(new File(quadtreeFile));

	}

	public void flush(File f) throws IndexException {

		byte order = 0;

		if ((byteOrder == null) || byteOrder.equalsIgnoreCase("NM")) {

			order = IndexHeader.NEW_MSB_ORDER;

		} else if (byteOrder.equalsIgnoreCase("NL")) {

			order = IndexHeader.NEW_LSB_ORDER;

		}

		FileSystemIndexStore store = new FileSystemIndexStore(f, order);

		try {

			store.store(quadtree);

			this.quadtreeFile = f.getAbsolutePath();

		} catch (StoreException e) {

			throw new IndexException(e);

		}

	}

	public void close() {

		try {

			quadtree.close();

		} catch (StoreException e) {

			// TODO Auto-generated catch block

			e.printStackTrace();

		}

	}

	public File getFile() {

		return new File(this.quadtreeFile);

	}

}

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

import java.io.File;

import java.io.IOException;

import org.gvsig.fmap.data.index.IndexException;

import org.gvsig.fmap.data.index.SpatialIndex;

import org.gvsig.fmap.data.index.SpatialIndexFactory;

import org.gvsig.fmap.data.index.SpatialIndexParameters;

public class QuadTreeGt2Factory extends SpatialIndexFactory {

	static {

		registerFactory(Factories.GT2_QUADTREE, "QuadTreeGt2Factory", QuadTreeGt2Factory.class);

	}

	public SpatialIndex createSpatialIndex(SpatialIndexParameters params) throws IndexException {

		if (params == null) {

			params = new SpatialIndexParameters();

		}

		SpatialIndex index = null;

		try {

			String filename = params.getFilename();

			File file = null;

			if (filename != null) {

				file = new File(filename);

			} else {

				file = File.createTempFile("gvsig", ".qix");

			}

			index = new QuadtreeGt2(file.getAbsolutePath(), "NM", params.getEnvelope(), params.getFeatureCount(), params.isOverwrite());

		} catch (IOException ioe) {

			throw new IndexException(ioe);

		}

		return index;

	}

/*	Metodo extraido de FlyrVect

	public SpatialIndex createSpatialIndex(FeatureStore store, File indexFile) throws SpatialIndexException {

		SpatialIndex spatialIndex = null;

		String fileName = indexFile.getAbsolutePath();

		SpatialIndex localCopy = null;

		Envelope fullExtent = (Envelope) store.getMetadata().get("extent");

		int featureCount = store.getMetadata().getInt("featureCount");

		double[] lc = fullExtent.getLowerCorner();

		double[] uc = fullExtent.getUpperCorner();

		com.vividsolutions.jts.geom.Envelope env = new com.vividsolutions.jts.geom.Envelope(lc[0], uc[0], lc[1], uc[1]);

		try {

			localCopy = new QuadtreeGt2(fileName, "NM", env, featureCount, true);

		} catch (SpatialIndexException sie1) {

			// Probably we dont have writing permissions

			String directoryName = System.getProperty("java.io.tmpdir");

			File newFile = new File(directoryName + File.separator

					+ indexFile.getName());

			String newFileName = newFile.getName();

			try {

				localCopy = new QuadtreeGt2(newFileName, "NM", fullExtent,

						featureCount, true);

			} catch (SpatialIndexException sie2) {

				// if we cant build a file based spatial index, we'll build

				// a pure memory spatial index

				localCopy = new QuadtreeJts();

			}

		} catch (Exception e) {

			e.printStackTrace();

		}// try

		BoundedShapes shapeBounds = (BoundedShapes) va.getDriver();

		try {

			for (int i = 0; i < va.getShapeCount(); i++) {

				if (cancelMonitor != null) {

					if (cancelMonitor.isCanceled())

						return;

					cancelMonitor.reportStep();

				}

				Rectangle2D r = shapeBounds.getShapeBounds(i);

				if (r != null)

					localCopy.insert(r, i);

			} // for

			va.stop();

			if (localCopy instanceof PersistentSpatialIndex)

				((PersistentSpatialIndex) localCopy).flush();

			spatialIndex = localCopy;

			// vectorial adapter needs a reference to the spatial index, to

			// solve

			// request for feature iteration based in spatial queries

			source.setSpatialIndex(spatialIndex);

		} catch (ReadDriverException e) {

			// TODO Auto-generated catch block

			e.printStackTrace();

		}

		return spatialIndex;

	}

*/

}

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

import org.gvsig.fmap.data.index.IndexException;

import org.gvsig.fmap.data.index.SpatialIndex;

import org.gvsig.fmap.data.index.SpatialIndexFactory;

import org.gvsig.fmap.data.index.SpatialIndexParameters;

public class QuadTreeJtsFactory extends SpatialIndexFactory {

	static {

		registerFactory(Factories.JTS_QUADTREE, "QuadTreeJtsFactory", QuadTreeJtsFactory.class);

	}

	public SpatialIndex createSpatialIndex(SpatialIndexParameters params) throws IndexException {

		return new QuadtreeJts();

	}

}

/*

 * Created on 28-abr-2006

 *

 * gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

*

* $Id: QuadtreeJts.java 11288 2007-04-19 17:32:50Z azabala $

* $Log$

* Revision 1.2  2007-04-19 17:32:50  azabala

* new constructor (fmap spatial index from an existing jts spatial index)

*

* Revision 1.1  2006/05/01 18:38:41  azabala

* primera version en cvs del api de indices espaciales

*

*

*/

package org.gvsig.fmap.data.index.spatial.jts;

import java.util.List;

import org.gvsig.fmap.data.index.AbstractIntBasedSpatialIndex;

import org.gvsig.fmap.data.index.SpatialIndex;

import com.vividsolutions.jts.geom.Envelope;

import com.vividsolutions.jts.index.quadtree.Quadtree;

/**

 * Adapter for ISPatialIndex gvSIG's interface to

 * JTS Quadtree.

 * 

 * 

 * @author azabala

 *

 */

public class QuadtreeJts extends AbstractIntBasedSpatialIndex implements SpatialIndex {

	private Quadtree quadtree;

	public QuadtreeJts(){

		quadtree = new Quadtree();

	}

	public QuadtreeJts(Quadtree jtsidx){

		quadtree = jtsidx;

	}

	public List query(org.gvsig.fmap.geom.primitive.Envelope env) {

		return quadtree.query(fromEnvelope(env));

	}

	public void insert(org.gvsig.fmap.geom.primitive.Envelope env, int index) {

		quadtree.insert(fromEnvelope(env), new Integer(index));

	}

	public void delete(org.gvsig.fmap.geom.primitive.Envelope env, int index) {

		quadtree.remove(fromEnvelope(env), new Integer(index));

	}

	private Envelope fromEnvelope(org.gvsig.fmap.geom.primitive.Envelope env){

		double[] min = env.getLowerCorner();

		double[] max = env.getUpperCorner();

		Envelope env2 = new Envelope(min[0], max[0], min[1], max[1]);

		return env2;

	}

}

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

import org.gvsig.fmap.data.index.IndexException;

import org.gvsig.fmap.data.index.SpatialIndex;

import org.gvsig.fmap.data.index.SpatialIndexFactory;

import org.gvsig.fmap.data.index.SpatialIndexParameters;

public class RTreeJsiFactory extends SpatialIndexFactory {

	static {

		registerFactory(Factories.JSI_RTREE, "RTreeJsiFactory", RTreeJsiFactory.class);

	}

	public SpatialIndex createSpatialIndex(SpatialIndexParameters params) throws IndexException {

		SpatialIndex index = null;

		if (params == null) {

			params = new SpatialIndexParameters();

		}

		if (params.getFilename() != null) {

			index = new PersistentRTreeJsi(params.getFilename(), params.isOverwrite());

		} else {

			index = new RTreeJsi();

		}

		if (index != null) {

			((RTreeJsi)index).create();

		}

		return index;

	}

}

/*

 * Created on 15-may-2006

 *

 * gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

*

* $Id: RTreeJsi.java 13884 2007-09-19 16:26:04Z jaume $

* $Log$

* Revision 1.5  2007-09-19 16:25:39  jaume

* ReadExpansionFileException removed from this context and removed unnecessary imports

*

* Revision 1.4  2007/06/27 20:17:30  azabala

* new spatial index (rix)

*

* Revision 1.3  2007/03/06 17:08:59  caballero

* Exceptions

*

* Revision 1.2  2006/06/05 16:59:08  azabala

* implementada busqueda de vecino mas proximo a partir de rectangulos

*

* Revision 1.1  2006/05/24 21:58:04  azabala

* *** empty log message ***

*

*

*/

package org.gvsig.fmap.data.index.spatial.jsi;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.List;

import java.util.Properties;

import org.gvsig.fmap.data.index.IndexException;

import org.gvsig.fmap.data.index.AbstractIntBasedSpatialIndex;

import org.gvsig.fmap.data.index.NearestNeighbourFinder;

import org.gvsig.fmap.data.index.SpatialIndex;

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

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

import com.infomatiq.jsi.IntProcedure;

import com.infomatiq.jsi.Rectangle;

import com.infomatiq.jsi.rtree.RTree;

/**

 * RTree spatial index implementation based in library

 * JSI (java spatial index).

 * 

 * http://jsi.sourceforge.net/

 * 

 * This RTree has better performance that Spatial Index Library

 * RTree, and that JTS'RTree, because

 * it uses the GNU's Trove Collections API.

 * 

 * We are doing some probes with it, because it offers

 * a Nearest Neighbour algorithm implementation 

 * (useful for Spatial Join geoprocess, for example).

 * 

 * It isnt persistent, and We've found some problems

 * with delete operations.

 * 

 * 

 * 

 * 

 * @author azabala

 *

 */

public class RTreeJsi extends AbstractIntBasedSpatialIndex implements SpatialIndex, NearestNeighbourFinder {

	private RTree rtree;

	public RTreeJsi(){

		rtree = new RTree();

	}

	public void create(){

		Properties props = new Properties();

//		props.setProperty("MaxNodeEntries", "500");

//		props.setProperty("MinNodeEntries", "200");

		rtree.init(props);

	}

	class ListIntProcedure implements IntProcedure{

		ArrayList solution = new ArrayList();

		public boolean execute(int arg0) {

			solution.add(new Integer(arg0));

			return true;

		}

		public List getSolution(){

			return solution;

		}

	}

	public List findNNearest(int numberOfNearest, Point2D point){

		com.infomatiq.jsi.Point jsiPoint =

			new com.infomatiq.jsi.Point((float)point.getX(), (float)point.getY());

		return (List) rtree.nearest(jsiPoint, numberOfNearest);

	}

	//FIXME Add this method to spatial index interface

	public Iterator iterator(){

		return rtree.iterator();

	}

	public int size(){

		return rtree.size();

	}	

	public void delete(Envelope env, int index) {		

		rtree.delete(toJsiRect(env), index);		

	}

	public void insert(Envelope env, int index) {

		rtree.add(toJsiRect(env), index);		

	}

	public List query(Envelope env) throws IndexException {

		ListIntProcedure solution = new ListIntProcedure();

		rtree.intersects(toJsiRect(env), solution);

		return solution.getSolution();

	}

	public List findNNearest(int numberOfNearest, Envelope env){

		return (List) rtree.nearest(toJsiRect(env), numberOfNearest);

	}	

	protected Rectangle toJsiRect(Envelope env){

		double[] min = env.getLowerCorner();

		double[] max = env.getUpperCorner();

		Rectangle jsiRect = new Rectangle((float)min[0],

				(float)min[1],

				(float)max[0],

				(float)max[1]);

		return jsiRect;

	}

}

/*

 * Created on 13-jun-2007

 *

 * gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

*

* $Id: PersistentRTreeJsi.java 12380 2007-06-27 20:17:30Z azabala $

* $Log$

* Revision 1.1  2007-06-27 20:17:30  azabala

* new spatial index (rix)

*

*

*/

package org.gvsig.fmap.data.index.spatial.jsi;

import java.awt.geom.Point2D;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.io.RandomAccessFile;

import java.nio.ByteOrder;

import java.nio.MappedByteBuffer;

import java.nio.channels.FileChannel;

import java.util.Iterator;

import java.util.LinkedHashMap;

import java.util.List;

import java.util.Properties;

import javax.imageio.stream.FileImageOutputStream;

import org.gvsig.fmap.data.index.IndexException;

import org.gvsig.fmap.data.index.PersistentSpatialIndex;

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

import com.infomatiq.jsi.Rectangle;

import com.infomatiq.jsi.rtree.RTree;

/**

 * Persistent spatial index which can resolve nearest neighbour queries.

 * <br>

 * 

 * To use:

 * 

 * PersistentRTreeJsi sptidx = new PersistentRtreeJsi("/home/kk");

 * if(sptidx.exists())

 *  sptidx.load();

 *  

 *  

 *  sptidx.add(rect, int);

 *  ...

 *  sptidx.add(rect2,int2);

 *  sptidx.flush();

 * 

 * @author azabala

 *

 */

public class PersistentRTreeJsi extends RTreeJsi implements PersistentSpatialIndex {

	/**

	 * Spatial index in memory

	 */

	private RTree rtree;

	/**

	 * Spatial index file

	 */

	private File rtreeFile;

	private boolean hasChange = false;

	/**

	 * Spatial index file extension

	 */

	final String rExt = ".rix";

	private LinkedHashMap  rectangles;

	/**

	 * Constructor

	 * @param file path of the spatial index file

	 * @throws IndexException 

	 */

	public PersistentRTreeJsi(String file, boolean overwrite) throws IndexException {

		rtree = new RTree();

		Properties props = new Properties();

		rtree.init(props);

		rtreeFile = new File(file + rExt);

		rectangles = new LinkedHashMap();

		if(! overwrite)

			load();

	}

	public void flush(File f) throws IndexException {

		try {

			if(! hasChange)

				return;

			RandomAccessFile file = new RandomAccessFile(f,

															"rw");

			FileImageOutputStream output = new FileImageOutputStream(file);

			output.setByteOrder(ByteOrder.LITTLE_ENDIAN);

			int numShapes = rtree.size();

			output.writeInt(numShapes);

			Iterator iterator = rtree.iterator();

			int count = 0;

			while(iterator.hasNext()){

				Integer  idx = (Integer) iterator.next();

				Rectangle nr = (Rectangle) rectangles.get(idx);

				float xmin = nr.min[0];

				float ymin = nr.min[1];

				float xmax = nr.max[0];

				float ymax = nr.max[1];

				output.writeFloat(xmin);

				output.writeFloat(ymin);

				output.writeFloat(xmax);

				output.writeFloat(ymax);

				output.writeInt(idx.intValue());

				count++;

			}

			output.flush();

			output.close();

			file.close();

			hasChange = false;

		} catch (FileNotFoundException e) {

			throw new IndexException(e);

		} catch (IOException e) {

			throw new IndexException(e);

		}

	}

	public void flush() throws IndexException {

		flush(rtreeFile);

	}

	public boolean exists() {

		return rtreeFile.exists();

	}

	public void load(File f) throws IndexException {

		if (f == null) throw new IllegalArgumentException("File f cannot be null");

		try {

			if(! f.exists()){

				return;

			}

			RandomAccessFile file = new RandomAccessFile(f, "r");

			FileChannel channel = file.getChannel();

			MappedByteBuffer buf = channel.map(FileChannel.MapMode.READ_ONLY, 0, channel.size());

			buf.order(ByteOrder.LITTLE_ENDIAN);

			int numShapes = buf.getInt();

			for(int i = 0; i < numShapes; i++){

				float xmin, ymin, xmax, ymax;

				int shapeIndex;

				xmin = buf.getFloat();

				ymin = buf.getFloat();

				xmax = buf.getFloat();

				ymax = buf.getFloat();

				shapeIndex = buf.getInt();

				Rectangle jsiRect = new Rectangle(xmin, ymin, xmax, ymax);

				rtree.add(jsiRect, shapeIndex);

			}

		}catch(Exception e){

			throw new IndexException(e);

		}		

	}

	public void load() throws IndexException {

		load(rtreeFile);

	}

	public void close() {

		rectangles.clear();

		rectangles = null;

	}

	public void insert(Envelope env, int index) {

		super.insert(env, index);

		rectangles.put(new Integer(index), toJsiRect(env));

		hasChange = true;

	}

	public void delete(Envelope env, int index) {

		super.delete(env, index);

		rectangles.remove(new Integer(index));

		hasChange = true;

	}

	public List findNNearest(int numberOfNearest, Point2D point){

		com.infomatiq.jsi.Point jsiPoint =

			new com.infomatiq.jsi.Point((float)point.getX(),(float)point.getY());

		return (List) rtree.nearest(jsiPoint, numberOfNearest);

	}

	public File getFile() {

		return this.rtreeFile;

	}

}

package org.gvsig.fmap.data.index.spatial.spatialindex;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.util.ArrayList;

import java.util.List;

import org.gvsig.fmap.data.index.IndexException;

import org.gvsig.fmap.data.index.AbstractIntBasedSpatialIndex;

import org.gvsig.fmap.data.index.NearestNeighbourFinder;

import org.gvsig.fmap.data.index.PersistentSpatialIndex;

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

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

import spatialindex.rtree.RTree;

import spatialindex.spatialindex.IData;

import spatialindex.spatialindex.INode;

import spatialindex.spatialindex.IVisitor;

import spatialindex.spatialindex.Region;

import spatialindex.storagemanager.DiskStorageManager;

import spatialindex.storagemanager.IBuffer;

import spatialindex.storagemanager.IStorageManager;

import spatialindex.storagemanager.PropertySet;

import spatialindex.storagemanager.RandomEvictionsBuffer;

/**

 * <p>

 * RTree spatial index based in spatial index library: <br>

 * http://u-foria.org/marioh/spatialindex/index.html <br>

 * marioh@cs.ucr.edu

 * </p>

 * It has the problem that spatial index file creation is a bit slowly

 * (in comparation with other indexes).

 */

public class RTreeSptLib extends AbstractIntBasedSpatialIndex implements PersistentSpatialIndex,

									NearestNeighbourFinder{

	/**

	 * Page size of associated file

	 */

	private static final int defaultPageSize = 32 * 1024;

	private static final double defaultFillFactor = 0.85d;

	/**

	 * Size of memory buffer of the index

	 */

	private static final int BUFFER_SIZE = 25000;

	RTree rtree;

	String rtreeFile;

	IStorageManager diskfile;

	/**

	 * Constructor

	 * @param overwriteFile tells if we must override existing files.

	 * If we are goint to create a new spatial index (or if we want to overwrite

	 * an existing one) we must to use always 'true'. If we want to load

	 * an existing spatial index file, overwrite must be 'false'

	 * @param fileName name of the rtree spatial index file

	 * @throws IndexException

	 */

	public RTreeSptLib(boolean overwriteFile, String fileName)

			throws IndexException {

		try {

			this.rtreeFile = fileName;

			PropertySet ps = new PropertySet();

			// overwrite the file if it exists.

			Boolean b = new Boolean(overwriteFile);

			ps.setProperty("Overwrite", b);

			// .idx and .dat extensions will be added.

			ps.setProperty("FileName", fileName);

			Integer i = new Integer(defaultPageSize);

			ps.setProperty("PageSize", i);

			diskfile = new DiskStorageManager(ps);

			load();

		} catch (SecurityException e) {

			throw new IndexException(e);

		} catch (FileNotFoundException e) {

			throw new IndexException(e);

		} catch (IOException e) {

			throw new IndexException(e);

		}

	}

	/**

	 * If the spatial index file exists and has content

	 */

	public boolean exists(){

		return (new File(rtreeFile+".dat").length() != 0);

	}

	class RTreeVisitor implements IVisitor{

		ArrayList solution = new ArrayList();

		public void visitNode(INode n) {

		}

		public void visitData(IData d) {

			solution.add(new Integer(d.getIdentifier()));

		}

		public List getSolution(){

			return solution;

		}

	}

	public List query(Envelope env) {

		List solution = null;

		Region region = createRegion(env);

		RTreeVisitor visitor = new RTreeVisitor();

		rtree.intersectionQuery(region,visitor);

		solution = visitor.getSolution();

		return solution;

	}

	public List containtmentQuery(Envelope env) {

		List solution = null;

		Region region = createRegion(env);

		RTreeVisitor visitor = new RTreeVisitor();

		rtree.containmentQuery(region,visitor);

		solution = visitor.getSolution();

		return solution;

	}

	/**

	 * Warn! This RTree implemention doesnt care if 'index'

	 * entry has been indexed yet

	 */

	public void insert(Envelope env, int index) {

		rtree.insertData(null, createRegion(env), index);

	}

	private Region createRegion(Envelope env){

		return new Region(env.getLowerCorner(), env.getUpperCorner());

	}

	public void delete(Envelope env, int index) {

		rtree.deleteData(createRegion(env), index);

	}

	/**

	 * Looks for N indexes nearest to the specified rect.

	 * @param numberOfNearest

	 * @param rect

	 * @return

	 */

	public List findNNearest(int numberOfNearest, Envelope env) {

		List solution = null;

		Region region = createRegion(env);

		RTreeVisitor visitor = new RTreeVisitor();

		rtree.nearestNeighborQuery(numberOfNearest, region,visitor);

		solution = visitor.getSolution();

		return solution;

	}

	/**

	 * Looks for the N indexes nearest to the specified point

	 * @param numberOfNearest

	 * @param point

	 * @return

	 */

	public List findNNearest(int numberOfNearest, Point2D point) {

		List solution = null;

		spatialindex.spatialindex.Point sptPoint = new

			spatialindex.spatialindex.Point(new double[]{point.getX(), point.getY()});

		RTreeVisitor visitor = new RTreeVisitor();

		rtree.nearestNeighborQuery(numberOfNearest, sptPoint,visitor);

		solution = visitor.getSolution();

		return solution;

	}

	public void flush(){

		rtree.flush();

	}

	public void load() {

//		 applies a main memory random buffer on top of the persistent

		// storage manager

		IBuffer buffer = new RandomEvictionsBuffer(diskfile, BUFFER_SIZE, false);

		// Create a new, empty, RTree with dimensionality 2, minimum load

		// 70%, using "file" as

		// the StorageManager and the RSTAR splitting policy.

		PropertySet ps2 = new PropertySet();

		Double f = new Double(defaultFillFactor);

		ps2.setProperty("FillFactor", f);

		Integer i = new Integer(2);

		ps2.setProperty("Dimension", i);

		File file = new File(rtreeFile + ".dat");

		if(file.length() != 0){

			ps2.setProperty("IndexIdentifier", new Integer(1));

		}

		rtree = new RTree(ps2, buffer);

	}

	public void load(File f) throws IndexException {

		load();

	}

	public void flush(File f) throws IndexException {

		flush();

	}

	public void close() {

	}

	public File getFile() {

		return new File(this.rtreeFile);

	}

}

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

import java.io.File;

import java.io.IOException;

import org.gvsig.fmap.data.index.IndexException;

import org.gvsig.fmap.data.index.SpatialIndex;

import org.gvsig.fmap.data.index.SpatialIndexFactory;

import org.gvsig.fmap.data.index.SpatialIndexParameters;

public class RTreeSptLibFactory extends SpatialIndexFactory {

	static {

		registerFactory(Factories.SPATIALINDEX_RTREE, "RTreeSptLibFactory", RTreeSptLibFactory.class);

	}

	public SpatialIndex createSpatialIndex(SpatialIndexParameters params) throws IndexException {

		if  (params == null) {

			params = new SpatialIndexParameters();

		}

		String filename =  params.getFilename();

		if (filename == null) {

			try {

				File file = File.createTempFile("gvsig", ".qix");

				filename = file.getAbsolutePath();

				params.setOverwrite(true);

			} catch (IOException ioe) {

				throw new IndexException(ioe);

			}

		}

		return new RTreeSptLib(params.isOverwrite(), filename);

	}

}