|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.MxdServer
public class MxdServer
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 =
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 |
---|
public MxdServer() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic MxdServer(java.lang.Object obj) throws java.io.IOException
MxdServer theMxdServer = (MxdServer) obj;
obj
to MxdServer
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problemsMethod Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public void start(java.lang.String mxdPath) throws java.io.IOException, AutomationException
start
in interface IMxdServer
mxdPath
- The mxdPath (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void startWithData(IDataset pDataset) throws java.io.IOException, AutomationException
startWithData
in interface IMxdServer
pDataset
- A reference to a com.esri.arcgis.geodatabase.IDataset (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void stop() throws java.io.IOException, AutomationException
stop
in interface IMxdServer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray getMapDescriptors() throws java.io.IOException, AutomationException
getMapDescriptors
in interface IMxdServer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray getLayerDescriptors(java.lang.String mapName) throws java.io.IOException, AutomationException
getLayerDescriptors
in interface IMxdServer
mapName
- The mapName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumSpatialBookmark getBookmarks(java.lang.String mapName) throws java.io.IOException, AutomationException
getBookmarks
in interface IMxdServer
mapName
- The mapName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Picture getThumbnail() throws java.io.IOException, AutomationException
getThumbnail
in interface IMxdServer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Picture getMapPicture(IMapDescriptor mapDescriptor, int dpi, tagRECT pixelBounds) throws java.io.IOException, AutomationException
getMapPicture
in interface IMxdServer
mapDescriptor
- A reference to a com.esri.arcgis.carto.IMapDescriptor (in)dpi
- The dpi (in)pixelBounds
- A Structure: com.esri.arcgis.system.tagRECT (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMapBitmapHandle(IMapDescriptor mapDescriptor, int dpi, tagRECT pixelBounds) throws java.io.IOException, AutomationException
getMapBitmapHandle
in interface IMxdServer
mapDescriptor
- A reference to a com.esri.arcgis.carto.IMapDescriptor (in)dpi
- The dpi (in)pixelBounds
- A Structure: com.esri.arcgis.system.tagRECT (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void releaseBitmapHandle(int hBmp) throws java.io.IOException, AutomationException
releaseBitmapHandle
in interface IMxdServer
hBmp
- The hBmp (A COM typedef) (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope exportMapImage(IMapDescriptor mapDescriptor, int dpi, int imageWidth, int imageHeight, java.lang.String fileType, java.lang.String outputFileName) throws java.io.IOException, AutomationException
exportMapImage
in interface IMxdServer
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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
exportLayout
in interface IMxdServer
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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
exportLegend
in interface IMxdServer
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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
exportScaleBar
in interface IMxdServer
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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
exportNorthArrow
in interface IMxdServer
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray getTOCInfo(java.lang.String mapName, int layerID) throws java.io.IOException, AutomationException
getTOCInfo
in interface IMxdServer
mapName
- The mapName (in)layerID
- The layerID (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDefaultMapName() throws java.io.IOException, AutomationException
getDefaultMapName
in interface IMxdServer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getFeatureValue(java.lang.String mapName, int layerID, IFeature feature, java.lang.String fieldName) throws java.io.IOException, AutomationException
getFeatureValue
in interface IMxdServer
mapName
- The mapName (in)layerID
- The layerID (in)feature
- A reference to a com.esri.arcgis.geodatabase.IFeature (in)fieldName
- The fieldName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureCursor queryFeatures(java.lang.String mapName, int layerID, IArray queryFilters) throws java.io.IOException, AutomationException
queryFeatures
in interface IMxdServerQuery
mapName
- The mapName (in)layerID
- The layerID (in)queryFilters
- A reference to a com.esri.arcgis.system.IArray (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray identify(java.lang.String mapName, int layerID, IGeometry shape) throws java.io.IOException, AutomationException
identify
in interface IMxdServerQuery
mapName
- The mapName (in)layerID
- The layerID (in)shape
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray getRelatedIdentifyObjects(java.lang.String mapName, IIdentifyObj identifyObject) throws java.io.IOException, AutomationException
getRelatedIdentifyObjects
in interface IMxdServerQuery
mapName
- The mapName (in)identifyObject
- A reference to a com.esri.arcgis.carto.IIdentifyObj (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double computeScale(java.lang.String mapName, int imageWidthPixels, IEnvelope extent) throws java.io.IOException, AutomationException
computeScale
in interface IMxdServerQuery
mapName
- The mapName (in)imageWidthPixels
- The imageWidthPixels (in)extent
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double computeDistance(java.lang.String mapName, IPoint fromPoint, IPoint toPoint) throws java.io.IOException, AutomationException
computeDistance
in interface IMxdServerQuery
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray find(java.lang.String mapName, java.lang.String findString, int layerID) throws java.io.IOException, AutomationException
find
in interface IMxdServerQuery
mapName
- The mapName (in)findString
- The findString (in)layerID
- The layerID (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureCursor queryByLayer(java.lang.String mapName, int targetLayerID, int selectionLayerID, int selectionMethod, boolean useSelected, double bufferDistance, int bufferDistanceUnits) throws java.io.IOException, AutomationException
queryByLayer
in interface IMxdServerQuery
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMap getMap(java.lang.String mapName) throws java.io.IOException, AutomationException
getMap
in interface IMxdServerObjects
mapName
- The mapName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILayer getLayer(java.lang.String mapName, int layerID) throws java.io.IOException, AutomationException
getLayer
in interface IMxdServerObjects
mapName
- The mapName (in)layerID
- The layerID (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPageLayout getPageLayout() throws java.io.IOException, AutomationException
getPageLayout
in interface IMxdServerObjects
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void cancel() throws java.io.IOException, AutomationException
cancel
in interface IMxdServerStatus
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |