com.esri.adf.web.ags.data
Class AGSGeocodeResource

java.lang.Object
  com.esri.adf.web.data.GISResource
      com.esri.adf.web.ags.data.AGSGeocodeResource

All Implemented Interfaces:

java.io.Serializable, WebContextInitialize, WebLifecycle

Direct Known Subclasses:

AGSLocalGeocodeResource

public class AGSGeocodeResource

extends GISResource

See Also:

Serialized Form

Field Summary

protected java.lang.String	endPointURL
protected java.lang.String	generatedAlias
protected GeocodeServerBindingStub	geocodeServer
protected java.lang.String	mapName
protected AGSUser	user

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

alias, context, defaultSpatialReference, functionalities, init

Constructor Summary

AGSGeocodeResource()

AGSGeocodeResource(java.lang.String endPointURL)

Method Summary

protected void	createGeocodeServer()
java.lang.String	getAlias() Returns a reader friendly name for this resource.
java.lang.String	getEndPointURL()
GeocodeServerPort	getGeocodeServer()
AGSUser	getUser()
void	init(WebContext context) This method is called by the WebContext to initialize the resource.
void	setEndPointURL(java.lang.String geocodeEndPointURL)
void	setUser(AGSUser user)

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

endPointURL

protected java.lang.String endPointURL

mapName

protected java.lang.String mapName

generatedAlias

protected java.lang.String generatedAlias

geocodeServer

protected GeocodeServerBindingStub geocodeServer

user

protected AGSUser user

Constructor Detail

AGSGeocodeResource

public AGSGeocodeResource()

AGSGeocodeResource

public AGSGeocodeResource(java.lang.String endPointURL)

Method Detail

createGeocodeServer

protected void createGeocodeServer()

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 GISResource

Parameters:

context - the WebContext that maintains a reference to this resource

See Also:

WebContextInitialize.init(com.esri.adf.web.data.WebContext), GISFunctionality.initFunctionality(GISResource), WebContext.init(WebContext), WebContext#addResource(resourceId, GISResource)

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 GISResource

Returns:

a reader friendly name for this resource

getGeocodeServer

public GeocodeServerPort getGeocodeServer()

getEndPointURL

public java.lang.String getEndPointURL()

setEndPointURL

public void setEndPointURL(java.lang.String geocodeEndPointURL)

setUser

public void setUser(AGSUser user)

getUser

public AGSUser getUser()