001    /*
002     * Apache License
003     * Version 2.0, January 2004
004     * http://www.apache.org/licenses/
005     *
006     * Copyright 2008 by chenillekit.org
007     *
008     * Licensed under the Apache License, Version 2.0 (the "License");
009     * you may not use this file except in compliance with the License.
010     * You may obtain a copy of the License at
011     *
012     * http://www.apache.org/licenses/LICENSE-2.0
013     */
014    
015    package org.chenillekit.google.services;
016    
017    import java.util.Locale;
018    
019    import org.chenillekit.google.utils.GeoCodeLocation;
020    import org.chenillekit.google.utils.geocode.GeoCodeResult;
021    
022    /**
023     * This service let you ues some Google Maps services in your application.
024     *
025     * @version $Id: GoogleGeoCoder.java 594 2009-12-05 15:17:26Z mlusetti $
026     */
027    public interface GoogleGeoCoder extends GoogleService
028    {
029            /**
030             * get the geo code from google map service for address.
031             *
032             * @param geoCodeLocation location holder
033             */
034            GeoCodeResult getGeoCode(GeoCodeLocation geoCodeLocation);
035    
036            /**
037             * get the geo code from google map service for address.
038             *
039             * @param street  the street
040             * @param country the country
041             * @param state   the state
042             * @param zipCode the zip code
043             * @param city  the city
044             */
045            GeoCodeResult getGeoCode(String street, String country, String state, String zipCode, String city);
046    
047            /**
048             * get the geo code from google map service for address.
049             *
050             * @param locale
051             * @param street  the street
052             * @param country the country
053             * @param state   the state
054             * @param zipCode the zip code
055             * @param city  the city
056             */
057            GeoCodeResult getGeoCode(Locale locale, String street, String country, String state, String zipCode, String city);
058    }