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 PRODEVELOP                Main development

 */

package org.gvsig.geocoding.impl;

import java.io.File;

import java.io.IOException;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.List;

import java.util.Set;

import java.util.TreeSet;

import org.apache.lucene.analysis.standard.StandardAnalyzer;

import org.apache.lucene.document.Document;

import org.apache.lucene.document.Field;

import org.apache.lucene.index.CorruptIndexException;

import org.apache.lucene.index.IndexWriter;

import org.apache.lucene.queryParser.MultiFieldQueryParser;

import org.apache.lucene.queryParser.ParseException;

import org.apache.lucene.search.Hits;

import org.apache.lucene.search.IndexSearcher;

import org.apache.lucene.search.Query;

import org.apache.lucene.store.LockObtainFailedException;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.exception.DataException;

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

import org.gvsig.fmap.dal.feature.FeatureReference;

import org.gvsig.fmap.dal.feature.FeatureSet;

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

import org.gvsig.fmap.dal.feature.spi.FeatureReferenceProviderServices;

import org.gvsig.geocoding.DataGeocoder;

import org.gvsig.geocoding.address.Address;

import org.gvsig.geocoding.address.ComposedAddress;

import org.gvsig.geocoding.address.Literal;

import org.gvsig.geocoding.address.NumberAddress;

import org.gvsig.geocoding.index.FeatureIndexedEvent;

import org.gvsig.geocoding.index.IndexListener;

import org.gvsig.geocoding.pattern.GeocodingPattern;

import org.gvsig.geocoding.result.GeocodingResult;

import org.gvsig.geocoding.result.ScoredFeature;

import org.gvsig.geocoding.result.impl.DefaultScoredFeature;

import org.gvsig.geocoding.styles.AbstractGeocodingStyle;

import org.gvsig.geocoding.styles.impl.Composed;

import org.gvsig.geocoding.styles.impl.DoubleRange;

import org.gvsig.geocoding.styles.impl.SimpleCentroid;

import org.gvsig.geocoding.styles.impl.SimpleRange;

import org.gvsig.tools.locator.LocatorException;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Data geocoder implementation

 * 

 * @author <a href="mailto:jsanz@prodevelop.es"> Jorge Gaspar Sanz Salinas</a>

 * @author <a href="mailto:vsanjaime@prodevelop.es"> Vicent Sanjaime Calvet</a>

 */

public class LuceneGeocoderImpl implements DataGeocoder {

        private Logger log = LoggerFactory.getLogger(LuceneGeocoderImpl.class);

        private GeocodingPattern pattern = null;

        private DataStore store = null;

        @SuppressWarnings("unused")

        private DataManager manager = null;

        private int position = 0;

        private IndexListener indexListener;

        /*

         * This path is a temporal folder. This code is a copy of the

         * libRemoteServices and LibRaster

         */

        private static String tempDirectoryPath = System

                        .getProperty("java.io.tmpdir")

                        + File.separator + "tmp-andami";

        private static String GeocoID = "GEOC_ID";

        /**

         * Constructor with one pattern

         * 

         * @param pattern

         */

        public LuceneGeocoderImpl() {

                manager = DALLocator.getDataManager();

        }

        /**

         * Constructor with one pattern

         * 

         * @param pattern

         */

        public LuceneGeocoderImpl(GeocodingPattern pattern) {

                this.pattern = pattern;

                manager = DALLocator.getDataManager();

        }

        /**

         * set the pattern

         * 

         * @param pattern

         */

        public void setPattern(GeocodingPattern pattern) {

                this.pattern = pattern;

        }

        /**

         * Get the pattern

         * 

         * @return pattern

         */

        public GeocodingPattern getPattern() {

                return this.pattern;

        }

        /**

         * Set the store

         */

        public void setStore(DataStore store) {

                this.store = store;

        }

        /**

         * Get the store

         * 

         * @return

         */

        public DataStore getStore() {

                return this.store;

        }

        /**

         * 

         */

        public Set<GeocodingResult> geocode(Address address)

                        throws LocatorException, DataException {

                Set<GeocodingResult> results = new TreeSet<GeocodingResult>();

                // get the style

                AbstractGeocodingStyle astyle = getPattern().getSource().getStyle();

                // get literal with relations with the store

                Literal relationsLiteral = astyle.getRelationsLiteral();

                // list of list with one or more literal results

                List<List<ScoredFeature>> lists = new ArrayList<List<ScoredFeature>>();

                // get layer store

                // SIMPLE CENTROID

                if (astyle instanceof SimpleCentroid) {

                        SimpleCentroid style = (SimpleCentroid) astyle;

                        Literal addressLiteral = address.getMainLiteral();

                        // literal search

                        List<ScoredFeature> literalResults = indexSearch(relationsLiteral,

                                        addressLiteral, store);

                        lists.add(literalResults);

                        // Geom search

                        results = style.match(lists, address);

                }

                // SIMPLE RANGE

                else if (astyle instanceof SimpleRange) {

                        SimpleRange style = (SimpleRange) astyle;

                        Literal addressLiteral = ((NumberAddress) address).getMainLiteral();

                        // literal search

                        List<ScoredFeature> literalResults = indexSearch(relationsLiteral,

                                        addressLiteral, store);

                        lists.add(literalResults);

                        // geom search

                        results = style.match(lists, address);

                }

                // DOUBLE RANGE

                else if (astyle instanceof DoubleRange) {

                        DoubleRange style = (DoubleRange) astyle;

                        Literal addressLiteral = ((NumberAddress) address).getMainLiteral();

                        // literal search

                        List<ScoredFeature> literalResults = indexSearch(relationsLiteral,

                                        addressLiteral, store);

                        lists.add(literalResults);

                        // number search

                        results = style.match(lists, address);

                }

                // STYLE COMPOSED

                else if (astyle instanceof Composed) {

                        Composed style = (Composed) astyle;

                        ComposedAddress cAddress = (ComposedAddress) address;

                        // main literal search

                        Literal mainAddressLiteral = cAddress.getMainLiteral();

                        List<ScoredFeature> literalResults = indexSearch(relationsLiteral,

                                        mainAddressLiteral, store);

                        lists.add(literalResults);

                        // search in others literals

                        List<Literal> intersectslist = cAddress.getIntersectionLiterals();

                        for (Literal addrLiteral : intersectslist) {

                                // literal search

                                List<ScoredFeature> secList = indexSearch(relationsLiteral,

                                                addrLiteral, store);

                                lists.add(secList);

                        }

                        // Match

                        results = style.match(lists, address);

                }

                return results;

        }

        /**

         * 

         * @param relationsLiteral

         * @param addressLiteral

         * @param store

         * @return

         * @throws DataException

         */

        private List<ScoredFeature> indexSearch(Literal relationsLiteral,

                        Literal addressLiteral, DataStore store) throws DataException {

                List<ScoredFeature> scorefeats = new ArrayList<ScoredFeature>();

                double minScore = getPattern().getSettings().getScore();

                // search

                Hits hits =  seachOnIndex(relationsLiteral, addressLiteral);

                // if there are hits in search process

                if (hits != null) {

                        // filter results

                        try {

                                scorefeats = filterHitsByScore(store, hits, minScore);

                        } catch (Exception e) {

                                log.error("Error filtering hits by score", e);

                                scorefeats.clear();

                        }

                }

                return scorefeats;

        }

        /**

         * 

         * @param relationsLiteral

         * @param addressLiteral

         * @return

         */

        private Hits seachOnIndex(Literal relationsLiteral, Literal addressLiteral)

                         {

                log.debug("Buscar ...");

                IndexSearcher searcher = null;

                try {

                        searcher = new IndexSearcher(tempDirectoryPath);

                } catch (Exception e) {

                        log.debug("Error building index searcher", e);

                        log.debug("Rebuild the index file because the initial index is wrong");

                        try {

                                this.indexer(store, relationsLiteral);

                        } catch (Exception e1) {

                                log.debug("Error building index searcher", e1);

                                return null;

                        }

                }

                if (searcher != null) {

                        String[] input = addressLiteral.getStringValuesArray();

                        String[] fields = relationsLiteral.getStringValuesArray();

                        Query query = null;

                        try {

                                query = MultiFieldQueryParser.parse(input, fields,

                                                new StandardAnalyzer());

                        } catch (ParseException e) {

                                log.debug("Error building the query", e);

                                return null;

                        }

                        Hits hits = null;

                        if(query != null){

                                try {

                                        hits = searcher.search(query);

                                } catch (IOException e) {

                                        log.debug("Error in the searching process", e);

                                        return null;

                                }

                        }

                        return hits;

                } else {

                        return null;

                }

        }

        /**

         * 

         * @param store

         * @param hits

         * @param score

         * @return

         * @throws IOException

         * @throws DataException

         */

        private List<ScoredFeature> filterHitsByScore(DataStore store, Hits hits,

                        double score) throws IOException, DataException {

                FeatureStore fstore = (FeatureStore) store;

                List<ScoredFeature> scoreFeats = new ArrayList<ScoredFeature>();

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

                        if (hits.score(i) * 100 > score) {

                                Document doc = hits.doc(i);

                                String id = doc.get(GeocoID);

                                FeatureSet fset = fstore.getFeatureSet();

                                Iterator it = fset.fastIterator((new Long(id)).longValue());

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

                                ScoredFeature scoFeat = new DefaultScoredFeature();

                                scoFeat.setReference(feature.getReference());

                                scoFeat.setScore(hits.score(i) * 100);

                                scoreFeats.add(scoFeat);

                        }

                }

                return scoreFeats;

        }

        /**

         * 

         * @param store

         * @param relationsLiteral

         * @throws DataException

         * @throws CorruptIndexException

         * @throws LockObtainFailedException

         * @throws IOException

         */

        public void indexer(DataStore store, Literal relationsLiteral)

                        throws DataException, CorruptIndexException,

                        LockObtainFailedException, IOException {

                log.debug("Create indexes ...");

                IndexWriter indexWriter = new IndexWriter(tempDirectoryPath,

                                new StandardAnalyzer(), true);

                FeatureStore fstore = (FeatureStore) store;

                FeatureSet features = fstore.getFeatureSet();

                String[] fields = relationsLiteral.getStringValuesArray();

                Feature feat = null;

                Iterator it = features.fastIterator();

                // process situation

                this.position = 0;

                while (it.hasNext()) {

                        Document doc = new org.apache.lucene.document.Document();

                        feat = (Feature) it.next();

                        FeatureReference rfeat = feat.getReference();

                        FeatureReferenceProviderServices servFeat = (FeatureReferenceProviderServices) rfeat;

                        Object oid = servFeat.getOID();

                        Field idfield = new Field(GeocoID, oid + "", Field.Store.YES,

                                        Field.Index.UN_TOKENIZED);

                        doc.add(idfield);

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

                                String fieldName = (String) fields[i];

                                String attribute = feat.getString(fieldName);

                                Field field = new Field(fieldName, attribute, Field.Store.YES,

                                                Field.Index.TOKENIZED);

                                doc.add(field);

                        }

                        indexWriter.addDocument(doc);

                        // throw indexed event

                        if(this.indexListener != null){

                                this.indexListener.featureIndexed(new FeatureIndexedEvent(this));

                        }                        

                        // new position

                        this.position++;

                }

                indexWriter.optimize();

        }

        /**

         * 

         * @param listener

         */

        public void registreIndexListener(IndexListener listener){

                this.indexListener = listener;

        }

        /**

         * 

         * @return

         */

        public int getIndexPosition() {

                return position;

        }

}