com.esri.arcgis.carto
Class MxdServer

java.lang.Object
  com.esri.arcgis.carto.MxdServer

All Implemented Interfaces:

IMxdServer, IMxdServerObjects, IMxdServerQuery, IMxdServerStatus, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class MxdServer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMxdServer, IMxdServerQuery, IMxdServerObjects, IMxdServerStatus

COM Class 'MxdServer'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'The MxdServer component provides programmatic access to the contents of a map document on disk, and creates images of the map contents based on user requests. Designed for use in building map-based web services and web applications.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.carto.IMxdServer

DISPID_0_NAME, DISPID_1_NAME, DISPID_10_NAME, DISPID_11_NAME, DISPID_12_NAME, DISPID_13_NAME, DISPID_14_NAME, DISPID_15_GET_NAME, DISPID_16_GET_NAME, DISPID_17_NAME, DISPID_2_NAME, DISPID_3_GET_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_6_GET_NAME, DISPID_7_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IIDbd2e03fc_a244_46af_93ed_b522a090de89, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IMxdServerQuery

IID, IID1e90974d_6d47_480d_9aa9_d8f582757226, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IMxdServerObjects

IID, IID50949b31_90ac_4290_b001_952ef5204a62, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IMxdServerStatus

IID, IID6b0523cd_7947_48e0_8ec7_96f8937badd5, xxDummy

Constructor Summary

MxdServer()
Constructs a MxdServer using ArcGIS Engine.

MxdServer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MxdServer theMxdServer = (MxdServer) obj;

Method Summary

void	cancel() Cancels the current MxdServer operation.
double	computeDistance(java.lang.String mapName, IPoint fromPoint, IPoint toPoint) Computes the distance between two points on the specified map.
double	computeScale(java.lang.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.
boolean	equals(java.lang.Object o) Compare this object with another
IEnvelope	exportLayout(IArray mapDescriptors, int dpi, int imageWidth, int imageHeight, IEnvelope pageExtent, java.lang.String fileType, java.lang.String outputFileName) Generates an image of the layout, based on the given array of map descriptors, and writes the image to a specified file on disk.
void	exportLegend(ILegend legend, IMapDescriptor mapDescriptor, int dpi, int imageWidth, int imageHeight, IColor backgroundColor, java.lang.String fileType, java.lang.String outputFileName) Exports a legend to an image file.
IEnvelope	exportMapImage(IMapDescriptor mapDescriptor, int dpi, int imageWidth, int imageHeight, java.lang.String fileType, java.lang.String outputFileName) Generates an image of the map, based on the given map descriptor, and writes the image to the specified file on disk.
void	exportNorthArrow(INorthArrow arrow, int dpi, int imageWidth, int imageHeight, IColor backgroundColor, java.lang.String fileType, java.lang.String outputFileName) Exports a north arrow to an image file.
void	exportScaleBar(IScaleBar scalebar, int mapImageWidthPixels, int dpi, int imageWidth, int imageHeight, IColor backgroundColor, java.lang.String fileType, java.lang.String outputFileName) Exports a scale bar to an image file.
IArray	find(java.lang.String mapName, java.lang.String findString, int layerID) Returns an array of 'find objects' (that implement the IFindObject interface) that contain the given search string.
IEnumSpatialBookmark	getBookmarks(java.lang.String mapName) The spatial bookmarks saved with the specified map, if any.
static java.lang.String	getClsid() getClsid.
java.lang.String	getDefaultMapName() The TOC Information.
java.lang.String	getFeatureValue(java.lang.String mapName, int layerID, IFeature feature, java.lang.String fieldName) The value of the specified field for the specified feature.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILayer	getLayer(java.lang.String mapName, int layerID) The layer specified by the map name and layer ID.
IArray	getLayerDescriptors(java.lang.String mapName) An array of LayerDescriptor objects for a given map name.
IMap	getMap(java.lang.String mapName) The map corresponding to the specified map name.
int	getMapBitmapHandle(IMapDescriptor mapDescriptor, int dpi, tagRECT pixelBounds) Generates a picture of the map, based on the given map descriptor, and returns an HBITMAP handle to the resulting image.
IArray	getMapDescriptors() An array of MapDescriptor objects, where each map descriptor describes the characteristics of a data frame in the document.
Picture	getMapPicture(IMapDescriptor mapDescriptor, int dpi, tagRECT pixelBounds) Generates a picture of the map, based on the given map descriptor, and returns the image as an IPictureDisp.
IPageLayout	getPageLayout() The page layout object for the current map document.
IArray	getRelatedIdentifyObjects(java.lang.String mapName, IIdentifyObj identifyObject) An array of 'identify objects' that are related to the specified identify object.
Picture	getThumbnail() The thumbnail image stored with the map document, if any.
IArray	getTOCInfo(java.lang.String mapName, int layerID) The TOC Information.
int	hashCode() the hashcode for this object
IArray	identify(java.lang.String mapName, int layerID, IGeometry shape) Returns an array of 'identify objects' (that support the IIdentifyObj interface) at the given location.
IFeatureCursor	queryByLayer(java.lang.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(java.lang.String mapName, int layerID, IArray queryFilters) Returns a feature cursor for the specified layer based on the given array of query filters.
void	release() Release a MxdServer.
void	releaseBitmapHandle(int hBmp) Companion function to GetBitmapHandle().
void	start(java.lang.String mxdPath) Initializes the map server with an mxd file stored at the specified path.
void	startWithData(IDataset pDataset) An alternative to calling Start() with a document name, this method synthesizes a map document with a single layer based on the given IDataset object, and initializes the map server for processing.
void	stop() Clears out all of the map objects in memory.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MxdServer

public MxdServer()
          throws java.io.IOException,
                 java.net.UnknownHostException

Constructs a MxdServer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MxdServer

public MxdServer(java.lang.Object obj)
          throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MxdServer theMxdServer = (MxdServer) obj;

Construct a MxdServer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MxdServer.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a MxdServer.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

start

public void start(java.lang.String mxdPath)
           throws java.io.IOException,
                  AutomationException

Initializes the map server with an mxd file stored at the specified path. The path must be able to be located by the server machine.

Specified by:

start in interface IMxdServer

Parameters:

mxdPath - The mxdPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startWithData

public void startWithData(IDataset pDataset)
                   throws java.io.IOException,
                          AutomationException

An alternative to calling Start() with a document name, this method synthesizes a map document with a single layer based on the given IDataset object, and initializes the map server for processing.

Specified by:

startWithData in interface IMxdServer

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IDataset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws java.io.IOException,
                 AutomationException

Clears out all of the map objects in memory. The client must call one of the Start methods again before attempting any other operations.

Specified by:

stop in interface IMxdServer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapDescriptors

public IArray getMapDescriptors()
                         throws java.io.IOException,
                                AutomationException

An array of MapDescriptor objects, where each map descriptor describes the characteristics of a data frame in the document. The properties of a map descriptor object can be altered in order to draw the map image with different state than the default.

Specified by:

getMapDescriptors in interface IMxdServer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptors

public IArray getLayerDescriptors(java.lang.String mapName)
                           throws java.io.IOException,
                                  AutomationException

An array of LayerDescriptor objects for a given map name. Each layer descriptor describes the characteristics of a layer in the map. Default layer properties can be changed to change output.

Specified by:

getLayerDescriptors in interface IMxdServer

Parameters:

mapName - The mapName (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBookmarks

public IEnumSpatialBookmark getBookmarks(java.lang.String mapName)
                                  throws java.io.IOException,
                                         AutomationException

The spatial bookmarks saved with the specified map, if any.

Specified by:

getBookmarks in interface IMxdServer

Parameters:

mapName - The mapName (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumSpatialBookmark

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnail

public Picture getThumbnail()
                     throws java.io.IOException,
                            AutomationException

The thumbnail image stored with the map document, if any. If the document has no thumbnail stored with it, this method will return E_FAIL and the returned IPictureDisp object will be null.

Specified by:

getThumbnail in interface IMxdServer

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapPicture

public Picture getMapPicture(IMapDescriptor mapDescriptor,
                             int dpi,
                             tagRECT pixelBounds)
                      throws java.io.IOException,
                             AutomationException

Generates a picture of the map, based on the given map descriptor, and returns the image as an IPictureDisp. If pMapDescriptor is null, it draws a picture of the default map at the default extent.

Specified by:

getMapPicture in interface IMxdServer

Parameters:

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapBitmapHandle

public int getMapBitmapHandle(IMapDescriptor mapDescriptor,
                              int dpi,
                              tagRECT pixelBounds)
                       throws java.io.IOException,
                              AutomationException

Generates a picture of the map, based on the given map descriptor, and returns an HBITMAP handle to the resulting image. If you call this function, you absolutely MUST call ReleaseBitmapHandle() with the returned bitmap handle.

Specified by:

getMapBitmapHandle in interface IMxdServer

Parameters:

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)

Returns:

The hBmp (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

releaseBitmapHandle

public void releaseBitmapHandle(int hBmp)
                         throws java.io.IOException,
                                AutomationException

Companion function to GetBitmapHandle(). Releases the bitmap handle that is returned from that function.

Specified by:

releaseBitmapHandle in interface IMxdServer

Parameters:

hBmp - The hBmp (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportMapImage

public IEnvelope exportMapImage(IMapDescriptor mapDescriptor,
                                int dpi,
                                int imageWidth,
                                int imageHeight,
                                java.lang.String fileType,
                                java.lang.String outputFileName)
                         throws java.io.IOException,
                                AutomationException

Generates an image of the map, based on the given map descriptor, and writes the image to the specified file on disk. Supported file types are: 'bmp', 'jpg', 'tif', 'png'/'png8', 'png24', 'emf' and 'pcx'.

Specified by:

exportMapImage in interface IMxdServer

Parameters:

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportLayout

public IEnvelope exportLayout(IArray mapDescriptors,
                              int dpi,
                              int imageWidth,
                              int imageHeight,
                              IEnvelope pageExtent,
                              java.lang.String fileType,
                              java.lang.String outputFileName)
                       throws java.io.IOException,
                              AutomationException

Generates an image of the layout, based on the given array of map descriptors, and writes the image to a specified file on disk. Supported Image types are: 'bmp', 'jpg', 'tif', 'png', 'emf', 'eps', 'pdf', 'ai', 'pcx'.

Specified by:

exportLayout in interface IMxdServer

Parameters:

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

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

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

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportLegend

public void exportLegend(ILegend legend,
                         IMapDescriptor mapDescriptor,
                         int dpi,
                         int imageWidth,
                         int imageHeight,
                         IColor backgroundColor,
                         java.lang.String fileType,
                         java.lang.String outputFileName)
                  throws java.io.IOException,
                         AutomationException

Exports a legend to an image file. The client can create the pLegend object and set its desired properties appropriately. If pLegend is null, a default legend for the default map will be generated.

Specified by:

exportLegend in interface IMxdServer

Parameters:

legend - A reference to a com.esri.arcgis.carto.ILegend (in)

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportScaleBar

public void exportScaleBar(IScaleBar scalebar,
                           int mapImageWidthPixels,
                           int dpi,
                           int imageWidth,
                           int imageHeight,
                           IColor backgroundColor,
                           java.lang.String fileType,
                           java.lang.String outputFileName)
                    throws java.io.IOException,
                           AutomationException

Exports a scale bar to an image file. The client can create the pScaleBar object and set its desired properties appropriately. If pScaleBar is null, a default scale bar will be generated for the default map.

Specified by:

exportScaleBar in interface IMxdServer

Parameters:

scalebar - A reference to a com.esri.arcgis.carto.IScaleBar (in)

mapImageWidthPixels - The mapImageWidthPixels (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportNorthArrow

public void exportNorthArrow(INorthArrow arrow,
                             int dpi,
                             int imageWidth,
                             int imageHeight,
                             IColor backgroundColor,
                             java.lang.String fileType,
                             java.lang.String outputFileName)
                      throws java.io.IOException,
                             AutomationException

Exports a north arrow to an image file. The client can create the pArrow object and set its desired properties appropriately. If pArrow is null, a default north arrow will be generated for the default map.

Specified by:

exportNorthArrow in interface IMxdServer

Parameters:

arrow - A reference to a com.esri.arcgis.carto.INorthArrow (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTOCInfo

public IArray getTOCInfo(java.lang.String mapName,
                         int layerID)
                  throws java.io.IOException,
                         AutomationException

The TOC Information.

Specified by:

getTOCInfo in interface IMxdServer

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMapName

public java.lang.String getDefaultMapName()
                                   throws java.io.IOException,
                                          AutomationException

The TOC Information.

Specified by:

getDefaultMapName in interface IMxdServer

Returns:

The mapName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureValue

public java.lang.String getFeatureValue(java.lang.String mapName,
                                        int layerID,
                                        IFeature feature,
                                        java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException

The value of the specified field for the specified feature.

Specified by:

getFeatureValue in interface IMxdServer

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

fieldName - The fieldName (in)

Returns:

The fieldValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryFeatures

public IFeatureCursor queryFeatures(java.lang.String mapName,
                                    int layerID,
                                    IArray queryFilters)
                             throws java.io.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.

Specified by:

queryFeatures in interface IMxdServerQuery

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(java.lang.String mapName,
                       int layerID,
                       IGeometry shape)
                throws java.io.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.

Specified by:

identify in interface IMxdServerQuery

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelatedIdentifyObjects

public IArray getRelatedIdentifyObjects(java.lang.String mapName,
                                        IIdentifyObj identifyObject)
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:

getRelatedIdentifyObjects in interface IMxdServerQuery

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeScale

public double computeScale(java.lang.String mapName,
                           int imageWidthPixels,
                           IEnvelope extent)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

computeScale in interface IMxdServerQuery

Parameters:

mapName - The mapName (in)

imageWidthPixels - The imageWidthPixels (in)

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

Returns:

The scale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeDistance

public double computeDistance(java.lang.String mapName,
                              IPoint fromPoint,
                              IPoint toPoint)
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

computeDistance in interface IMxdServerQuery

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

public IArray find(java.lang.String mapName,
                   java.lang.String findString,
                   int layerID)
            throws java.io.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.

Specified by:

find in interface IMxdServerQuery

Parameters:

mapName - The mapName (in)

findString - The findString (in)

layerID - The layerID (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryByLayer

public IFeatureCursor queryByLayer(java.lang.String mapName,
                                   int targetLayerID,
                                   int selectionLayerID,
                                   int selectionMethod,
                                   boolean useSelected,
                                   double bufferDistance,
                                   int bufferDistanceUnits)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

queryByLayer in interface IMxdServerQuery

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap(java.lang.String mapName)
            throws java.io.IOException,
                   AutomationException

The map corresponding to the specified map name. Pass in a blank string for mapName to get the default map. If the mapName does not correspond to any map in the document, E_INVALIDARG is returned and ppMap will be null.

Specified by:

getMap in interface IMxdServerObjects

Parameters:

mapName - The mapName (in)

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(java.lang.String mapName,
                       int layerID)
                throws java.io.IOException,
                       AutomationException

The layer specified by the map name and layer ID. If the mapName is blank, the default map will be assumed. If the map or layer specified is not found, an E_INVALIDARG error will be returned.

Specified by:

getLayer in interface IMxdServerObjects

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageLayout

public IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException

The page layout object for the current map document.

Specified by:

getPageLayout in interface IMxdServerObjects

Returns:

A reference to a com.esri.arcgis.carto.IPageLayout

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws java.io.IOException,
                   AutomationException

Cancels the current MxdServer operation.

Specified by:

cancel in interface IMxdServerStatus

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.