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 org.apache.log4j.Logger;

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

import org.gvsig.tools.extensionPoint.ExtensionPoint;

import org.gvsig.tools.extensionPoint.ExtensionPointsSingleton;

/**

 * Abstract factory for registering and retrieving available indexing engines. 

 * You can force the use of a specific implementation by passing its key, or you can use the default

 * implementation for a given data type by specifying the {@link AttributeDescriptor} of the column 

 * to be indexed.

 * 

 * @author jyarza

 *

 */

public abstract class AbstractDataIndexProvider {

	private static Logger logger = Logger.getLogger(AbstractDataIndexProvider.class);

	/**

	 * Convenience constants to identify sets of implemented factories classified by supported data types. 

	 * Using these from a client is not permitted as implementations are optional and not visible.

	 */

	public interface Factories {

		public interface GEOMETRY {

			public static final String GT2_QUADTREE = "QuadTreeGt2Factory";

			public static final String JSI_RTREE = "RTreeJsiFactory";

			public static final String JTS_QUADTREE = "QuadTreeJtsFactory";

			public static final String SPATIALINDEX_RTREE = "RTreeSptLibFactory";

			public static final String DEFAULT = GT2_QUADTREE;

		}

		public interface DATE {

			// added as example

		}

		public interface INTEGER {

			// added as example			

		}

	}

	// Register extension point, all available factory implementations will hang off here.

	public static final String EXTENSION_POINT_NAME =  "IndexFactory";

	private static ExtensionPoint ep = new ExtensionPoint(EXTENSION_POINT_NAME, "Index Factory");

	static {		

		ExtensionPointsSingleton.getInstance().put(ep);

	}

	/**

	 * Returns the default index factory registered for the given data type.

	 * @param col

	 * @return

	 * @throws InstantiationException

	 * @throws IllegalAccessException

	 */

	public static AbstractDataIndexProvider getDefaultFactory(FeatureAttributeDescriptor col) throws InstantiationException, IllegalAccessException {

		int type = col.getDataType();

		if (type == FeatureAttributeDescriptor.GEOMETRY) {

			return getFactory(Factories.GEOMETRY.DEFAULT);

		} else {

			throw new UnsupportedOperationException(type + " indexes are not supported.");

		}

	}

	/**

	 * Returns a specific index factory by key. 

	 * The argument implType must be one of the constants defined in {@link AbstractDataIndexProvider.Factories}

	 * @param implType

	 * @return

	 * @throws InstantiationException

	 * @throws IllegalAccessException

	 */

	public static AbstractDataIndexProvider getFactory(String key) throws InstantiationException, IllegalAccessException {

		if (!ep.containsKey(key)) {

			throw new IllegalArgumentException(key + " is not a valid factory.");

		}

		return (AbstractDataIndexProvider) ep.create(key);

	}

	/**

	 * Registers an index factory.

	 * @param key Name by which the factory will be identified

	 * @param description

	 * @param value

	 */

	protected static void registerFactory(String key, String description, Class value) {

		ep.put(key, description, value);

		logger.debug(key + " registered.");

	}

	/**

	 * Creates and returns a new index using default parameters.

	 * @return

	 * @throws DataIndexException

	 */

	public DataIndex createIndex() throws DataIndexException {

		return createIndex(null);

	}

	/**

	 * Creates and returns a new index using the given parameters.

	 * @param params

	 * @return

	 * @throws DataIndexException

	 */

	public abstract DataIndex createIndex(IndexParameters params) throws DataIndexException;

}

/* 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.util.HashMap;

import java.util.Map;

import org.gvsig.tools.exception.BaseException;

/**

 * @author jiyarza

 */

public class DataIndexException extends BaseException {

	private static final long serialVersionUID = 932690269454242645L;	

	private static final String MESSAGE_KEY = "index_exception";

	private static final String FORMAT_STRING = 

		"Index Exception.";	

	/**

	 * Main constructor that provides a cause Exception

	 * @param e

	 */

	public DataIndexException(Exception e) {

		super(FORMAT_STRING, e, MESSAGE_KEY, serialVersionUID);

	}

	protected Map values() {

		HashMap map = new HashMap();

		return map;

	}

}

/* 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.util.List;

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

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

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

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

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

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

/**

 * Interface for any Index. 

 * @author jyarza

 *

 */

public interface DataIndex {

	/** Column to which belongs this index */

	public FeatureAttributeDescriptor getFeatureAttributeDescriptor();

	/** FeatureType to which belongs this index */

	public FeatureType getFeatureType();

	/** FeatureStore to which belongs this index */

	public FeatureStore getFeatureStore();

	/** Index name */

	public String getName();

	/** Indicates if this index should overwrite itself on creation, if it exists already */

	public boolean isOverwrite();

	/** 

	 * This is the most basic insertion method.

	 * Inserts an object into the index, with the specified id. 

	 */

	public void insert(Object o, FeatureID fid);

	/**

	 * Inserts a Feature in the index.

	 * The Feature must contain a column that matches this index's column (name and data type)

	 * @param feat

	 */

	public void insert(Feature feat);

	/**

	 * Inserts a FeatureCollection into this index

	 * FeatureType is not checked so it will accept any FeatureType

	 * as long as exists a column with a valid name

	 */	

	public void insert(FeatureCollection data);

	/** 

	 * This is the most basic deletion method.

	 * Deletes an object from the index, given its id

	 **/

	public void delete(Object o, FeatureID fid);

	/**

	 * Deletes a Feature in the index.

	 * The Feature must contain a column that matches this index's column (name and data type)

	 * @param feat

	 */

	public void delete(Feature feat);

	/**

	 * Deletes a FeatureCollection from this index

	 * FeatureType is not checked so it will accept any FeatureType

	 * as long as exists a column with a valid name

	 */	

	public void delete(FeatureCollection data) throws DataIndexException;

	/** Performs a search in the index that meet the given parameters */

	public List query(QueryParameters params) throws DataIndexException;

}

/* 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.util.Iterator;

import java.util.List;

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

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

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

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

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

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

public abstract class AbstractDataIndex implements DataIndex {

	private final IndexParameters params;

	public AbstractDataIndex(IndexParameters params) throws DataIndexException {

		if (params == null) {

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

		}

		this.params = params;

	}

	public final FeatureAttributeDescriptor getFeatureAttributeDescriptor() {

		return params.getFeatureAttributeDescriptor();

	}

	public final FeatureStore getFeatureStore() {

		return params.getFeatureStore();

	}

	public final FeatureType getFeatureType() {

		return params.getFeatureType();

	}

	public final String getName() {

		return params.getName();

	}

	public final boolean isOverwrite() {

		return params.isOverwrite();

	}

	/**

	 * Fills this index with all the data in its FeatureStore

	 */

	public final void fill() throws DataIndexException {

		try {

			insert(getFeatureStore().getFeatureCollection());

		} catch (DataException e) {

			throw new DataIndexException(e);

		}

	}

	public final void insert(FeatureCollection data) {

		Iterator it = data.iterator();

		while (it.hasNext()) {

			Feature feat = (Feature) it.next();

			insert(feat);

		}

	}

	public void insert(Feature feat) {

		try {

			insert(feat.get(getFeatureAttributeDescriptor().getName()), feat.getID());

		} catch (NullPointerException e) {

			throw new IllegalArgumentException("Feature does not contain a column with name " + getFeatureAttributeDescriptor().getName());

		} catch (ClassCastException e) {

			throw new IllegalArgumentException("Column data type is not valid.");

		}

	}

	public abstract List query(QueryParameters params) throws DataIndexException;

}

/* 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.util.HashMap;

import java.util.Iterator;

import java.util.Map;

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

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

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

/**

 * Renombrar a Indexes--

 * 

 * 

 * API - Index

 * 		 AbstractIndex

 * Impl   ^

 * SPI - IndexProvider (initialize)

 *       AbstractIndexProvider

 * 

 * Eliminar factorias (logica de create index pasa a initialize())

 * Eliminar abstractFactory (l?gica pasa a DataManager).

 * 

 * 

 * 	// DATAMANAGER

	public List getIndexProviders(int dataType); (of names)

	public registerIndexProvider(IndexProvider);

	public IndexProvider createIndexProvider(store, ftype, att, [names]);

 * 

 *  public setDefaultIndexProvider(int dataType, String name);

 *  

 *  public File getTemporaryDirectory();

 *  

 *  INDEXES

 *  -------

 *  

 *  Lista plana por nombre.

 *  Quitar IndexParameters

 * 

 * 

 * 

 * This class provides access to a FeatureStore local indexes.

 * This class holds the correspondence (FeatureType, columName) -> Index

 * TODO there is not persistence and works only in memory

 * @author jyarza

 */

public class DataIndexes {

	private Map featureTypes = new HashMap();

	/**

	 * Creates an empty IndexRegistry for the given FeatureStore

	 * 

	 * @param store

	 *            FeatureStore to whom this IndexRegistry belongs

	 * @throws DataException

	 */

	public DataIndexes(FeatureStore store) throws DataException {

		Iterator it = store.getFeatureTypes().iterator();

		while (it.hasNext()) {

			FeatureType type = (FeatureType) it.next();

			featureTypes.put(type, new HashMap());

		}

	}

	/**

	 * Returns an Index given the FeatureType and the name of the column.

	 * If the column has no index then this method returns <code>null</code>.

	 * @param fType FeatureType to which belongs the index

	 * @param colName name of the column

	 * @return if the index exists then this method returns the index, otherwise it returns null.

	 */

	public DataIndex getIndex(FeatureType fType, String colName) {

		Map indexes = (Map) featureTypes.get(fType);

		if (indexes != null) {

			return (DataIndex) (featureTypes.get(fType));

		}

		return null;

	}

	/**

	 * Adds an index to the registry, given its FeatureType and column name

	 * @param fType

	 * @param colName

	 * @param index

	 */

	public void addIndex(FeatureType fType, String colName, DataIndex index) {

		Map indexes = (Map) featureTypes.get(fType);

		if (indexes == null) {

			// A new feature type has been added to the FeatureStore since this IndexStore was created

			indexes = new HashMap();

			featureTypes.put(fType, indexes);

		}

		indexes.put(colName, index);

	}

	/**

	 * Returns true if this registry contains an index for the given FeatureType and column name, otherwise

	 * it returns false.

	 * @param fType

	 * @param colName

	 * @return <code>true</code> if the index exists, <code>false</code> if it does not.

	 */

	public boolean contains(FeatureType fType, String colName) {

		Map map = (Map) featureTypes.get(fType);

		return map == null ? false : map.containsKey(colName);

	}

}

/**

 * Parameters for index querying.

 * 

 * Typically will hold a range, for example:

 * 

 * - If the index is of type geometry (spatial) it will hold an envelope

 * - If the index is of type integer it will hold an interval [min, max]

 * @author jyarza

 *

 */