edu.ucdavis.cstars.client.tasks

Class GenerateRendererTask

java.lang.Object

edu.ucdavis.cstars.client.tasks.GenerateRendererTask

public class GenerateRendererTask
extends java.lang.Object

The GenerateRendererTask class creates a renderer based on a classification definition and optional where clause. The classification definition is used to define the base symbol and color ramp for the renderer. The output renderer can be applied to graphics layers, feature layers or dynamic layers. The GenerateRendererTask is available for map service or tables that support the generateDataClasses operation (version 10.1 or greater).

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerateRendererTask.Options

Method Summary

Methods

Modifier and Type	Method and Description
void	addCompleteHandler(GenerateRendererHandler handler)
void	addErrorHandler(ErrorHandler handler)
static boolean	assertLoaded() Check that the esri.tasks.closestfacility has been loaded
static GenerateRendererTask	create(java.lang.String url) Creates a new GenerateRendererTask object.
static GenerateRendererTask	create(java.lang.String url, GenerateRendererTask.Options options) Creates a new GenerateRendererTask object.
Deferred	execute(GenerateRendererParameters generateRendererParameters) Perform a classification on the layer or table resource.
Deferred	execute(GenerateRendererParameters generateRendererParameters, GenerateRendererCallback callback) Perform a classification on the layer or table resource.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static GenerateRendererTask create(java.lang.String url)

Creates a new GenerateRendererTask object.

Returns:

GenerateRendererTask

create

public static GenerateRendererTask create(java.lang.String url,
                          GenerateRendererTask.Options options)

Creates a new GenerateRendererTask object.

Returns:

GenerateRendererTask

assertLoaded

public static boolean assertLoaded()

Check that the esri.tasks.closestfacility has been loaded

Returns:

boolean

execute

public final Deferred execute(GenerateRendererParameters generateRendererParameters,
               GenerateRendererCallback callback)

Perform a classification on the layer or table resource. Upon successful completion of the classification operation the onComplete event is fired and the optional callback function is invoked. The result is a renderer object that can be applied to graphics layers, feature layers or dynamic layers.

Parameters:

generateRendererParameters - - A GenerateRendererParameters object that defines the classification definition and an optional where clause.

callback - - This handler will be called when the operation is complete

Returns:

Deferred

execute

public final Deferred execute(GenerateRendererParameters generateRendererParameters)

Perform a classification on the layer or table resource. Upon successful completion of the classification operation the onComplete event is fired and the optional callback function is invoked. The result is a renderer object that can be applied to graphics layers, feature layers or dynamic layers.

Parameters:

generateRendererParameters - - A GenerateRendererParameters object that defines the classification definition and an optional where clause.

Returns:

Deferred

addCompleteHandler

public final void addCompleteHandler(GenerateRendererHandler handler)

Parameters:

handler - - Fired when the GenerateRendererTask solve is complete.

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Parameters:

handler - - Fired when an error occurs during task execution.