edu.ucdavis.cstars.client.tasks

Class IdentifyParameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.IdentifyParameters

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

This data object is used as the identifyParameters argument to IdentifyTask.execute method. It specifies the criteria used to identify the features.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdentifyParameters.LayerOption

Method Summary

Methods

Modifier and Type	Method and Description
static IdentifyParameters	create() Creates a new IdentifyParameters object.
int	getDpi() Resolution of the current map view in dots per inch.
com.google.gwt.core.client.JsArray<DynamicLayerInfo>	getDynamicLayerInfos() An array of DynamicLayerInfos used to change the layer ordering or redefine the map.
Geometry	getGeometry() The geometry used to select features during Identify.
int	getHeight() Height of the map currently being viewed in pixels.
com.google.gwt.core.client.JsArrayString	getLayerDefinitions() Array of layer definition expressions that allows you to filter the features of individual layers.
com.google.gwt.core.client.JsArrayInteger	getLayerIds() The layers to perform the identify operation on.
IdentifyParameters.LayerOption	getLayerOption() Specifies which layers to use when using Identify.
com.google.gwt.core.client.JsArray<LayerTimeOptions>	getLayerTimeOptions() Array of LayerTimeOptions objects that allow you to define time options for the specified layers.
Extent	getMapExtent() The Extent or bounding box of the map currently being viewed.
float	getMaxAllowableOffset() The maximum allowable offset used for generalizing geometries returned by the identify operation.
SpatialReference	getSpatialReference() The spatial reference of the input and output geometries as well as of the mapExtent.
TimeExtent	getTimeExtent() Specify the time extent used by the identify task.
double	getTolerance() The distance in screen pixels from the specified geometry within which the identify should be performed.
int	getWidth() Width of the map currently being viewed in pixels.
boolean	returnGeometry() If "true", the result set includes the geometry associated with each result.
void	setDpi(int dpi) Set the dpi parameter.
void	setDynamicLayerInfos(DynamicLayerInfo[] dynamicLayerInfos) Set the dynamicLayerInfos parameter.
void	setGeometry(Geometry geometry) Set the geometry parameter.
void	setHeight(int height) Set the height parameter.
void	setLayerDefinitions(java.lang.String[] layerDefinitions) Set the layer definitions parameter.
void	setLayerIds(int[] layerIds) set the layerIds parameter.
void	setLayerOption(IdentifyParameters.LayerOption layerOption)
void	setLayerTimeOptions(LayerTimeOptions[] layerTimeOptions) Set the layerTimeOptions parameter.
void	setMapExtent(Extent mapExtent) Set the mapExtent parameter.
void	setMaxAllowableOffset(int maxAllowableOffset) Set the maxAllowableOffset parameter
void	setReturnGeometry(boolean returnGeometry) set the returnGeometry parameter.
void	setSpatialReference(SpatialReference spatialReference) Set the spatialReference parameter.
void	setTimeExtent(TimeExtent timeExtent) Set the timeExtent parameter.
void	setTolerance(double tolerance) Set the tolerance parameter.
void	setWidth(int width) Set the width 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 final IdentifyParameters create()

Creates a new IdentifyParameters object.

Returns:

IdentifyParameters

getDpi

public final int getDpi()

Resolution of the current map view in dots per inch. Default value: 96

Returns:

int

setDpi

public final void setDpi(int dpi)

Set the dpi parameter.

Parameters:

dpi - - Resolution of the current map view in dots per inch. Default value: 96

getDynamicLayerInfos

public final com.google.gwt.core.client.JsArray<DynamicLayerInfo> getDynamicLayerInfos()

An array of DynamicLayerInfos used to change the layer ordering or redefine the map. When set the Identify operation will perform the identify against the dynamic layers. (As of v2.7)

Returns:

JsArray

setDynamicLayerInfos

public final void setDynamicLayerInfos(DynamicLayerInfo[] dynamicLayerInfos)

Set the dynamicLayerInfos parameter.

Parameters:

dynamicLayerInfos - - An array of DynamicLayerInfos used to change the layer ordering or redefine the map. When set the Identify operation will perform the identify against the dynamic layers. (As of v2.7)

getGeometry

public final Geometry getGeometry()

The geometry used to select features during Identify. The type of the geometry is specified by Geometry type. The most common geometry used with Identify is a Point.

Returns:

Geometry

setGeometry

public final void setGeometry(Geometry geometry)

Set the geometry parameter.

Parameters:

geometry - - The geometry used to select features during Identify. The type of the geometry is specified by Geometry type. The most common geometry used with Identify is a Point.

getHeight

public final int getHeight()

Height of the map currently being viewed in pixels.

Returns:

int

setHeight

public final void setHeight(int height)

Set the height parameter.

Parameters:

height - - Height of the map currently being viewed in pixels.

getLayerDefinitions

public final com.google.gwt.core.client.JsArrayString getLayerDefinitions()

Array of layer definition expressions that allows you to filter the features of individual layers. Layer definitions with semicolons or colons are supported at version 2.0 if using a map service published using ArcGIS Server 10.

Returns:

JsArrayString

setLayerDefinitions

public final void setLayerDefinitions(java.lang.String[] layerDefinitions)

Set the layer definitions parameter.

Parameters:

layerDefinitions - - Array of layer definition expressions that allows you to filter the features of individual layers. Layer definitions with semicolons or colons are supported at version 2.0 if using a map service published using ArcGIS Server 10.

getLayerIds

public final com.google.gwt.core.client.JsArrayInteger getLayerIds()

The layers to perform the identify operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in ArcGISMapServiceLayer layerInfos.

Returns:

JsArrayInteger

setLayerIds

public final void setLayerIds(int[] layerIds)

set the layerIds parameter.

Parameters:

layerIds - - The layers to perform the identify operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in ArcGISMapServiceLayer layerInfos.

getLayerOption

public final IdentifyParameters.LayerOption getLayerOption()

Specifies which layers to use when using Identify. Default value: LAYER_OPTION_TOP

Returns:

LayerOption

setLayerOption

public final void setLayerOption(IdentifyParameters.LayerOption layerOption)

Parameters:

layerOption - - Specifies which layers to use when using Identify. Default value: LAYER_OPTION_TOP

getLayerTimeOptions

public final com.google.gwt.core.client.JsArray<LayerTimeOptions> getLayerTimeOptions()

Array of LayerTimeOptions objects that allow you to define time options for the specified layers. There is one object per sub-layer.

Returns:

JsArray

setLayerTimeOptions

public final void setLayerTimeOptions(LayerTimeOptions[] layerTimeOptions)

Set the layerTimeOptions parameter.

Parameters:

layerTimeOptions - - Array of LayerTimeOptions objects that allow you to define time options for the specified layers. There is one object per sub-layer.

getMapExtent

public final Extent getMapExtent()

The Extent or bounding box of the map currently being viewed. The mapExtent property is assumed to be in the spatial reference of the map unless sr has been specified. The values for mapExtent, height, width, and dpi are used to determine the layers visible in the current extent. They are also used to calculate the search distance on the map based on the tolerance in screen pixels.

Returns:

Extent

setMapExtent

public final void setMapExtent(Extent mapExtent)

Set the mapExtent parameter.

Parameters:

mapExtent - - The Extent or bounding box of the map currently being viewed. The mapExtent property is assumed to be in the spatial reference of the map unless sr has been specified. The values for mapExtent, height, width, and dpi are used to determine the layers visible in the current extent. They are also used to calculate the search distance on the map based on the tolerance in screen pixels.

getMaxAllowableOffset

public final float getMaxAllowableOffset()

The maximum allowable offset used for generalizing geometries returned by the identify operation. The offset is in the units of the spatialReference. If a spatialReference is not defined the spatial reference of the map is used.

Returns:

float

setMaxAllowableOffset

public final void setMaxAllowableOffset(int maxAllowableOffset)

Set the maxAllowableOffset parameter

Parameters:

maxAllowableOffset - - The maximum allowable offset used for generalizing geometries returned by the identify operation. The offset is in the units of the spatialReference. If a spatialReference is not defined the spatial reference of the map is used.

returnGeometry

public final boolean returnGeometry()

If "true", the result set includes the geometry associated with each result. The default is "false".

Returns:

boolean

setReturnGeometry

public final void setReturnGeometry(boolean returnGeometry)

set the returnGeometry parameter.

Parameters:

returnGeometry - - If "true", the result set includes the geometry associated with each result. The default is "false".

getSpatialReference

public final SpatialReference getSpatialReference()

The spatial reference of the input and output geometries as well as of the mapExtent. If the spatial reference is not specified, the geometry and the extent are assumed to be in the spatial reference of the map, and the output geometries will also be in the spatial reference of the map.

Returns:

SpatialReference

setSpatialReference

public final void setSpatialReference(SpatialReference spatialReference)

Set the spatialReference parameter.

Parameters:

spatialReference - - The spatial reference of the input and output geometries as well as of the mapExtent. If the spatial reference is not specified, the geometry and the extent are assumed to be in the spatial reference of the map, and the output geometries will also be in the spatial reference of the map.

getTimeExtent

public final TimeExtent getTimeExtent()

Specify the time extent used by the identify task.

Returns:

TimeExtent

setTimeExtent

public final void setTimeExtent(TimeExtent timeExtent)

Set the timeExtent parameter.

Parameters:

timeExtent - - Specify the time extent used by the identify task.

getTolerance

public final double getTolerance()

The distance in screen pixels from the specified geometry within which the identify should be performed.

Returns:

double

setTolerance

public final void setTolerance(double tolerance)

Set the tolerance parameter.

Parameters:

tolerance - - The distance in screen pixels from the specified geometry within which the identify should be performed.

getWidth

public final int getWidth()

Width of the map currently being viewed in pixels.

Returns:

int

setWidth

public final void setWidth(int width)

Set the width parameter.

Parameters:

width - - Width of the map currently being viewed in pixels.