org.geomajas.plugin.geocoder.service

Class StaticRegexGeocoderService

java.lang.Object

org.geomajas.plugin.geocoder.service.StaticRegexGeocoderService

All Implemented Interfaces:

GeocoderService

@Api
public class StaticRegexGeocoderService
extends Object
implements GeocoderService

Geocoder service which reads the configuration from the application context.

Since:

1.0.0

Author:

Joachim Van der Auwera

Constructor Summary

Constructors

Constructor and Description
StaticRegexGeocoderService()

Method Summary

Methods

Modifier and Type	Method and Description
CoordinateReferenceSystem	getCrs() CRS which is used for the results of this geocoder.
GetLocationResult[]	getLocation(List<String> location, int maxAlternatives, Locale ignore) Try to get a location for the strings passed.
String	getName() Name for the geocoder service.
void	setGeocoderInfo(StaticRegexGeocoderInfo geocoderInfo) Set configuration for service.
void	setName(String name) Set the name for this geocoder service.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StaticRegexGeocoderService

public StaticRegexGeocoderService()

Method Detail

getName

public String getName()

Description copied from interface: GeocoderService

Name for the geocoder service. This name can be used to select which geocoder services are considered during the search. .

Specified by:

getName in interface GeocoderService

Returns:

name for this geocoder

setName

@Api
public void setName(String name)

Set the name for this geocoder service.

Parameters:

name - name

setGeocoderInfo

@Api
public void setGeocoderInfo(StaticRegexGeocoderInfo geocoderInfo)

Set configuration for service.

Parameters:

geocoderInfo - configuration

getCrs

public CoordinateReferenceSystem getCrs()

Description copied from interface: GeocoderService

CRS which is used for the results of this geocoder.

Specified by:

getCrs in interface GeocoderService

Returns:

CRS

getLocation

public GetLocationResult[] getLocation(List<String> location,
                              int maxAlternatives,
                              Locale ignore)

Description copied from interface: GeocoderService

Try to get a location for the strings passed. This can be either a coordinate or an envelope, as passed in the result object.

Specified by:

getLocation in interface GeocoderService

Parameters:

location - location strings, from general to more specific

maxAlternatives - maximum number of alternatives which can be replied to the user, use as a hint, you can return more, but they will be discarded.

ignore - locale use for the location if known (can be null if not known)

Returns:

results objects, when only one this is a definite result, when several the request was ambiguous and the result are the alternatives. When no results an empty array or null may be returned