public class

FindResult

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

Class Overview

Represents a find result value object returned by the execution of a FindTask. A FindResult instance allows you to obtain the information you want about your results in a structured way, such as the result's value, feature ID, field name, layer ID, layer name, and attributes in the form of name-value pairs.

When working with the API, you should never have the need to instantiate this class. It will always be an object that is returned back to you and you will work with the various getter methods to obtain the information you need for your application such as displaying formatted results to a user.

Summary

Public Constructors
FindResult()
Public Methods
static FindResult fromJson(JsonParser parser)
Creates a FindResult object by parsing a JSON response.
Map<String, Object> getAttributes()
Returns the attributes in the form of a Map of name-value pairs.
String getDisplayFieldName()
Returns the name of the display field.
String getFoundFieldName()
Returns the name of the field in which the search text was found.
Geometry getGeometry()
Returns the Geometry of this find result.
Geometry.Type getGeometryType()
Returns the geometry type of this find result, such as point or polygon.
int getLayerId()
Returns the layer ID in which this result was found.
String getLayerName()
Returns the layer name in which this result was found.
String getValue()
Returns the value of the field in which the search text was found.
String toString()
Returns string representation of the class.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FindResult ()

Public Methods

public static FindResult fromJson (JsonParser parser)

Creates a FindResult object by parsing a JSON response.

Parameters
parser JsonParser: the JsonParser object
Returns
FindResult a FindResult object
Throws
Exception
Exception

public Map<String, Object> getAttributes ()

Returns the attributes in the form of a Map of name-value pairs.

Returns
Map<String, Object> a Map object of attributes

public String getDisplayFieldName ()

Returns the name of the display field.

Returns
String the display field name (String)

public String getFoundFieldName ()

Returns the name of the field in which the search text was found.

Returns
String the found field name (String)

public Geometry getGeometry ()

Returns the Geometry of this find result.

Returns
Geometry Geometry object

public Geometry.Type getGeometryType ()

Returns the geometry type of this find result, such as point or polygon.

Returns
Geometry.Type Geometry.Type

public int getLayerId ()

Returns the layer ID in which this result was found.

Returns
int an integer layer ID

public String getLayerName ()

Returns the layer name in which this result was found.

Returns
String the layer name

public String getValue ()

Returns the value of the field in which the search text was found.

Returns
String the value of the field (String)

public String toString ()

Returns string representation of the class. The format and content of the returned string is not part of the contract of the method and is subject to change in any future release or patch without further notice.

Returns
String