| gvSIG desktop 1

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

import java.util.Iterator;

import java.util.List;

import java.util.Set;

import java.util.TreeSet;

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.FeatureQuery;

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

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

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

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.distance.StringsDistance;

import org.gvsig.geocoding.distance.impl.LevenshteinDistance;

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.evaluator.Evaluator;

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 DataGeocoderImpl implements DataGeocoder {

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

        private GeocodingPattern pattern = null;

        private DataStore store = null;

        private DataManager manager = null;

        /**

         * Constructor with one pattern

         * 

         * @param pattern

         */

        public DataGeocoderImpl() {

                manager = DALLocator.getDataManager();

        }

        /**

         * Constructor with one pattern

         * 

         * @param pattern

         */

        public DataGeocoderImpl(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;

        }

        /**

         * Geocoding process

         * 

         * @param address

         * @return results

         */

        public Set<GeocodingResult> geocode(Address address)

                        throws LocatorException, DataException {

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

                // get the style

                AbstractGeocodingStyle astyle = getPattern().getDataSource().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 = literalSearch(

                                        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 = literalSearch(

                                        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 = literalSearch(

                                        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 = literalSearch(

                                        relationsLiteral, mainAddressLiteral, store);

                        lists.add(literalResults);

                        // search in others literals

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

                        for (Literal addrLiteral : intersectslist) {

                                // literal search

                                List<ScoredFeature> secList = literalSearch(relationsLiteral,

                                                addrLiteral, store);

                                lists.add(secList);

                        }

                        // Match

                        results = style.match(lists, address);

                }

                return results;

        }

        /**

         * First scouting process, search literal elements in data store and return

         * a list with ok scored features

         * 

         * @param relationsLiteral

         * @param addressLiteral

         * @param store

         * @return

         * @throws DataException

         */

        private List<ScoredFeature> literalSearch(Literal relationsLiteral,

                        Literal addressLiteral, DataStore store) throws DataException {

                List<FeatureSelection> sels = new ArrayList<FeatureSelection>();

                FeatureSet features = null;

                //int maxres = getPattern().getSettings().getResultsNumber();

                int cont = relationsLiteral.size();

                int cont2 = relationsLiteral.size();

                for (int j = 0; j < cont; j++) {

                        String expresion = null;

                        String value;

                        int num = 0;

                        FeatureSelection selection = ((FeatureStore) store)

                                        .createFeatureSelection();

                        FeatureQuery query = ((FeatureStore) store).createFeatureQuery();

                        for (String key : relationsLiteral.keySet()) {

                                if (num < cont2) {

                                        key = key.trim();

                                        value = relationsLiteral.get(key);

                                        String chain = addressLiteral.get(key);

                                        if (num == 0) {

                                                expresion = value + " = '" + chain + "'";

                                        } else {

                                                expresion = expresion + " and " + value + " = '"

                                                                + chain + "'";

                                        }

                                        num++;

                                } else {

                                        break;

                                }

                        }

                        log.debug("EXPRESION: " + expresion);

                        Evaluator eval = manager.createExpresion(expresion);

                        query.setFilter(eval);

                        features = ((FeatureStore) store).getFeatureSet(query);

                        log.debug("FEatures selected: " + features.getSize());

                        selection.select(features);

                        sels.add(selection);

                        if (selection.getSize() > 0) {

                                break;

                        }

                        cont2--;

                }

                // Put scores

                List<ScoredFeature> scores = createLiteralScores(store, sels, relationsLiteral, addressLiteral );

                return scores;

        }

        /**

         * Create score of the feature to first literal search

         * 

         * @param store

         * @param sels

         * @return

         * @throws DataException

         */

        @SuppressWarnings("unchecked")

        private List<ScoredFeature> createLiteralScores(DataStore store,

                        List<FeatureSelection> sels, Literal relationsLiteral,

                        Literal addressLiteral ) throws DataException {

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

                FeatureSet features = ((FeatureStore) store).getFeatureSet();

                for (Iterator<Feature> it = features.iterator(); it.hasNext();) {

                        Feature feature = it.next();

                        double num = 0;

                        for (int i = 0; i < sels.size(); i++) {

                                FeatureSelection sel = sels.get(i);

                                if (sel.isSelected(feature)) {

                                        double sco = scorePonderated(i, sels.size()) - stringsDistance(feature, relationsLiteral, addressLiteral);

                                        if(sco < 0){

                                                sco = 0;

                                        }

                                        num = num + sco;

                                }

                        }

                        if (num > 0.0) {

                                ScoredFeature scoFeat = new DefaultScoredFeature();

                                scoFeat.setReference(feature.getReference());

                                scoFeat.setScore(num);

                                scores.add(scoFeat);

                        }

                }

                return scores;

        }

        /**

         * Get the score value ponderated

         * 

         * @param i

         *            position

         * @param total

         * @return score

         */

        private double scorePonderated(int i, int total) {

                if (total == 1) {

                        return 100.0;

                }

                double score = 100.0 / (2.0 * (i + 1));

                return score;

        }

        /**

         * 

         * @param feat

         * @param relations

         * @param address

         * @return

         */

        private double stringsDistance(Feature feat, Literal relations, Literal address){

                double pes = 0;

                StringsDistance strDist = new LevenshteinDistance();

                for (String key : relations.keySet()) {

                        String field = relations.get(key);

                        String value = address.get(key);

                        Object obj = feat.get(field);

                        String value2 = obj.toString();

                        int dist = strDist.getStringsDistance(value.toUpperCase(), value2.toUpperCase());

                        pes = pes + dist;                

                }

                return pes;

        }

}