com.sap.tc.webdynpro.clientserver.uielib.graphics.api

Interface IWDGeoCoder

public interface IWDGeoCoder

Provides a java interface to retrieve geo positions from adresses. GEO CODING IS ONLY FUNCTIONAL IF AN IGS WITH ADDITIONAL GEO-SERVICES IS INSTALLED.

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Method Summary

void	addAddress(String id, WDGeoCoderAddress address) Adds an address that is to be geocoded
void	clearAddresses() Clears all addresses that were to be geocoded
void	clearAll() Clears all addresses, minScore and maxCandidates etc.
boolean	execute() Triggers an igs call.
String	getErrors() Returns the errors that were detected during the igs request as a string.
List	getResultAddresses(String id) Returns a vector of geocoded result addresses
void	setIgsUrl(URL igsURL) Set the URL of the IGS that provides the GIS services
void	setMaxCandidates(int maxCandidates)
void	setMinScore(int minScore)

Method Detail

setIgsUrl

public void setIgsUrl(URL igsURL)

Set the URL of the IGS that provides the GIS services

execute

public boolean execute()

Triggers an igs call.

Returns:

true if an geo position was generated

setMaxCandidates

public void setMaxCandidates(int maxCandidates)

setMinScore

public void setMinScore(int minScore)

addAddress

public void addAddress(String id,
                       WDGeoCoderAddress address)
                throws WDException

Adds an address that is to be geocoded

Throws:

WDException

clearAddresses

public void clearAddresses()

Clears all addresses that were to be geocoded

clearAll

public void clearAll()

Clears all addresses, minScore and maxCandidates etc.

getResultAddresses

public List getResultAddresses(String id)

Returns a vector of geocoded result addresses

getErrors

public String getErrors()

Returns the errors that were detected during the igs request as a string.