edu.ucdavis.cstars.client.tasks

Class FindParameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.FindParameters

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

This data object is used as the findParameters argument to FindTask.execute method. It specifies the search criteria for a find operation.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains() The contains parameter determines whether to look for an exact match of the search text or not.
static FindParameters	create() Creates a new FindParameters object.
com.google.gwt.core.client.JsArray<DynamicLayerInfo>	getDynamicLayerInfos() An array of DynamicLayerInfos used to change the layer ordering or redefine the map.
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 find operation on.
double	getMaxAllowableOffset() The maximum allowable offset used for generalizing geometries returned by the find operation.
SpatialReference	getOutSpatialReference() The spatial reference of the output geometries.
com.google.gwt.core.client.JsArrayString	getSearchFields() The names of the fields of a layer to search.
java.lang.String	getSearchText() The search string text that is searched across the layers and the fields as specified in the layers and searchFields parameters.
boolean	returnGeometry() If "true", the result set include the geometry associated with each result.
void	setContains(boolean contains) Set the contains parameter.
void	setDynamicLayerInfos(DynamicLayerInfo[] dynamicLayerInfos) Set the dynamicLayerInfos parameter.
void	setLayerDefinitions(java.lang.String[] layerDefinitions) Set the layer definitions parameter.
void	setLayerIds(int[] layerIds) set the layer ids.
void	setMaxAllowableOffset(double offset) set the max allowable offset parameter.
void	setOutSpatialReference(SpatialReference outSpatialReference) set the out spatial reference parameter.
void	setReturnGeometry(boolean returnGeometry) set the return geometry parameter
void	setSearchFields(java.lang.String[] searchFields) The names of the fields of a layer to search.
void	setSearchText(java.lang.String searchText) Set the search text 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 FindParameters create()

Creates a new FindParameters object.

Returns:

FindParameters

contains

public final boolean contains()

The contains parameter determines whether to look for an exact match of the search text or not. If true, searches for a value that contains the searchText provided. This is a case-insensitive search. If false, searches for an exact match of the searchText string. The exact match is case-sensitive.

Returns:

boolean

setContains

public final void setContains(boolean contains)

Set the contains parameter.

Parameters:

contains - - The contains parameter determines whether to look for an exact match of the search text or not. If true, searches for a value that contains the searchText provided. This is a case-insensitive search. If false, searches for an exact match of the searchText string. The exact match is case-sensitive.

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 find operation will perform the find 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 find operation will perform the find against the dynamic layers. (As of v2.7)

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 find 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 layer ids.

Parameters:

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

getMaxAllowableOffset

public final double getMaxAllowableOffset()

The maximum allowable offset used for generalizing geometries returned by the find 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:

double

setMaxAllowableOffset

public final void setMaxAllowableOffset(double offset)

set the max allowable offset parameter.

Parameters:

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

getOutSpatialReference

public final SpatialReference getOutSpatialReference()

The spatial reference of the output geometries. If outSR is not specified, the output geometries are returned in the spatial reference of the map.

Returns:

SpatialReference

setOutSpatialReference

public final void setOutSpatialReference(SpatialReference outSpatialReference)

set the out spatial reference parameter.

Parameters:

outSpatialReference - - The spatial reference of the output geometries. If outSR is not specified, the output geometries are returned in the spatial reference of the map.

returnGeometry

public final boolean returnGeometry()

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

Returns:

boolean

setReturnGeometry

public final void setReturnGeometry(boolean returnGeometry)

set the return geometry parameter

Parameters:

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

getSearchFields

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

The names of the fields of a layer to search. The fields are specified as a comma-separated list of field names. If this parameter is not specified, all fields are searched.

Returns:

JsArrayString

setSearchFields

public final void setSearchFields(java.lang.String[] searchFields)

The names of the fields of a layer to search. The fields are specified as a comma-separated list of field names. If this parameter is not specified, all fields are searched.

Parameters:

searchFields -

getSearchText

public final java.lang.String getSearchText()

The search string text that is searched across the layers and the fields as specified in the layers and searchFields parameters.

Returns:

String

setSearchText

public final void setSearchText(java.lang.String searchText)

Set the search text parameter.

Parameters:

searchText - - The search string text that is searched across the layers and the fields as specified in the layers and searchFields parameters.