com.esri.arcgis.carto
Interface IMapServerFindResult

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapServerFindResult

public interface IMapServerFindResult
extends Serializable

Provides access to the Map Server Find Result Interface.

Remarks

MapServerFindResult honors field visibility and field aliases set in the source map. It does not honor field formatting.

MapServerFindResult includes a number of properties. Value and FieldName return respectively the value and field’s name of the primary display field for the feature. FeatureProperties returns a set Field-value pairs. These are returned as strings. This also includes the Shape field. To get geometry do not use the Shape field contained within the FeatureProperties’ field-value pairs, use the FeatureShape property instead. If you are interested in information about the layer that the feature belongs to you can use LayerID.

In order to control the amount of information MapServer needs to process for a query, a maximum number of records can be set. This value is contained in the MaxRecordCount property on IMapServerInit2. The default value for this property is 500. If 600 features match a given query only the first 500 results will be returned. You will be unable to access the remaining 100 records. To be able to access these records the MaxRecordCount would need to be increased to 600.

When To Use

Use IMapServerFindResult to access properties of map features returned as a result of using the IMapServer Find method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getFeatureId()
          The ID of the found feature.
 IPropertySet getFeatureProperties()
          A set of name-value pairs for the found features's field names and values.
 IGeometry getFeatureShape()
          The geometry of the found feature.
 String getFieldName()
          The field name.
 int getLayerID()
          The layer ID.
 String getValue()
          The found value.
 void setFeatureId(int fID)
          The ID of the found feature.
 void setFeatureProperties(IPropertySet props)
          A set of name-value pairs for the found features's field names and values.
 void setFeatureShape(IGeometry shape)
          The geometry of the found feature.
 void setFieldName(String name)
          The field name.
 void setLayerID(int layerID)
          The layer ID.
 void setValue(String value)
          The found value.
 

Method Detail

getValue

String getValue()
                throws IOException,
                       AutomationException
The found value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(String value)
              throws IOException,
                     AutomationException
The found value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerID

int getLayerID()
               throws IOException,
                      AutomationException
The layer ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The layerID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerID

void setLayerID(int layerID)
                throws IOException,
                       AutomationException
The layer ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
layerID - The layerID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureId

int getFeatureId()
                 throws IOException,
                        AutomationException
The ID of the found feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The fID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureId

void setFeatureId(int fID)
                  throws IOException,
                         AutomationException
The ID of the found feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
fID - The fID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldName

String getFieldName()
                    throws IOException,
                           AutomationException
The field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldName

void setFieldName(String name)
                  throws IOException,
                         AutomationException
The field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureShape

IGeometry getFeatureShape()
                          throws IOException,
                                 AutomationException
The geometry of the found feature.

Remarks

FeatureShape contains the geometry of a feature returned from a MapServer Find query. This geometry have the same spatial reference system as the DefaultMapDescription. When ILayerResultOptions is not used, the FeatureShape property returns geometry. If the Shape field is invisible in the source map, the FeatureShape property may still contain geometry depending on how IncludeGeometry is set by the user.

In some cases, for performance reasons, you may want limit or adjust the geometry being returned. Use ILayerResultOptions to manage this. If IncludeGeometry is set to False, FeatureShape returns nothing. This should increase performance in cases where feature geometry is large. You can also choose to densify or generalize the geometry returned in FeatureShape using GeometryResultOptions. Densification is used to better support clients that do not support Arcs (e.g. Bezier, Circular etc.). Generalization reduces the amount of geography being sent across the network and should lead to better performance.

Densified or generalized geometry should only be used for navigation or display purpose, such as zooming to, flashing, or highlighting the selected feature. For spatial queries, GeometryResultOptions should not be used as it may returns unexpected results. For more information on please see IGeometry, Densify, and Generalize .

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureShape

void setFeatureShape(IGeometry shape)
                     throws IOException,
                            AutomationException
The geometry of the found feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureProperties

IPropertySet getFeatureProperties()
                                  throws IOException,
                                         AutomationException
A set of name-value pairs for the found features's field names and values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureProperties

void setFeatureProperties(IPropertySet props)
                          throws IOException,
                                 AutomationException
A set of name-value pairs for the found features's field names and values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
props - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.