igazetteerservice.java

来自「esri的ArcGIS Server超级学习模板程序（for java）」· Java 代码 · 共 59 行

package com.esri.solutions.jitk.common.gazetteer;

import java.util.ArrayList;


/**
 * Defines an interface for Gazetteer services that can be searched
 * via the {@link #search(String, int)} method.
 */
public interface IGazetteerService {
	
	/**
     * Enumerated type of search methods
     *
     * @return {@link enum} search method being used
     */
	public enum SearchMethod {CONTAINS, BEGINS_WITH;}       
	
    /**
     * Gets the name of the Gazetteer service.
     *
     * @return {@link String} name of the gazetteer service.
     */
    public String getName();

    /**
     * Sets the name of the Gazetteer service.
     *
     * @param name {@link String} name of the gazetteer service.
     */
    public void setName(String name);

    /**
     * Gets the {@link String} Url of the Gazetteer service.
     *
     * @return {@link String} gazetteer service URL.
     */
    public String getServiceUrl();

    /**
     * Sets the {@link String} Url of the Gazetteer service.
     *
     * @param url {@link String} gazetteer service URL.
     */
    public void setServiceUrl(String url);

    /**
     * Searches the Gazetteer service with the given <code>placeName</code> and number
     * of requested max results.
     *
     * @param placeName Name of the place to be searched.
     * @param numResults Max number of results requested.
     * @param searchMethod Method used to search 'Contains' or 'Begins with'
     * @return {@link ArrayList} of {@link GazetteerSearchResult}.
     */
    public ArrayList<GazetteerSearchResult> search(String placeName,
        int numResults, SearchMethod searchMethod);
}