001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.text.nlp.geocode;
031
032import org.apache.commons.lang.StringUtils;
033import org.apache.solr.client.solrj.SolrServerException;
034import org.apache.solr.client.solrj.response.QueryResponse;
035import org.apache.solr.common.SolrDocumentList;
036
037/**
038 * Use a Solr index built against the geonames allcountries.txt dump.
039 * Several attempts are made to interrogate the index.
040 * @author Sina Samangooei (ss@ecs.soton.ac.uk), Jonathan Hare (jsh2@ecs.soton.ac.uk), David Duplaw (dpd@ecs.soton.ac.uk)
041 *
042 */
043public class ReverseGeoCode {
044        private GeonamesIndex geoindex;
045        private String validCodes;
046
047        /**
048         * 
049         */
050        public ReverseGeoCode() {
051                this.geoindex = GeonamesIndex.instance();
052                this.validCodes = null;
053        }
054        
055        /**
056         * @param validCountryCodes
057         */
058        public ReverseGeoCode(String ... validCountryCodes){
059                String[] prefixed = new String[validCountryCodes.length];
060                int i = 0;
061                for (String vcc : validCountryCodes) {
062                        prefixed[i++] = "country_code:"+vcc;
063                }
064                this.validCodes = String.format("(%s)^2", StringUtils.join(prefixed, " OR "));
065        }
066        
067        /**
068         * @param raw
069         * @return The estimated country_code 
070         */
071        public String countryCode(String raw){
072                try {
073                        QueryResponse qres = this.geoindex.query(constructQuery(raw));
074                        SolrDocumentList res = qres.getResults();
075                        return (String) res.get(0).get("country_code");
076                } catch (SolrServerException e) {
077                        
078                }
079                return null;
080        }
081
082        private String constructQuery(String raw) {
083                String query = "{!type=dismax qf=\"country_code basic_name timezone\" mm=1}";
084                if(validCodes!=null){
085                        query +=this.validCodes + " AND ";
086                }
087                query += raw;
088                return query;
089        }
090}