com.esri.adf.web.aws.data
Class AWSGeocodeResource

java.lang.Object
  com.esri.adf.web.data.GISResource
      com.esri.adf.web.aws.data.AWSResource
          com.esri.adf.web.aws.data.AWSGeocodeResource

All Implemented Interfaces:

java.io.Serializable, WebContextInitialize, WebLifecycle

public class AWSGeocodeResource

extends AWSResource

See Also:

Serialized Form

Field Summary

static java.lang.String	GEOCODE_ADDRESS_TYPE
static java.lang.String	GEOCODE_IP_TYPE
static java.lang.String	GEOCODE_PHONE_TYPE
static java.lang.String	GEOCODE_PLACE_TYPE

Fields inherited from class com.esri.adf.web.aws.data.AWSResource

authentication, content, coordSysId, DEFAULT_COORDSYS, NO_GEOM_RETURN, TOKEN_EXPIRED_CODE

Fields inherited from class com.esri.adf.web.data.GISResource

alias, context, defaultSpatialReference, functionalities, init

Constructor Summary

AWSGeocodeResource()

Method Summary

com.esri.aws.IAddressFinder_PortType	getAddressFinder()
java.lang.String	getAddressFinderEndPointURL()
com.esri.aws.AddressFinderOptions	getAddressFinderOptions()
java.lang.String	getAlias() Returns a reader friendly name for this resource.
com.esri.aws.ContentFinderRecord	getDataSourceMetadata()
java.lang.String	getGeocodeType()
com.esri.aws.IPlaceFinder_PortType	getPlaceFinder()
java.lang.String	getPlaceFinderEndPointURL()
com.esri.aws.PlaceFinderOptions	getPlaceFinderOptions()
void	init(WebContext context) This method is called by the WebContext to initialize the resource.
void	setAddressFinderEndPointURL(java.lang.String addressFinderEndPointURL)
void	setAddressFinderOptions(com.esri.aws.AddressFinderOptions addressFinderOptions)
void	setGeocodeType(java.lang.String geocodeType)
void	setPlaceFinderEndPointURL(java.lang.String placeFinderEndPointURL)
void	setPlaceFinderOptions(com.esri.aws.PlaceFinderOptions placeFinderOptions)

Methods inherited from class com.esri.adf.web.aws.data.AWSResource

getAuthenticationEndPointURL, getContentFinderEndPointURL, getDataSourceMetadata, getPassword, getToken, getTokenExpiryMinutes, getUserName, isPasswordEncrypted, setAuthenticationEndPointURL, setContentFinderEndPointURL, setPassword, setPasswordEncrypted, setToken, setTokenExpiryMinutes, setUserName

Methods inherited from class com.esri.adf.web.data.GISResource

activate, addFunctionality, destroy, getDefaultSpatialReference, getFunctionalities, getFunctionality, getWebContext, passivate, setAlias, setFunctionalities

Methods inherited from class java.lang.Object

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

Field Detail

GEOCODE_ADDRESS_TYPE

public static final java.lang.String GEOCODE_ADDRESS_TYPE

See Also:

Constant Field Values

GEOCODE_IP_TYPE

public static final java.lang.String GEOCODE_IP_TYPE

See Also:

Constant Field Values

GEOCODE_PHONE_TYPE

public static final java.lang.String GEOCODE_PHONE_TYPE

See Also:

Constant Field Values

GEOCODE_PLACE_TYPE

public static final java.lang.String GEOCODE_PLACE_TYPE

See Also:

Constant Field Values

Constructor Detail

AWSGeocodeResource

public AWSGeocodeResource()

Method Detail

init

public void init(WebContext context)

Description copied from class: GISResource

This method is called by the WebContext to initialize the resource. This is typically called when the context itself is initialized or when users add a new resource to the context by using the WebContext#addResource(GISResource) method. A GISResource is usable only after this method has been called.

This method iterates through all its supported GISFunctionalitys and calls the GISFunctionality.initFunctionality(GISResource) on them all.

Sub-classes that want to do custom initialization should override this method and make the super call first before doing the custom stuff:

 public void init(WebContext context) {
   super.init(context);
   myInit();
 }
 

Specified by:

init in interface WebContextInitialize

Overrides:

init in class AWSResource

getAlias

public java.lang.String getAlias()

Description copied from class: GISResource

Returns a reader friendly name for this resource.

It is a good practice for users to explicitly set an alias when the resource is created programmatically or declaratively. Resource providers should provide an auto-generated alias anyway in case users don't explicitly set an alias themselves.

Overrides:

getAlias in class AWSResource

getAddressFinder

public com.esri.aws.IAddressFinder_PortType getAddressFinder()

getPlaceFinder

public com.esri.aws.IPlaceFinder_PortType getPlaceFinder()

getAddressFinderOptions

public com.esri.aws.AddressFinderOptions getAddressFinderOptions()

getPlaceFinderOptions

public com.esri.aws.PlaceFinderOptions getPlaceFinderOptions()

getAddressFinderEndPointURL

public java.lang.String getAddressFinderEndPointURL()

getPlaceFinderEndPointURL

public java.lang.String getPlaceFinderEndPointURL()

getGeocodeType

public java.lang.String getGeocodeType()

setAddressFinderOptions

public void setAddressFinderOptions(com.esri.aws.AddressFinderOptions addressFinderOptions)

setPlaceFinderOptions

public void setPlaceFinderOptions(com.esri.aws.PlaceFinderOptions placeFinderOptions)

setAddressFinderEndPointURL

public void setAddressFinderEndPointURL(java.lang.String addressFinderEndPointURL)

setPlaceFinderEndPointURL

public void setPlaceFinderEndPointURL(java.lang.String placeFinderEndPointURL)

setGeocodeType

public void setGeocodeType(java.lang.String geocodeType)

getDataSourceMetadata

public com.esri.aws.ContentFinderRecord getDataSourceMetadata()