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

java.lang.Object
  com.esri.adf.web.ags.data.AGSNAFunctionality

All Implemented Interfaces:

GISFunctionality

public class AGSNAFunctionality

extends java.lang.Object

implements GISFunctionality

Field Summary

protected GraphicElement	barrierElement
static java.lang.String	FUNCTIONALITY_NAME
protected GraphicElement	routeElement
protected GraphicElement	stopsElement
static double	ZOOM_TO_FACTOR The default zoom to factor.

Constructor Summary

AGSNAFunctionality()

Method Summary

void	addBarrier(WebPoint point)
void	addStop(WebPoint point)
void	clearBarriers()
void	clearRoute()
void	clearStops()
void	destroyFunctionality() The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
java.lang.String	getDefaultNALayerName()
GISResource	getResource() Returns the GISResource associated with this functionality.
NAServerRouteParams	getRouteParams()
WebSimpleLineSymbol	getRouteSymbol()
WebTrueTypeMarkerSymbol	getStopSymbol()
void	initFunctionality(GISResource resource) The initialization chores for the functionality must be performed in this method.
void	setDefaultNALayerName(java.lang.String defaultNALayerName) Sets the default network anlyst layer name.
void	setRouteSymbol(WebSimpleLineSymbol routeSymbol)
void	setStopSymbol(WebTrueTypeMarkerSymbol trueTypeMarkerSymbol)
AGSTraversalResult[]	solve()

Methods inherited from class java.lang.Object

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

Field Detail

FUNCTIONALITY_NAME

public static final java.lang.String FUNCTIONALITY_NAME

See Also:

Constant Field Values

ZOOM_TO_FACTOR

public static final double ZOOM_TO_FACTOR

The default zoom to factor. The map will be zoomed in reference to the scale of this result.

See Also:

Constant Field Values

routeElement

protected GraphicElement routeElement

stopsElement

protected GraphicElement stopsElement

barrierElement

protected GraphicElement barrierElement

Constructor Detail

AGSNAFunctionality

public AGSNAFunctionality()

Method Detail

initFunctionality

public void initFunctionality(GISResource resource)

Description copied from interface: GISFunctionality

The initialization chores for the functionality must be performed in this method. This method is called by the resource when the functionality needs to be initialized. This happens either when the resource itself is being initialized or if users add this functionality to the resource using the GISResource.addFunctionality(String, GISFunctionality) method after the resource has already been initialized.

Classes which implement this method should maintain the resource as a class instance variable and return the same in the GISFunctionality.getResource() method. The functionality is ready for use only after this method has been called.

Specified by:

initFunctionality in interface GISFunctionality

Parameters:

resource - the GISResource that this functionality supports

See Also:

GISResource.init(WebContext)

getResource

public GISResource getResource()

Description copied from interface: GISFunctionality

Returns the GISResource associated with this functionality.

The resource passed to GISFunctionality.initFunctionality(GISResource) is maintained as a class variable and is accessible through this method.

Specified by:

getResource in interface GISFunctionality

Returns:

the GISResource associated with this functionality

destroyFunctionality

public void destroyFunctionality()

Description copied from interface: GISFunctionality

The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. This method is called by the GISResource when the resource itself is being destroyed.

The functionality is no longer usable after this method has been called.

Specified by:

destroyFunctionality in interface GISFunctionality

See Also:

GISResource.destroy()

addStop

public void addStop(WebPoint point)

addBarrier

public void addBarrier(WebPoint point)

clearStops

public void clearStops()

clearBarriers

public void clearBarriers()

clearRoute

public void clearRoute()

solve

public AGSTraversalResult[] solve()

setStopSymbol

public void setStopSymbol(WebTrueTypeMarkerSymbol trueTypeMarkerSymbol)

setRouteSymbol

public void setRouteSymbol(WebSimpleLineSymbol routeSymbol)

setDefaultNALayerName

public void setDefaultNALayerName(java.lang.String defaultNALayerName)

Sets the default network anlyst layer name.

Parameters:

defaultNALayerName - the default network analyst layer name.

getStopSymbol

public WebTrueTypeMarkerSymbol getStopSymbol()

getRouteSymbol

public WebSimpleLineSymbol getRouteSymbol()

getDefaultNALayerName

public java.lang.String getDefaultNALayerName()

getRouteParams

public NAServerRouteParams getRouteParams()