public class

FindParameters

extends Object
java.lang.Object
   ↳ com.esri.core.tasks.ags.find.FindParameters

Class Overview

This class represents parameters for FindTask operations. Parameters provide criteria for performing a search on the map service. Parameters are passed as an argument to executeWithParameters.

Summary

Public Constructors
FindParameters()
Constructs a default FindParameters object.
FindParameters(String searchText, int[] layerIds)
Constructs a FindParameters object with the given searching text and layers to be searched.
Public Methods
DynamicLayerInfo[] getDynamicLayers()
Sets an array of DynamicLayerInfo objects to search the text.
String getGdbVersion()
Gets the gdb version.
int getGeometryPrecision()
Returns the number of decimal places for response geometries.
Map<Integer, String> getLayerDefs()
Returns layers definition Map.
int[] getLayerIds()
Gets the layer ids.
double getMaxAllowableOffset()
Returns the maximum allow search range.
SpatialReference getOutputSpatialRef()
Gets the spatial reference of output geometry.
String[] getSearchFields()
The names of fields to search.
String getSearchText()
Returns the search text string.
boolean isContainsSearchText()
Return false if the search is doing exact match.
boolean isReturnGeometry()
Returns true if the geometry object is returned.
boolean isReturnM()
Returns true if M value will be returned.
boolean isReturnZ()
If the Z values will be returned in the results if the features has Z values.
void setContainsSearchText(boolean containsSearchText)
If it is set for false, the search will do exact match(case sensitive).
void setDynamicLayers(DynamicLayerInfo[] dynamicLayers)
void setGdbVersion(String gdbVersion)
Sets the gdb version.
void setGeometryPrecision(int geometryPrecision)
Specifies the number of decimal places in the response geometries returned by the find operation.
void setLayerDefs(Map<Integer, String> layerDefs)
Sets layers definition paired by layer id and layer definition expression.
void setLayerIds(int[] layerIds)
Sets layers to perform the find operation on.
void setMaxAllowableOffset(double maxAllowableOffset)
Sets maximum search range in output SR units if it is specified otherwise the range in the map unit.
void setOutputSpatialRef(SpatialReference outputSpatialRef)
Sets the spatial reference of output geometry.
void setReturnGeometry(boolean returnGeometry)
Sets if returning geometry.The default is true.
void setReturnM(boolean returnM)
If true, M values will be included in the results if the features has M Values,.
void setReturnZ(boolean returnZ)
Sets true the Z values in the features will be returned.
void setSearchFields(String[] searchFields)
Sets the names of fields to search.
void setSearchText(String searchText)
Sets the search text string.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FindParameters ()

Constructs a default FindParameters object.

public FindParameters (String searchText, int[] layerIds)

Constructs a FindParameters object with the given searching text and layers to be searched.

Parameters
searchText String: the search text
layerIds int: the layer ids

Public Methods

public DynamicLayerInfo[] getDynamicLayers ()

Sets an array of DynamicLayerInfo objects to search the text.

Returns
DynamicLayerInfo[] the dynamicLayers

public String getGdbVersion ()

Gets the gdb version.

Returns
String the gdbVersion

public int getGeometryPrecision ()

Returns the number of decimal places for response geometries.

Returns
int the geometryPrecision

public Map<Integer, String> getLayerDefs ()

Returns layers definition Map.

Returns
Map<Integer, String> the layerDefs

public int[] getLayerIds ()

Gets the layer ids.

Returns
int[] the layerIds

public double getMaxAllowableOffset ()

Returns the maximum allow search range.

Returns
double the maxAllowableOffset

public SpatialReference getOutputSpatialRef ()

Gets the spatial reference of output geometry.

Returns
SpatialReference the outputSpatialRef

public String[] getSearchFields ()

The names of fields to search.

Returns
String[] the searchFields a string array.

public String getSearchText ()

Returns the search text string.

Returns
String the searchText

public boolean isContainsSearchText ()

Return false if the search is doing exact match.

Returns
boolean the containsSearchText

public boolean isReturnGeometry ()

Returns true if the geometry object is returned.

Returns
boolean the returnGeometry

public boolean isReturnM ()

Returns true if M value will be returned.

Returns
boolean the returnM true/false

public boolean isReturnZ ()

If the Z values will be returned in the results if the features has Z values. The default is false.

Returns
boolean the returnZ boolean

public void setContainsSearchText (boolean containsSearchText)

If it is set for false, the search will do exact match(case sensitive). otherwise, it will do a containing search. The default value is true.

Parameters
containsSearchText boolean: true/false

public void setDynamicLayers (DynamicLayerInfo[] dynamicLayers)

Parameters
dynamicLayers DynamicLayerInfo: the dynamicLayers to set

public void setGdbVersion (String gdbVersion)

Sets the gdb version.

Parameters
gdbVersion String: the gdbVersion to set

public void setGeometryPrecision (int geometryPrecision)

Specifies the number of decimal places in the response geometries returned by the find operation.

Parameters
geometryPrecision int: an integer.

public void setLayerDefs (Map<Integer, String> layerDefs)

Sets layers definition paired by layer id and layer definition expression.

Parameters
layerDefs Map: a Map object.

public void setLayerIds (int[] layerIds)

Sets layers to perform the find operation on.

Parameters
layerIds int: an array of integers.

public void setMaxAllowableOffset (double maxAllowableOffset)

Sets maximum search range in output SR units if it is specified otherwise the range in the map unit.

Parameters
maxAllowableOffset double: double

public void setOutputSpatialRef (SpatialReference outputSpatialRef)

Sets the spatial reference of output geometry. If it is not specified the map SR will be used.

Parameters
outputSpatialRef SpatialReference: a SpatialReference object.

public void setReturnGeometry (boolean returnGeometry)

Sets if returning geometry.The default is true.

Parameters
returnGeometry boolean: boolean

public void setReturnM (boolean returnM)

If true, M values will be included in the results if the features has M Values,.

Parameters
returnM boolean: true/false

public void setReturnZ (boolean returnZ)

Sets true the Z values in the features will be returned.

Parameters
returnZ boolean: boolean.

public void setSearchFields (String[] searchFields)

Sets the names of fields to search.

Parameters
searchFields String: a String of array.

public void setSearchText (String searchText)

Sets the search text string.

Parameters
searchText String: the searchText to set