edu.ucdavis.cstars.client.tasks

Class FeatureSet

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.FeatureSet

Direct Known Subclasses:

DirectionsFeatureSet

public class FeatureSet
extends com.google.gwt.core.client.JavaScriptObject

A collection of features returned from ArcGIS Server or used as input to tasks. Each feature in the FeatureSet may contain geometry, attributes, symbolgy, and an InfoTemplate. If the FeatureSet does not contain geometry, and only contains attributes, the FeatureSet can be treated as a table where each feature is a row object. Tasks that return FeatureSet include QueryTask, Geoprocessor, and RouteTask. In addition, Geoprocessor and RouteTask may require FeatureSet as input.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
static FeatureSet	create() Creates a new FeatureSet object.
static FeatureSet	create(com.google.gwt.core.client.JavaScriptObject json) Creates a new FeatureSet object using a JSON object.
java.lang.String	getDisplayFieldName() The name of the layer's primary display field.
com.google.gwt.core.client.JsArray<Graphic>	getFeatures() The array of graphics returned.
JSObject	getFieldAliases() Set of name-value pairs for the attribute's field and alias names.
java.lang.String	getGeometryType() The geometry type of the FeatureSet.
SpatialReference	getSpatialReference() When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default.
void	setDisplayFieldName(java.lang.String displayFieldName) Set the display field name parameter
void	setFeatures(Graphic[] features) Set the features parameters.
void	setFieldAliases(JSObject fieldAliases) Set the field aliases parameter.
void	setGeometryType(java.lang.String geometryType) set the geometry type parameter.
void	setSpatialReference(SpatialReference spatialReference) set the spatial reference parameter.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static FeatureSet create()

Creates a new FeatureSet object.

Returns:

FeatureSet

create

public static FeatureSet create(com.google.gwt.core.client.JavaScriptObject json)

Creates a new FeatureSet object using a JSON object.

Parameters:

json - - A JSON object that contains feature set.

Returns:

FeatureSet

getDisplayFieldName

public final java.lang.String getDisplayFieldName()

The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature. Only applicable when the FeatureSet is returned from a task. It is ignored when the FeatureSet is used as input to a geoprocessing task.

Returns:

String

setDisplayFieldName

public final void setDisplayFieldName(java.lang.String displayFieldName)

Set the display field name parameter

Parameters:

displayFieldName - - The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature. Only applicable when the FeatureSet is returned from a task. It is ignored when the FeatureSet is used as input to a geoprocessing task.

getFeatures

public final com.google.gwt.core.client.JsArray<Graphic> getFeatures()

The array of graphics returned.

Returns:

JsArray

setFeatures

public final void setFeatures(Graphic[] features)

Set the features parameters.

Parameters:

features - - The array of graphics returned.

getFieldAliases

public final JSObject getFieldAliases()

Set of name-value pairs for the attribute's field and alias names.

Returns:

JSObject

setFieldAliases

public final void setFieldAliases(JSObject fieldAliases)

Set the field aliases parameter.

Parameters:

fieldAliases - - Set of name-value pairs for the attribute's field and alias names.

getGeometryType

public final java.lang.String getGeometryType()

The geometry type of the FeatureSet.

Returns:

String

setGeometryType

public final void setGeometryType(java.lang.String geometryType)

set the geometry type parameter.

Parameters:

geometryType - - The geometry type of the FeatureSet.

getSpatialReference

public final SpatialReference getSpatialReference()

When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. This value can be changed. When a FeatureSet is returned from a task, the value is the result as returned from the server.

Returns:

SpatialReference

setSpatialReference

public final void setSpatialReference(SpatialReference spatialReference)

set the spatial reference parameter.

Parameters:

spatialReference - - When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. This value can be changed. When a FeatureSet is returned from a task, the value is the result as returned from the server.