Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.portal

Class GeocodeServiceInfo

java.lang.Object

com.esri.arcgisruntime.portal.GeocodeServiceInfo

public final class GeocodeServiceInfo
extends Object

Represents a geocode service that is provided by the Portal. Objects of this class are provided by HelperServices.getGeocodeServices().

Since:

100.0.0

Method Summary

Modifier and Type	Method	Description
String	getEastLon()	Gets the name of the field containing the east longitude of the zoom envelope for the geocoding result.
String	getName()	Gets the geocoder name.
String	getNorthLat()	Gets the name of the field containing the north latitude of the zoom envelope for the geocoding result.
String	getPlaceHolder()	Gets the place holder.
String	getSingleLineFieldName()	Gets the geocode query field name.
String	getSouthLat()	Gets the name of the field containing the south latitude of the zoom envelope for the geocoding result.
String	getUrl()	Gets the service URL.
String	getWestLon()	Gets the name of the field containing the west longitude of the zoom envelope for the geocoding result.
double	getZoomScale()	Gets the default zoom scale for custom geocoders.
boolean	isSupportsBatchGeocoding()	Indicates if the geocoder can be used for batch geocoding.
boolean	isSupportsPlaceFinding()	Indicates if the geocoder can be used for place finding.
boolean	isSupportsSuggest()	Indicates if the geocoder supports the suggest API for autocomplete results.

Methods inherited from class java.lang.Object

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

Method Details

getUrl

public String getUrl()

Gets the service URL.

Returns:

the service URL

Since:

100.0.0

getSingleLineFieldName

public String getSingleLineFieldName()

Gets the geocode query field name.

Returns:

the geocode query field name, or null if none

Since:

100.0.0

getNorthLat

public String getNorthLat()

Gets the name of the field containing the north latitude of the zoom envelope for the geocoding result. North latitude is equivalent to Ymax in an Envelope (Envelope).

Returns:

the name of the north latitude field, or null if none

Since:

100.0.0

getSouthLat

public String getSouthLat()

Gets the name of the field containing the south latitude of the zoom envelope for the geocoding result. South latitude is equivalent to Ymin in an Envelope (Envelope).

Returns:

the name of the south latitude field, or null if none

Since:

100.0.0

getEastLon

public String getEastLon()

Gets the name of the field containing the east longitude of the zoom envelope for the geocoding result. East longitude is equivalent to Xmax in an Envelope (Envelope).

Returns:

the name of the east longitude field, or null if none

Since:

100.0.0

getWestLon

public String getWestLon()

Gets the name of the field containing the west longitude of the zoom envelope for the geocoding result. West longitude is equivalent to Xmin in an Envelope (Envelope).

Returns:

the name of the west longitude field, or null if none

Since:

100.0.0

getName

public String getName()

Gets the geocoder name.

Returns:

the geocoder name

Since:

100.0.0

getPlaceHolder

public String getPlaceHolder()

Gets the place holder. This text can serve as a hint to application users about the type of information they can enter in the search box.

Returns:

the place holder, or null if none

Since:

100.0.0

getZoomScale

public double getZoomScale()

Gets the default zoom scale for custom geocoders. An application can use this scale to zoom to a point returned by the geocoder.

Returns:

the default zoom scale

Since:

100.0.0

isSupportsBatchGeocoding

public boolean isSupportsBatchGeocoding()

Indicates if the geocoder can be used for batch geocoding.

Returns:

true if the geocoder can be used for batch geocoding

Since:

100.0.0

isSupportsPlaceFinding

public boolean isSupportsPlaceFinding()

Indicates if the geocoder can be used for place finding.

Returns:

true if the geocoder can be used for place finding

Since:

100.0.0

isSupportsSuggest

public boolean isSupportsSuggest()

Indicates if the geocoder supports the suggest API for autocomplete results.

Returns:

true if the geocoder supports the suggest API

Since:

100.0.0