com.esri.adf.web.ve.data
Class VEResource

java.lang.Object
  extended by com.esri.adf.web.data.GISResource
      extended by com.esri.adf.web.ve.data.VEResource
All Implemented Interfaces:
WebContextInitialize, WebLifecycle, VEConstants, Serializable
Direct Known Subclasses:
VEGeocodeResource, VEImageryResource

public abstract class VEResource
extends GISResource
implements VEConstants

The VEResource represents a GISResource for Bing™ Maps (formerly known as Virtual Earth). Implementations of this class will need a URL to a Bing Maps Web Service, as well as a VEUser and a VETokenInfo in order to request a security token from Microsoft to access the desired Web Service.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.adf.web.data.GISResource
alias, context, defaultSpatialReference, functionalities, hasFailedFunctionalities, init
 
Fields inherited from interface com.esri.adf.web.ve.data.VEConstants
MAP_STYLE_AERIAL, MAP_STYLE_AERIAL_WITH_LABEL, MAP_STYLE_ROAD, MAX_LEVEL_OF_DETAIL, MIN_LEVEL_OF_DETAIL, TILE_HEIGHT, TILE_WIDTH, VIRTUAL_EARTH_GEOCODE_WKID, VIRTUAL_EARTH_SPATIAL_REFERENCE_WKID, VIRTUAL_EARTH_XMAX, VIRTUAL_EARTH_XMIN, VIRTUAL_EARTH_YMAX, VIRTUAL_EARTH_YMIN
 
Constructor Summary
VEResource()
           
 
Method Summary
 String getAppId()
           
 String getEndPointURL()
          Returns the endpoint to the Bing Maps web service.
 void init(WebContext webContext)
           This method is called by the WebContext to initialize the resource.
 void setAppId(String appId)
           
 void setEndPointURL(String endpointURL)
          Sets the endpoint to the Bing Maps Web Service.
 
Methods inherited from class com.esri.adf.web.data.GISResource
activate, addFunctionality, destroy, getAlias, 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
 

Constructor Detail

VEResource

public VEResource()
Method Detail

getEndPointURL

public String getEndPointURL()
Returns the endpoint to the Bing Maps web service.

Returns:
the endpoint URL

setEndPointURL

public void setEndPointURL(String endpointURL)
Sets the endpoint to the Bing Maps Web Service.

Parameters:
endpointURL - the endpoint URL to set

getAppId

public String getAppId()
Returns:
the appId

setAppId

public void setAppId(String appId)
Parameters:
appId - the appId to set

init

public void init(WebContext webContext)
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(String, 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:
webContext - 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(String, GISResource)