com.esri.arcgis.carto
Interface IMxdServerQuery

All Superinterfaces:

Serializable

All Known Implementing Classes:

MxdServer

public interface IMxdServerQuery
extends Serializable

Provides access to functionality that allows the client to query features on the map.

Product Availability

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

Method Summary

double	computeDistance(String mapName, IPoint fromPoint, IPoint toPoint) Computes the distance between two points on the specified map.
double	computeScale(String mapName, int imageWidthPixels, IEnvelope extent) Computes the scale of the specified map, at the given map extent, for an image with the given width, specified in pixels.
IArray	find(String mapName, String findString, int layerID) Returns an array of 'find objects' (that implement the IFindObject interface) that contain the given search string.
IArray	getRelatedIdentifyObjects(String mapName, IIdentifyObj identifyObject) An array of 'identify objects' that are related to the specified identify object.
IArray	identify(String mapName, int layerID, IGeometry shape) Returns an array of 'identify objects' (that support the IIdentifyObj interface) at the given location.
IFeatureCursor	queryByLayer(String mapName, int targetLayerID, int selectionLayerID, int selectionMethod, boolean useSelected, double bufferDistance, int bufferDistanceUnits) Returns a feature cursor for the specified layer based on the input parameters for the purpose of selecting based on another layer.
IFeatureCursor	queryFeatures(String mapName, int layerID, IArray queryFilters) Returns a feature cursor for the specified layer based on the given array of query filters.

Method Detail

queryFeatures

IFeatureCursor queryFeatures(String mapName,
                             int layerID,
                             IArray queryFilters)
                             throws IOException,
                                    AutomationException

Returns a feature cursor for the specified layer based on the given array of query filters. If there is more than one query filter in the array, they are 'ANDed' together.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

queryFilters - A reference to a com.esri.arcgis.system.IArray (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureCursor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identify

IArray identify(String mapName,
                int layerID,
                IGeometry shape)
                throws IOException,
                       AutomationException

Returns an array of 'identify objects' (that support the IIdentifyObj interface) at the given location. If layerID is equal to -1, the top-most visible layer with any results is used. If layerID is equal to -2, all visible layers will be queried.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelatedIdentifyObjects

IArray getRelatedIdentifyObjects(String mapName,
                                 IIdentifyObj identifyObject)
                                 throws IOException,
                                        AutomationException

An array of 'identify objects' that are related to the specified identify object.

Product Availability

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

Parameters:

mapName - The mapName (in)

identifyObject - A reference to a com.esri.arcgis.carto.IIdentifyObj (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeScale

double computeScale(String mapName,
                    int imageWidthPixels,
                    IEnvelope extent)
                    throws IOException,
                           AutomationException

Computes the scale of the specified map, at the given map extent, for an image with the given width, specified in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapName - The mapName (in)

imageWidthPixels - The imageWidthPixels (in)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeDistance

double computeDistance(String mapName,
                       IPoint fromPoint,
                       IPoint toPoint)
                       throws IOException,
                              AutomationException

Computes the distance between two points on the specified map. The result is in the map units of the specified map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapName - The mapName (in)

fromPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

toPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Returns:

The distance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

IArray find(String mapName,
            String findString,
            int layerID)
            throws IOException,
                   AutomationException

Returns an array of 'find objects' (that implement the IFindObject interface) that contain the given search string. If layerID is equal to -1, all layers are searched.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapName - The mapName (in)

findString - The findString (in)

layerID - The layerID (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryByLayer

IFeatureCursor queryByLayer(String mapName,
                            int targetLayerID,
                            int selectionLayerID,
                            int selectionMethod,
                            boolean useSelected,
                            double bufferDistance,
                            int bufferDistanceUnits)
                            throws IOException,
                                   AutomationException

Returns a feature cursor for the specified layer based on the input parameters for the purpose of selecting based on another layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapName - The mapName (in)

targetLayerID - The targetLayerID (in)

selectionLayerID - The selectionLayerID (in)

selectionMethod - A com.esri.arcgis.carto.esriLayerSelectionMethod constant (in)

useSelected - The useSelected (in)

bufferDistance - The bufferDistance (in)

bufferDistanceUnits - A com.esri.arcgis.system.esriUnits constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureCursor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.