Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class MapServer

java.lang.Object
  extended by com.esri.arcgis.carto.MapServer
All Implemented Interfaces:
IMapServer, IMapServer2, IMapServer3, IMapServerData, IMapServerDataAccess, IMapServerInit, IMapServerInit2, IMapServerLayout, IMapServerObjects, IMapServerObjects2, IMapServerObjects3, ITiledMapServer, ITiledMapServer2, ITiledMapServer3, com.esri.arcgis.interop.RemoteObjRef, IServerObject, IServerObjectConfigurationManager, IServerObjectConfigurationManager2, IServerObjectExtensionManager, ILogSupport, IObjectActivate, IObjectConstruct, IObjectUpdate, IObjectValidate, IRequestHandler, IRequestHandler2, IRESTRequestHandler, ISupportErrorInfo, java.io.Serializable
public class MapServer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapServer, ITiledMapServer2, ITiledMapServer3, IObjectConstruct, IRequestHandler, IRequestHandler2, IMapServerObjects, IMapServerObjects2, IMapServerObjects3, IMapServerData, IMapServerLayout, IMapServerInit, IMapServerInit2, IObjectActivate, IObjectUpdate, ILogSupport, ISupportErrorInfo, IServerObject, IServerObjectExtensionManager, IMapServer2, IMapServer3, IServerObjectConfigurationManager, IServerObjectConfigurationManager2, IObjectValidate, IMapServerDataAccess, IRESTRequestHandler

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

Description 'The MapServer 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.IMapServer
IID, IID12353e37_ab79_48f7_9cb1_56ec9d7eb800, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ITiledMapServer2
IID, IIDb5339959_b276_4485_ac86_15f3a9a40395, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ITiledMapServer
IID1627ce7e_954f_4013_9969_e726f8084c25
 
Fields inherited from interface com.esri.arcgis.carto.ITiledMapServer3
IID, IID6c3d86d9_e02d_403f_94c2_427c5cf78c19, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IRequestHandler2
IID, IID8319e7d0_8ad1_48ed_aa99_03f9d0c93ba8, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IRequestHandler
IID46a0e2ea_3b64_4a46_bd78_88a1660f35bb
 
Fields inherited from interface com.esri.arcgis.carto.IMapServerObjects
IID, IID651521f3_aaff_42b9_8c2d_1980625a13bf, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServerObjects2
IID, IID732da8b0_beb9_49b6_bf83_c1df94f22aa0, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServerObjects3
IID, IIDfbf3935d_72da_43a3_afc0_56f124e30773, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServerData
IID, IIDaddaef3b_870a_4e9d_9ab0_242a72c3f812, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServerLayout
IID, IID545329c0_300b_46f3_9fb3_71f30ecfde62, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServerInit2
IID, IIDed28c857_2ca2_47cc_8cad_5c90bc2fc012, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServerInit
IID56e179e3_974e_41a7_836b_c9a60ef6301b
 
Fields inherited from interface com.esri.arcgis.system.IObjectActivate
IID, IIDe3b78022_143e_4e61_9099_ed319ec061e7, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IObjectUpdate
IID, IIDd641f414_1004_4e73_9386_f6ea543e2d95, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Fields inherited from interface com.esri.arcgis.server.IServerObject
IID, IID0ad6ab40_9d6a_4bf8_8b86_eb89406dfc6c, xxDummy
 
Fields inherited from interface com.esri.arcgis.server.IServerObjectExtensionManager
IID, IID25d8b9dd_c7e8_4da4_bf4b_08a67087ceea, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServer2
IID, IIDa96fc7c0_57f7_4fc1_993a_4913b2ced0ed, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServer3
IID, IID58a70e5d_f883_4919_b573_cabaf849a7ce, xxDummy
 
Fields inherited from interface com.esri.arcgis.server.IServerObjectConfigurationManager2
IID, IID3130f209_598d_4269_b404_df6b13804742, xxDummy
 
Fields inherited from interface com.esri.arcgis.server.IServerObjectConfigurationManager
IID181f5a7e_25c9_4fbf_9166_75d638acc930
 
Fields inherited from interface com.esri.arcgis.system.IObjectValidate
IID, IID55446beb_10ca_40a4_9f40_261ca4a7f35a, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServerDataAccess
IID, IIDa3072b50_65e2_4035_b438_8363edd349c0, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IRESTRequestHandler
IID, IID9d66a418_d54a_48ed_88bd_043a25fa9c83, xxDummy
 
Constructor Summary
MapServer()
          Constructs a MapServer using ArcGIS Engine.
MapServer(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapServer theMapServer = (MapServer) obj;
 
Method Summary
 void activate()
          Activates the object.
 void applyMapDescription(IMapDescription mapDescription, IImageDisplay mapDisplay)
          Applies the current state of the map description to the map server object.
 void beforeStart(IServerObjectAdmin pAdmin, IPropertySet props)
          Is called before the configuration is started.
 void beforeStop(IServerObjectAdmin pAdmin, IPropertySet props)
          Is called before the configuration is stopped.
 double computeDistance(java.lang.String mapName, IPoint fromPoint, IPoint toPoint, int units)
          Computes the distance between two points on the specified map.
 double computeScale(IMapDescription mapDesc, IImageDisplay mapDisplay)
          Computes the scale of the specified map, at the given map extent, for an image with the given size.
 void connect(java.lang.String filePath)
          Initializes the map server with an mxd or pmf file stored at the specified path.
 void construct(IPropertySet props)
          Two phase object construction.
 void deactivate()
          Deactivates the object.
 boolean equals(java.lang.Object o)
          Compare this object with another
 ILayoutImage exportLayout(IPageDescription pageDesc, IImageDescription imageDesc)
          Generates an image of the layout, based on the given page description object, and writes the image to a specified file on disk.
 IImageResult exportLegend(ILegend legend, IMapDescription mapDesc, IImageDisplay pMapDisplay, IColor backgroundColor, IImageDescription imageDesc)
          Exports a legend to an image file.
 IMapImage exportMapImage(IMapDescription mapDesc, IImageDescription imageDesc)
          Generates an image of the map, based on the given map description, and writes the image to a specified file on disk.
 IImageResult exportNorthArrow(INorthArrow arrow, IMapDescription mapDesc, IColor backgroundColor, IImageDescription imageDesc)
          Exports a north arrow to an image file.
 IImageResult exportScaleBar(IScaleBar scalebar, IMapDescription mapDesc, IImageDisplay pMapDisplay, IColor backgroundColor, IImageDescription imageDesc)
          Exports a scale bar to an image file.
 IMapServerFindResults find(IMapDescription mapDesc, IImageDisplay mapImage, java.lang.String searchString, boolean contains, java.lang.String searchFields, int option, ILongArray layerIds)
          Returns a collection of Map Server Find Result objects that contain the given search string.
 IServerObjectExtension findExtensionByCLSID(java.lang.String cLSID)
          Returns a server object extension found using a string representation of its class ID.
 IServerObjectExtension findExtensionByTypeName(java.lang.String name)
          Returns a server object extension found using its type name.
 void fromMapPoints(IMapDescription mapDescription, IImageDisplay mapDisplay, IPointCollection mapPoints, ILongArray[] screenXValues, ILongArray[] screenYValues)
          Converts a map coordinate to a screen location.
 void fromPagePoints(IEnvelope pageExtent, IImageDisplay pageDisplay, IPointCollection pagePoints, ILongArray[] screenXValues, ILongArray[] screenYValues)
          Converts a page coordinate to a screen location.
 ICacheControlInfo getCacheControlInfo(java.lang.String mapName)
          Gets the cache description information for a given map.
 ICacheDescriptionInfo getCacheDescriptionInfo(java.lang.String mapName)
          Gets the cache description information for a given map.
 java.lang.String getCacheName(java.lang.String mapName, int layerID)
          Gets the cache name for a given layer within a map.
 ICacheStorageInfo getCacheStorageInfo(java.lang.String mapName)
          Gets the cache storage information.
static java.lang.String getClsid()
          getClsid.
 java.lang.String getConfigurationName()
          Name of the server object configuration that defines the server object.
 java.lang.Object getDataSource(java.lang.String mapName, int layerID)
          Get Data Source
 ILayerDrawingDescriptions getDefaultLayerDrawingDescriptions(java.lang.String mapName, ILongArray pLayerIDs, IServerSymbolOutputOptions outputOptions)
          Get Layer Drawing Description
 java.lang.String getDefaultMapName()
          Name of the document's active map (data frame).
 IPageDescription getDefaultPageDescription()
          The default page settings.
 java.lang.Object getDisplayDataSource(java.lang.String mapName, int layerOrTableID)
          Get Display Data Source
 IPropertySet getDocumentInfo()
          A set of name-value pairs for properties set for the map document (mxd only).
 IFeature getFeature(java.lang.String mapName, int layerID, int featureId)
          Returns a feature, given the feature ID and layer.
 java.lang.String getFeatureValue(java.lang.String mapName, int layerID, IFeature feature, java.lang.String fieldName)
          Returns the value of a given feature as a string.
 java.lang.String getFilePath()
          The map document path.
 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.
 int getLayerID(java.lang.String mapName, ILayer pLayer)
          The layer specified by the map name and layer ID.
 byte[] getLayerTile(java.lang.String mapName, int layerID, int level, int row, int column)
          Gets a tile for a given tile location from a given layer.
 byte[] getLayerTileEx(java.lang.String mapName, int layerID, int level, int row, int column, int cacheFormat)
          Gets a tile for a given tile location from a given layer.
 IMapServerLegendInfos getLegendInfo(java.lang.String mapName, ILongArray layerIds, IMapServerLegendPatch patch, IImageType imgType)
          Returns a collection of Map Server Legend Info objects for the specified layers.
 IMap getMap(java.lang.String mapName)
          The map corresponding to the specified map name.
 int getMapCount()
          The number of maps (data frames) in the document.
 java.lang.String getMapName(int index)
          Name of the map (data frame) as indicated by the index.
 IMapTableSubtypeInfos getMapTableSubtypeInfos(java.lang.String mapName, ILongArray pTableIDs)
          Returns the MapTableSubtypeInfos in the current map.
 byte[] getMapTile(java.lang.String mapName, int level, int row, int column)
          Gets a tile for a given tile location from a given map.
 byte[] getMapTileEx(java.lang.String mapName, int level, int row, int column, int cacheFormat)
          Gets a tile for a given tile location from a given map.
 int getMaxBufferCount()
          The maximum number of records buffered on the server for display.
 int getMaxImageHeight()
          The maximum height in pixels of an image request.
 int getMaxImageWidth()
          The maximum width in pixels of an image request.
 int getMaxRecordCount()
          The maximum number of records returned for query results (Identify, Find, QueryFeatureData, and QueryHyperlinks).
 IPageLayout getPageLayout()
          The page layout object for the current map document.
 java.lang.String getPhysicalCacheDirectory()
          The physical directory for cache files.
 java.lang.String getPhysicalOutputDirectory()
          The physical directory for output files.
 java.lang.String getSchema()
          This method returns the resource hierarchy of a REST based SOE.
 IMapServerInfo getServerInfo(java.lang.String mapName)
          Returns information about a map (data frame).
 IPropertySet getServiceConfigurationInfo()
          A set of name-value pairs for properties set for the MapServer Service Configuration Restrictions.
 java.lang.String getSOMCacheDirectory()
          The parent directory for cache files.
 java.lang.String getSOMVirtualCacheDirectory()
          The parent virtual directory for cache files.
 ISQLSyntaxInfo getSQLSyntaxInfo(java.lang.String mapName, int layerID)
          Returns the SQL syntax information for the specified layer.
 ITable getStandaloneTable(java.lang.String mapName, int standaloneTableID)
          The table specified by the map name and table ID.
 int getStandaloneTableID(java.lang.String mapName, ITable pTable)
          The layer specified by the map name and standalone table ID.
 int getSupportedImageReturnTypes()
          The supported image return types for the map server.
 Picture getThumbnail()
          The thumbnail stored in the map document.
 ITileCacheInfo getTileCacheInfo(java.lang.String mapName)
          Gets the cache configuration for a given map.
 ITileImageInfo getTileImageInfo(java.lang.String mapName)
          Gets the cache tile image information for a given map.
 java.lang.String getTypeName()
          Type of the server object (MapServer or GeocodeServer).
 java.lang.String getVirtualCacheDirectory()
          The virtual directory for cache files.
 java.lang.String getVirtualCacheDirectory(java.lang.String mapName, int layerID)
          Gets the virtual cache directory for a given layer within a map.
 java.lang.String getVirtualOutputDirectory()
          The virtual directory for output files.
 byte[] handleBinaryRequest(byte[] request)
          Handles a binary request.
 byte[] handleBinaryRequest2(java.lang.String capabilities, byte[] request)
          Handles a binary request with explicit capabilities.
 byte[] handleRESTRequest(java.lang.String capabilities, java.lang.String resourceName, java.lang.String operationName, java.lang.String operationInput, java.lang.String outputFormat, java.lang.String requestProperties, java.lang.String[] responseProperties)
          Handles REST requests for SOE.
 java.lang.String handleStringRequest(java.lang.String capabilities, java.lang.String request)
          Handles a SOAP string request.
 int hashCode()
          the hashcode for this object
 boolean hasLayerCache(java.lang.String mapName, int layerID)
          Indicates if a given layer has a single tile cache.
 boolean hasSingleFusedMapCache(java.lang.String mapName)
          Indicates if a given map has a single fused map tile cache.
 IMapServerIdentifyResults identify(IMapDescription mapDesc, IImageDisplay mapImage, IGeometry searchShape, int tolerance, int option, ILongArray layerIds)
          Returns a collection of Map Server Identify Result objects at the given location.
 void initLogging(ILog log)
          Initializes an object with a log.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isFixedScaleMap(java.lang.String mapName)
          Indicates if a given map is a fixed scale map.
 IPropertySet onAdd(IPropertySet pProps)
          Is called when the configuration is added.
 void onRemove()
          Is called when the configuration is removed.
 void onRemoveEx(IServerObjectAdmin pAdmin, IPropertySet props)
          Is called when the configuration is removed.
 void onStart(IServerObjectAdmin pAdmin, IPropertySet pProps)
          Is called when the configuration is started.
 void onStop(IServerObjectAdmin pAdmin, IPropertySet pProps)
          Is called when the configuration is stopped.
 IAttachmentDataArray queryAttachmentData(java.lang.String mapName, int tableID, ILongArray attachmentIDs, int transportType)
          Returns the attachment data for the given features/ rows.
 IAttachmentInfoArray queryAttachmentInfos(java.lang.String mapName, int tableID, ILongArray rowIDs)
          Returns the attachment info that describe the attachments for the given features/ rows.
 IQueryResult queryData(java.lang.String mapName, IMapTableDescription pMapTableDescription, IQueryFilter filter, IQueryResultOptions options)
          Returns a record set of rows that meet the query filter selection criteria for the specified table.
 int queryFeatureCount(java.lang.String mapName, int layerID, IQueryFilter filter)
          Returns the count of the features that meet the query filter selection criteria for the specified layer.
 int queryFeatureCount2(java.lang.String mapName, ILayerDescription pLayerDescription, IQueryFilter filter)
          Returns the count of the features that meet the query filter selection criteria for the specified layer.
 IRecordSet queryFeatureData(java.lang.String mapName, int layerID, IQueryFilter filter)
          Returns a record set of features that meet the query filter selection criteria for the specified layer.
 IQueryResult queryFeatureData2(java.lang.String mapName, ILayerDescription pLayerDesciscription, IQueryFilter filter, IQueryResultOptions options)
          Returns a record set of features that meet the query filter selection criteria for the specified layer.
 IFIDSet queryFeatureIDs(java.lang.String mapName, int layerID, IQueryFilter filter)
          Returns the IDs of the features that meet the query filter selection criteria for the specified layer.
 IFIDSet queryFeatureIDs2(java.lang.String mapName, ILayerDescription pLayerDesciscription, IQueryFilter filter)
          Returns the IDs of the features that meet the query filter selection criteria for the specified layer.
 IStringArray queryHTMLPopups(java.lang.String mapName, int tableID, ILongArray pRowIDs)
          Returns the html as text that can be used in popups.
 IMapServerHyperlinks queryHyperlinks(IMapDescription mapDesc, IImageDisplay mapImage, ILongArray layerIds)
          Returns a collection of Map Server Hyperlink objects for the specified layers.
 IImageResults queryRasterValue(java.lang.String mapName, int sourceTableID, ILongArray rowIDs, java.lang.String fieldName, IImageType rasterValueType)
          Returns the Raster content that meet the selection criteria for the specified table.
 IQueryResult queryRelatedRecords(java.lang.String mapName, int sourceTable, IFIDSet pFIDs, IRelateDescription relateDescription)
          Returns the IDs of the rows that meet the query filter selection criteria for the specified table.
 int queryRowCount(java.lang.String mapName, IMapTableDescription pTableDescription, IQueryFilter pFilter)
          Returns the count of the rows that meet the query filter selection criteria for the specified table.
 ILongArray queryRowIDs(java.lang.String mapName, IMapTableDescription pTableDescription, IQueryFilter pFilter)
          Returns the IDs of the rows that meet the query filter selection criteria for the specified table.
 void refreshServerObjects()
          Updates the server info based on the current state of the underlying fine-grained objects.
 void release()
          Release a MapServer.
 void setMaxBufferCount(int count)
          The maximum number of records buffered on the server for display.
 void setMaxImageHeight(int height)
          The maximum height in pixels of an image request.
 void setMaxImageWidth(int width)
          The maximum width in pixels of an image request.
 void setMaxRecordCount(int count)
          The maximum number of records returned for query results (Identify, Find, QueryFeatureData, and QueryHyperlinks).
 void setPhysicalCacheDirectory(java.lang.String pCacheDir)
          The physical directory for cache files.
 void setPhysicalOutputDirectory(java.lang.String dirPath)
          The physical directory for output files.
 void setSOMCacheDirectory(java.lang.String pCacheDir)
          The parent directory for cache files.
 void setVirtualCacheDirectory(java.lang.String pVirtualCacheDir)
          The virtual directory for cache files.
 void setVirtualOutputDirectory(java.lang.String dirPath)
          The virtual directory for output files.
 void startWithData(IDataset pDataset)
          An alternative to calling Connect().
 void stop()
          Clears out all of the map objects in memory.
 IPointCollection toMapPoints(IMapDescription mapDescription, IImageDisplay mapDisplay, ILongArray screenXValues, ILongArray screenYValues)
          Converts a screen location to a map coordinate.
 IPointCollection toPagePoints(IEnvelope pageExtent, IImageDisplay pageDisplay, ILongArray screenXValues, ILongArray screenYValues)
          Converts a screen location to a page coordinate.
 void update(IPropertySet props)
          Updates object's properties.
 void validate(IPropertySet props)
          Validates an object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MapServer

public MapServer()
          throws java.io.IOException,
                 java.net.UnknownHostException
Constructs a MapServer using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

MapServer

public MapServer(java.lang.Object obj)
          throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapServer theMapServer = (MapServer) obj;

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

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 MapServer.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getDocumentInfo

public IPropertySet getDocumentInfo()
                             throws java.io.IOException,
                                    AutomationException
A set of name-value pairs for properties set for the map document (mxd only). These properties are string values set in the map document's Map Properties dialog and include: Title, Subject, Author, Category, Keywords and Comments.

Specified by:
getDocumentInfo in interface IMapServer
Specified by:
getDocumentInfo in interface IMapServer2
Specified by:
getDocumentInfo in interface IMapServer3
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapCount

public int getMapCount()
                throws java.io.IOException,
                       AutomationException
The number of maps (data frames) in the document.

Specified by:
getMapCount in interface IMapServer
Specified by:
getMapCount in interface IMapServer2
Specified by:
getMapCount in interface IMapServer3
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapName

public java.lang.String getMapName(int index)
                            throws java.io.IOException,
                                   AutomationException
Name of the map (data frame) as indicated by the index. The first beginning with 0.

Specified by:
getMapName in interface IMapServer
Specified by:
getMapName in interface IMapServer2
Specified by:
getMapName in interface IMapServer3
Parameters:
index - The index (in)
Returns:
The mapName
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
Name of the document's active map (data frame).

Specified by:
getDefaultMapName in interface IMapServer
Specified by:
getDefaultMapName in interface IMapServer2
Specified by:
getDefaultMapName in interface IMapServer3
Returns:
The mapName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerInfo

public IMapServerInfo getServerInfo(java.lang.String mapName)
                             throws java.io.IOException,
                                    AutomationException
Returns information about a map (data frame).

Specified by:
getServerInfo in interface IMapServer
Specified by:
getServerInfo in interface IMapServer2
Specified by:
getServerInfo in interface IMapServer3
Parameters:
mapName - The mapName (in)
Returns:
A reference to a com.esri.arcgis.carto.IMapServerInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportMapImage

public IMapImage exportMapImage(IMapDescription mapDesc,
                                IImageDescription imageDesc)
                         throws java.io.IOException,
                                AutomationException
Generates an image of the map, based on the given map description, and writes the image to a specified file on disk. Supported file types are: 'bmp', 'jpg', 'tif', 'png'/'png8', 'png24', 'emf', 'ps', 'pdf', 'ai', 'gif', and 'svg'/'svgz'.

Specified by:
exportMapImage in interface IMapServer
Specified by:
exportMapImage in interface IMapServer2
Specified by:
exportMapImage in interface IMapServer3
Parameters:
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
imageDesc - A reference to a com.esri.arcgis.carto.IImageDescription (in)
Returns:
A reference to a com.esri.arcgis.carto.IMapImage
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

find

public IMapServerFindResults find(IMapDescription mapDesc,
                                  IImageDisplay mapImage,
                                  java.lang.String searchString,
                                  boolean contains,
                                  java.lang.String searchFields,
                                  int option,
                                  ILongArray layerIds)
                           throws java.io.IOException,
                                  AutomationException
Returns a collection of Map Server Find Result objects that contain the given search string. If LayerIDs is Nothing/Null or empty, all layers are searched.

Specified by:
find in interface IMapServer
Specified by:
find in interface IMapServer2
Specified by:
find in interface IMapServer3
Parameters:
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
mapImage - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
searchString - The searchString (in)
contains - The contains (in)
searchFields - The searchFields (in)
option - A com.esri.arcgis.carto.esriFindOption constant (in)
layerIds - A reference to a com.esri.arcgis.system.ILongArray (in)
Returns:
A reference to a com.esri.arcgis.carto.IMapServerFindResults
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

identify

public IMapServerIdentifyResults identify(IMapDescription mapDesc,
                                          IImageDisplay mapImage,
                                          IGeometry searchShape,
                                          int tolerance,
                                          int option,
                                          ILongArray layerIds)
                                   throws java.io.IOException,
                                          AutomationException
Returns a collection of Map Server Identify Result objects at the given location. If LayerIDs is Nothing/Null or empty, all layers are searched.

Specified by:
identify in interface IMapServer
Specified by:
identify in interface IMapServer2
Specified by:
identify in interface IMapServer3
Parameters:
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
mapImage - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
searchShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
tolerance - The tolerance (in)
option - A com.esri.arcgis.carto.esriIdentifyOption constant (in)
layerIds - A reference to a com.esri.arcgis.system.ILongArray (in)
Returns:
A reference to a com.esri.arcgis.carto.IMapServerIdentifyResults
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryFeatureCount

public int queryFeatureCount(java.lang.String mapName,
                             int layerID,
                             IQueryFilter filter)
                      throws java.io.IOException,
                             AutomationException
Returns the count of the features that meet the query filter selection criteria for the specified layer.

Specified by:
queryFeatureCount in interface IMapServer
Specified by:
queryFeatureCount in interface IMapServer2
Specified by:
queryFeatureCount in interface IMapServer3
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryFeatureIDs

public IFIDSet queryFeatureIDs(java.lang.String mapName,
                               int layerID,
                               IQueryFilter filter)
                        throws java.io.IOException,
                               AutomationException
Returns the IDs of the features that meet the query filter selection criteria for the specified layer.

Specified by:
queryFeatureIDs in interface IMapServer
Specified by:
queryFeatureIDs in interface IMapServer2
Specified by:
queryFeatureIDs in interface IMapServer3
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFIDSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryFeatureData

public IRecordSet queryFeatureData(java.lang.String mapName,
                                   int layerID,
                                   IQueryFilter filter)
                            throws java.io.IOException,
                                   AutomationException
Returns a record set of features that meet the query filter selection criteria for the specified layer.

Specified by:
queryFeatureData in interface IMapServer
Specified by:
queryFeatureData in interface IMapServer2
Specified by:
queryFeatureData in interface IMapServer3
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRecordSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryHyperlinks

public IMapServerHyperlinks queryHyperlinks(IMapDescription mapDesc,
                                            IImageDisplay mapImage,
                                            ILongArray layerIds)
                                     throws java.io.IOException,
                                            AutomationException
Returns a collection of Map Server Hyperlink objects for the specified layers. Only hyperlinks of visible layers are returned. If LayerIDs is Nothing/Null or empty, all layers are searched.

Specified by:
queryHyperlinks in interface IMapServer
Specified by:
queryHyperlinks in interface IMapServer2
Specified by:
queryHyperlinks in interface IMapServer3
Parameters:
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
mapImage - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
layerIds - A reference to a com.esri.arcgis.system.ILongArray (in)
Returns:
A reference to a com.esri.arcgis.carto.IMapServerHyperlinks
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

computeScale

public double computeScale(IMapDescription mapDesc,
                           IImageDisplay mapDisplay)
                    throws java.io.IOException,
                           AutomationException
Computes the scale of the specified map, at the given map extent, for an image with the given size.

Specified by:
computeScale in interface IMapServer
Specified by:
computeScale in interface IMapServer2
Specified by:
computeScale in interface IMapServer3
Parameters:
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
mapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (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,
                              int units)
                       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 IMapServer
Specified by:
computeDistance in interface IMapServer2
Specified by:
computeDistance in interface IMapServer3
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)
units - A com.esri.arcgis.system.esriUnits constant (in)
Returns:
The distance
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toMapPoints

public IPointCollection toMapPoints(IMapDescription mapDescription,
                                    IImageDisplay mapDisplay,
                                    ILongArray screenXValues,
                                    ILongArray screenYValues)
                             throws java.io.IOException,
                                    AutomationException
Converts a screen location to a map coordinate.

Specified by:
toMapPoints in interface IMapServer
Specified by:
toMapPoints in interface IMapServer2
Specified by:
toMapPoints in interface IMapServer3
Parameters:
mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)
mapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
screenXValues - A reference to a com.esri.arcgis.system.ILongArray (in)
screenYValues - A reference to a com.esri.arcgis.system.ILongArray (in)
Returns:
A reference to a com.esri.arcgis.geometry.IPointCollection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fromMapPoints

public void fromMapPoints(IMapDescription mapDescription,
                          IImageDisplay mapDisplay,
                          IPointCollection mapPoints,
                          ILongArray[] screenXValues,
                          ILongArray[] screenYValues)
                   throws java.io.IOException,
                          AutomationException
Converts a map coordinate to a screen location.

Specified by:
fromMapPoints in interface IMapServer
Specified by:
fromMapPoints in interface IMapServer2
Specified by:
fromMapPoints in interface IMapServer3
Parameters:
mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)
mapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
mapPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)
screenXValues - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)
screenYValues - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendInfo

public IMapServerLegendInfos getLegendInfo(java.lang.String mapName,
                                           ILongArray layerIds,
                                           IMapServerLegendPatch patch,
                                           IImageType imgType)
                                    throws java.io.IOException,
                                           AutomationException
Returns a collection of Map Server Legend Info objects for the specified layers. If layerIDs is Nothing/Null or empty, legend information for all layers is returned.

Specified by:
getLegendInfo in interface IMapServer
Specified by:
getLegendInfo in interface IMapServer2
Specified by:
getLegendInfo in interface IMapServer3
Parameters:
mapName - The mapName (in)
layerIds - A reference to a com.esri.arcgis.system.ILongArray (in)
patch - A reference to a com.esri.arcgis.carto.IMapServerLegendPatch (in)
imgType - A reference to a com.esri.arcgis.carto.IImageType (in)
Returns:
A reference to a com.esri.arcgis.carto.IMapServerLegendInfos
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSQLSyntaxInfo

public ISQLSyntaxInfo getSQLSyntaxInfo(java.lang.String mapName,
                                       int layerID)
                                throws java.io.IOException,
                                       AutomationException
Returns the SQL syntax information for the specified layer.

Specified by:
getSQLSyntaxInfo in interface IMapServer
Specified by:
getSQLSyntaxInfo in interface IMapServer2
Specified by:
getSQLSyntaxInfo in interface IMapServer3
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
Returns:
A reference to a com.esri.arcgis.carto.ISQLSyntaxInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSupportedImageReturnTypes

public int getSupportedImageReturnTypes()
                                 throws java.io.IOException,
                                        AutomationException
The supported image return types for the map server. A value of esriImageReturnMimeData means that only MIME data is supported. Otherwise, either MIME data or URLs are supported.

Specified by:
getSupportedImageReturnTypes in interface IMapServer
Specified by:
getSupportedImageReturnTypes in interface IMapServer2
Specified by:
getSupportedImageReturnTypes in interface IMapServer3
Returns:
A com.esri.arcgis.carto.esriImageReturnType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapTileEx

public byte[] getMapTileEx(java.lang.String mapName,
                           int level,
                           int row,
                           int column,
                           int cacheFormat)
                    throws java.io.IOException,
                           AutomationException
Gets a tile for a given tile location from a given map.

Specified by:
getMapTileEx in interface ITiledMapServer2
Parameters:
mapName - The mapName (in)
level - The level (in)
row - The row (in)
column - The column (in)
cacheFormat - The cacheFormat (in)
Returns:
An unsigned byte
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerTileEx

public byte[] getLayerTileEx(java.lang.String mapName,
                             int layerID,
                             int level,
                             int row,
                             int column,
                             int cacheFormat)
                      throws java.io.IOException,
                             AutomationException
Gets a tile for a given tile location from a given layer.

Specified by:
getLayerTileEx in interface ITiledMapServer2
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
level - The level (in)
row - The row (in)
column - The column (in)
cacheFormat - The cacheFormat (in)
Returns:
An unsigned byte
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTileImageInfo

public ITileImageInfo getTileImageInfo(java.lang.String mapName)
                                throws java.io.IOException,
                                       AutomationException
Gets the cache tile image information for a given map.

Specified by:
getTileImageInfo in interface ITiledMapServer2
Parameters:
mapName - The mapName (in)
Returns:
A reference to a com.esri.arcgis.carto.ITileImageInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheDescriptionInfo

public ICacheDescriptionInfo getCacheDescriptionInfo(java.lang.String mapName)
                                              throws java.io.IOException,
                                                     AutomationException
Gets the cache description information for a given map.

Specified by:
getCacheDescriptionInfo in interface ITiledMapServer2
Parameters:
mapName - The mapName (in)
Returns:
A reference to a com.esri.arcgis.carto.ICacheDescriptionInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheControlInfo

public ICacheControlInfo getCacheControlInfo(java.lang.String mapName)
                                      throws java.io.IOException,
                                             AutomationException
Gets the cache description information for a given map.

Specified by:
getCacheControlInfo in interface ITiledMapServer2
Parameters:
mapName - The mapName (in)
Returns:
A reference to a com.esri.arcgis.carto.ICacheControlInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFixedScaleMap

public boolean isFixedScaleMap(java.lang.String mapName)
                        throws java.io.IOException,
                               AutomationException
Indicates if a given map is a fixed scale map.

Specified by:
isFixedScaleMap in interface ITiledMapServer
Parameters:
mapName - The mapName (in)
Returns:
The pIsFixedScaleMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasSingleFusedMapCache

public boolean hasSingleFusedMapCache(java.lang.String mapName)
                               throws java.io.IOException,
                                      AutomationException
Indicates if a given map has a single fused map tile cache.

Specified by:
hasSingleFusedMapCache in interface ITiledMapServer
Parameters:
mapName - The mapName (in)
Returns:
The pHasCache
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTileCacheInfo

public ITileCacheInfo getTileCacheInfo(java.lang.String mapName)
                                throws java.io.IOException,
                                       AutomationException
Gets the cache configuration for a given map.

Specified by:
getTileCacheInfo in interface ITiledMapServer
Parameters:
mapName - The mapName (in)
Returns:
A reference to a com.esri.arcgis.carto.ITileCacheInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapTile

public byte[] getMapTile(java.lang.String mapName,
                         int level,
                         int row,
                         int column)
                  throws java.io.IOException,
                         AutomationException
Gets a tile for a given tile location from a given map.

Specified by:
getMapTile in interface ITiledMapServer
Parameters:
mapName - The mapName (in)
level - The level (in)
row - The row (in)
column - The column (in)
Returns:
An unsigned byte
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasLayerCache

public boolean hasLayerCache(java.lang.String mapName,
                             int layerID)
                      throws java.io.IOException,
                             AutomationException
Indicates if a given layer has a single tile cache.

Specified by:
hasLayerCache in interface ITiledMapServer
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
Returns:
The pHasCache
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerTile

public byte[] getLayerTile(java.lang.String mapName,
                           int layerID,
                           int level,
                           int row,
                           int column)
                    throws java.io.IOException,
                           AutomationException
Gets a tile for a given tile location from a given layer.

Specified by:
getLayerTile in interface ITiledMapServer
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
level - The level (in)
row - The row (in)
column - The column (in)
Returns:
An unsigned byte
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVirtualCacheDirectory

public java.lang.String getVirtualCacheDirectory(java.lang.String mapName,
                                                 int layerID)
                                          throws java.io.IOException,
                                                 AutomationException
Gets the virtual cache directory for a given layer within a map.

Specified by:
getVirtualCacheDirectory in interface ITiledMapServer
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
Returns:
The pURL
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheName

public java.lang.String getCacheName(java.lang.String mapName,
                                     int layerID)
                              throws java.io.IOException,
                                     AutomationException
Gets the cache name for a given layer within a map.

Specified by:
getCacheName in interface ITiledMapServer
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
Returns:
The pURL
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheStorageInfo

public ICacheStorageInfo getCacheStorageInfo(java.lang.String mapName)
                                      throws java.io.IOException,
                                             AutomationException
Gets the cache storage information.

Specified by:
getCacheStorageInfo in interface ITiledMapServer3
Parameters:
mapName - The mapName (in)
Returns:
A reference to a com.esri.arcgis.carto.ICacheStorageInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

construct

public void construct(IPropertySet props)
               throws java.io.IOException,
                      AutomationException
Two phase object construction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

handleBinaryRequest

public byte[] handleBinaryRequest(byte[] request)
                           throws java.io.IOException,
                                  AutomationException
Handles a binary request.

Specified by:
handleBinaryRequest in interface IRequestHandler
Parameters:
request - An unsigned byte (in)
Returns:
An unsigned byte
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

handleStringRequest

public java.lang.String handleStringRequest(java.lang.String capabilities,
                                            java.lang.String request)
                                     throws java.io.IOException,
                                            AutomationException
Handles a SOAP string request.

Specified by:
handleStringRequest in interface IRequestHandler
Parameters:
capabilities - The capabilities (in)
request - The request (in)
Returns:
The response
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest2

public byte[] handleBinaryRequest2(java.lang.String capabilities,
                                   byte[] request)
                            throws java.io.IOException,
                                   AutomationException
Handles a binary request with explicit capabilities.

Specified by:
handleBinaryRequest2 in interface IRequestHandler2
Parameters:
capabilities - The capabilities (in)
request - An unsigned byte (in)
Returns:
An unsigned byte
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 (active data frame).

Specified by:
getMap in interface IMapServerObjects
Specified by:
getMap in interface IMapServerObjects2
Specified by:
getMap in interface IMapServerObjects3
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 (active data frame) will be assumed.

Specified by:
getLayer in interface IMapServerObjects
Specified by:
getLayer in interface IMapServerObjects2
Specified by:
getLayer in interface IMapServerObjects3
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 IMapServerObjects
Specified by:
getPageLayout in interface IMapServerObjects2
Specified by:
getPageLayout in interface IMapServerObjects3
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.

getThumbnail

public Picture getThumbnail()
                     throws java.io.IOException,
                            AutomationException
The thumbnail stored in the map document.

Specified by:
getThumbnail in interface IMapServerObjects
Specified by:
getThumbnail in interface IMapServerObjects2
Specified by:
getThumbnail in interface IMapServerObjects3
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.

refreshServerObjects

public void refreshServerObjects()
                          throws java.io.IOException,
                                 AutomationException
Updates the server info based on the current state of the underlying fine-grained objects.

Specified by:
refreshServerObjects in interface IMapServerObjects
Specified by:
refreshServerObjects in interface IMapServerObjects2
Specified by:
refreshServerObjects in interface IMapServerObjects3
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applyMapDescription

public void applyMapDescription(IMapDescription mapDescription,
                                IImageDisplay mapDisplay)
                         throws java.io.IOException,
                                AutomationException
Applies the current state of the map description to the map server object.

Specified by:
applyMapDescription in interface IMapServerObjects
Specified by:
applyMapDescription in interface IMapServerObjects2
Specified by:
applyMapDescription in interface IMapServerObjects3
Parameters:
mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)
mapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerID

public int getLayerID(java.lang.String mapName,
                      ILayer pLayer)
               throws java.io.IOException,
                      AutomationException
The layer specified by the map name and layer ID. If the mapName is blank, the default map (active data frame) will be assumed.

Specified by:
getLayerID in interface IMapServerObjects2
Specified by:
getLayerID in interface IMapServerObjects3
Parameters:
mapName - The mapName (in)
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The iD
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStandaloneTableID

public int getStandaloneTableID(java.lang.String mapName,
                                ITable pTable)
                         throws java.io.IOException,
                                AutomationException
The layer specified by the map name and standalone table ID. If the mapName is blank, the default map (active data frame) will be assumed.

Specified by:
getStandaloneTableID in interface IMapServerObjects3
Parameters:
mapName - The mapName (in)
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Returns:
The iD
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStandaloneTable

public ITable getStandaloneTable(java.lang.String mapName,
                                 int standaloneTableID)
                          throws java.io.IOException,
                                 AutomationException
The table specified by the map name and table ID. If the mapName is blank, the default map (active data frame) will be assumed.

Specified by:
getStandaloneTable in interface IMapServerObjects3
Parameters:
mapName - The mapName (in)
standaloneTableID - The standaloneTableID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
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
Returns the value of a given feature as a string.

Specified by:
getFeatureValue in interface IMapServerData
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.

getFeature

public IFeature getFeature(java.lang.String mapName,
                           int layerID,
                           int featureId)
                    throws java.io.IOException,
                           AutomationException
Returns a feature, given the feature ID and layer.

Specified by:
getFeature in interface IMapServerData
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
featureId - The featureId (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultPageDescription

public IPageDescription getDefaultPageDescription()
                                           throws java.io.IOException,
                                                  AutomationException
The default page settings.

Specified by:
getDefaultPageDescription in interface IMapServerLayout
Returns:
A reference to a com.esri.arcgis.carto.IPageDescription
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportLayout

public ILayoutImage exportLayout(IPageDescription pageDesc,
                                 IImageDescription imageDesc)
                          throws java.io.IOException,
                                 AutomationException
Generates an image of the layout, based on the given page description object, and writes the image to a specified file on disk. Supported file types are: 'bmp', 'jpg', 'tif', 'png'/'png8', 'png24', 'emf', 'ps', 'pdf', 'ai', 'gif', and 'svg'/'svgz'.

Specified by:
exportLayout in interface IMapServerLayout
Parameters:
pageDesc - A reference to a com.esri.arcgis.carto.IPageDescription (in)
imageDesc - A reference to a com.esri.arcgis.carto.IImageDescription (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayoutImage
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportLegend

public IImageResult exportLegend(ILegend legend,
                                 IMapDescription mapDesc,
                                 IImageDisplay pMapDisplay,
                                 IColor backgroundColor,
                                 IImageDescription imageDesc)
                          throws java.io.IOException,
                                 AutomationException
Exports a legend to an image file. The client can create the legend object and set its desired properties appropriately. If legend is Nothing/Null, a default legend will be generated.

Specified by:
exportLegend in interface IMapServerLayout
Parameters:
legend - A reference to a com.esri.arcgis.carto.ILegend (in)
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
pMapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)
imageDesc - A reference to a com.esri.arcgis.carto.IImageDescription (in)
Returns:
A reference to a com.esri.arcgis.carto.IImageResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportScaleBar

public IImageResult exportScaleBar(IScaleBar scalebar,
                                   IMapDescription mapDesc,
                                   IImageDisplay pMapDisplay,
                                   IColor backgroundColor,
                                   IImageDescription imageDesc)
                            throws java.io.IOException,
                                   AutomationException
Exports a scale bar to an image file. The client can create the scaleBar object and set its desired properties appropriately. If scaleBar is Nothing/Null, a default scale bar will be generated.

Specified by:
exportScaleBar in interface IMapServer2
Specified by:
exportScaleBar in interface IMapServer3
Specified by:
exportScaleBar in interface IMapServerLayout
Parameters:
scalebar - A reference to a com.esri.arcgis.carto.IScaleBar (in)
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
pMapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)
imageDesc - A reference to a com.esri.arcgis.carto.IImageDescription (in)
Returns:
A reference to a com.esri.arcgis.carto.IImageResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportNorthArrow

public IImageResult exportNorthArrow(INorthArrow arrow,
                                     IMapDescription mapDesc,
                                     IColor backgroundColor,
                                     IImageDescription imageDesc)
                              throws java.io.IOException,
                                     AutomationException
Exports a north arrow to an image file. The client can create the arrow object and set its desired properties appropriately. If arrow is Nothing/Null, a default north arrow will be generated.

Specified by:
exportNorthArrow in interface IMapServerLayout
Parameters:
arrow - A reference to a com.esri.arcgis.carto.INorthArrow (in)
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)
imageDesc - A reference to a com.esri.arcgis.carto.IImageDescription (in)
Returns:
A reference to a com.esri.arcgis.carto.IImageResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toPagePoints

public IPointCollection toPagePoints(IEnvelope pageExtent,
                                     IImageDisplay pageDisplay,
                                     ILongArray screenXValues,
                                     ILongArray screenYValues)
                              throws java.io.IOException,
                                     AutomationException
Converts a screen location to a page coordinate.

Specified by:
toPagePoints in interface IMapServerLayout
Parameters:
pageExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
pageDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
screenXValues - A reference to a com.esri.arcgis.system.ILongArray (in)
screenYValues - A reference to a com.esri.arcgis.system.ILongArray (in)
Returns:
A reference to a com.esri.arcgis.geometry.IPointCollection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fromPagePoints

public void fromPagePoints(IEnvelope pageExtent,
                           IImageDisplay pageDisplay,
                           IPointCollection pagePoints,
                           ILongArray[] screenXValues,
                           ILongArray[] screenYValues)
                    throws java.io.IOException,
                           AutomationException
Converts a page coordinate to a screen location.

Specified by:
fromPagePoints in interface IMapServerLayout
Parameters:
pageExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
pageDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
pagePoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)
screenXValues - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)
screenYValues - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connect

public void connect(java.lang.String filePath)
             throws java.io.IOException,
                    AutomationException
Initializes the map server with an mxd or pmf file stored at the specified path. The path must be accessible to the server machine.

Specified by:
connect in interface IMapServerInit
Parameters:
filePath - The filePath (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 Connect(). 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 IMapServerInit
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 IMapServerInit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPhysicalOutputDirectory

public void setPhysicalOutputDirectory(java.lang.String dirPath)
                                throws java.io.IOException,
                                       AutomationException
The physical directory for output files.

Specified by:
setPhysicalOutputDirectory in interface IMapServerInit
Parameters:
dirPath - The dirPath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPhysicalOutputDirectory

public java.lang.String getPhysicalOutputDirectory()
                                            throws java.io.IOException,
                                                   AutomationException
The physical directory for output files.

Specified by:
getPhysicalOutputDirectory in interface IMapServerInit
Returns:
The dirPath
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVirtualOutputDirectory

public void setVirtualOutputDirectory(java.lang.String dirPath)
                               throws java.io.IOException,
                                      AutomationException
The virtual directory for output files.

Specified by:
setVirtualOutputDirectory in interface IMapServerInit
Parameters:
dirPath - The dirPath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVirtualOutputDirectory

public java.lang.String getVirtualOutputDirectory()
                                           throws java.io.IOException,
                                                  AutomationException
The virtual directory for output files.

Specified by:
getVirtualOutputDirectory in interface IMapServerInit
Returns:
The dirPath
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilePath

public java.lang.String getFilePath()
                             throws java.io.IOException,
                                    AutomationException
The map document path.

Specified by:
getFilePath in interface IMapServerInit
Returns:
The filePath
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxRecordCount

public int getMaxRecordCount()
                      throws java.io.IOException,
                             AutomationException
The maximum number of records returned for query results (Identify, Find, QueryFeatureData, and QueryHyperlinks).

Specified by:
getMaxRecordCount in interface IMapServerInit
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxRecordCount

public void setMaxRecordCount(int count)
                       throws java.io.IOException,
                              AutomationException
The maximum number of records returned for query results (Identify, Find, QueryFeatureData, and QueryHyperlinks).

Specified by:
setMaxRecordCount in interface IMapServerInit
Parameters:
count - The count (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxBufferCount

public int getMaxBufferCount()
                      throws java.io.IOException,
                             AutomationException
The maximum number of records buffered on the server for display.

Specified by:
getMaxBufferCount in interface IMapServerInit
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxBufferCount

public void setMaxBufferCount(int count)
                       throws java.io.IOException,
                              AutomationException
The maximum number of records buffered on the server for display.

Specified by:
setMaxBufferCount in interface IMapServerInit
Parameters:
count - The count (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxImageWidth

public int getMaxImageWidth()
                     throws java.io.IOException,
                            AutomationException
The maximum width in pixels of an image request.

Specified by:
getMaxImageWidth in interface IMapServerInit
Returns:
The width
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxImageWidth

public void setMaxImageWidth(int width)
                      throws java.io.IOException,
                             AutomationException
The maximum width in pixels of an image request.

Specified by:
setMaxImageWidth in interface IMapServerInit
Parameters:
width - The width (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxImageHeight

public int getMaxImageHeight()
                      throws java.io.IOException,
                             AutomationException
The maximum height in pixels of an image request.

Specified by:
getMaxImageHeight in interface IMapServerInit
Returns:
The height
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxImageHeight

public void setMaxImageHeight(int height)
                       throws java.io.IOException,
                              AutomationException
The maximum height in pixels of an image request.

Specified by:
setMaxImageHeight in interface IMapServerInit
Parameters:
height - The height (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPhysicalCacheDirectory

public void setPhysicalCacheDirectory(java.lang.String pCacheDir)
                               throws java.io.IOException,
                                      AutomationException
The physical directory for cache files.

Specified by:
setPhysicalCacheDirectory in interface IMapServerInit2
Parameters:
pCacheDir - The pCacheDir (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPhysicalCacheDirectory

public java.lang.String getPhysicalCacheDirectory()
                                           throws java.io.IOException,
                                                  AutomationException
The physical directory for cache files.

Specified by:
getPhysicalCacheDirectory in interface IMapServerInit2
Returns:
The pCacheDir
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVirtualCacheDirectory

public void setVirtualCacheDirectory(java.lang.String pVirtualCacheDir)
                              throws java.io.IOException,
                                     AutomationException
The virtual directory for cache files.

Specified by:
setVirtualCacheDirectory in interface IMapServerInit2
Parameters:
pVirtualCacheDir - The pVirtualCacheDir (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVirtualCacheDirectory

public java.lang.String getVirtualCacheDirectory()
                                          throws java.io.IOException,
                                                 AutomationException
The virtual directory for cache files.

Specified by:
getVirtualCacheDirectory in interface IMapServerInit2
Returns:
The pVirtualCacheDir
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSOMCacheDirectory

public void setSOMCacheDirectory(java.lang.String pCacheDir)
                          throws java.io.IOException,
                                 AutomationException
The parent directory for cache files.

Specified by:
setSOMCacheDirectory in interface IMapServerInit2
Parameters:
pCacheDir - The pCacheDir (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSOMCacheDirectory

public java.lang.String getSOMCacheDirectory()
                                      throws java.io.IOException,
                                             AutomationException
The parent directory for cache files.

Specified by:
getSOMCacheDirectory in interface IMapServerInit2
Returns:
The pCacheDir
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSOMVirtualCacheDirectory

public java.lang.String getSOMVirtualCacheDirectory()
                                             throws java.io.IOException,
                                                    AutomationException
The parent virtual directory for cache files.

Specified by:
getSOMVirtualCacheDirectory in interface IMapServerInit2
Returns:
The pParentVirtualCacheDir
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activate

public void activate()
              throws java.io.IOException,
                     AutomationException
Activates the object.

Specified by:
activate in interface IObjectActivate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException
Deactivates the object.

Specified by:
deactivate in interface IObjectActivate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public void update(IPropertySet props)
            throws java.io.IOException,
                   AutomationException
Updates object's properties.

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

initLogging

public void initLogging(ILog log)
                 throws java.io.IOException,
                        AutomationException
Initializes an object with a log.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
initLogging in interface ILogSupport
Parameters:
log - A reference to a com.esri.arcgis.system.ILog (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConfigurationName

public java.lang.String getConfigurationName()
                                      throws java.io.IOException,
                                             AutomationException
Name of the server object configuration that defines the server object.

Specified by:
getConfigurationName in interface IServerObject
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTypeName

public java.lang.String getTypeName()
                             throws java.io.IOException,
                                    AutomationException
Type of the server object (MapServer or GeocodeServer).

Specified by:
getTypeName in interface IServerObject
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findExtensionByCLSID

public IServerObjectExtension findExtensionByCLSID(java.lang.String cLSID)
                                            throws java.io.IOException,
                                                   AutomationException
Returns a server object extension found using a string representation of its class ID.

Specified by:
findExtensionByCLSID in interface IServerObjectExtensionManager
Parameters:
cLSID - The cLSID (in)
Returns:
A reference to a com.esri.arcgis.server.IServerObjectExtension
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findExtensionByTypeName

public IServerObjectExtension findExtensionByTypeName(java.lang.String name)
                                               throws java.io.IOException,
                                                      AutomationException
Returns a server object extension found using its type name.

Specified by:
findExtensionByTypeName in interface IServerObjectExtensionManager
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.server.IServerObjectExtension
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryFeatureCount2

public int queryFeatureCount2(java.lang.String mapName,
                              ILayerDescription pLayerDescription,
                              IQueryFilter filter)
                       throws java.io.IOException,
                              AutomationException
Returns the count of the features that meet the query filter selection criteria for the specified layer.

Specified by:
queryFeatureCount2 in interface IMapServer2
Specified by:
queryFeatureCount2 in interface IMapServer3
Parameters:
mapName - The mapName (in)
pLayerDescription - A reference to a com.esri.arcgis.carto.ILayerDescription (in)
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryFeatureIDs2

public IFIDSet queryFeatureIDs2(java.lang.String mapName,
                                ILayerDescription pLayerDesciscription,
                                IQueryFilter filter)
                         throws java.io.IOException,
                                AutomationException
Returns the IDs of the features that meet the query filter selection criteria for the specified layer.

Specified by:
queryFeatureIDs2 in interface IMapServer2
Specified by:
queryFeatureIDs2 in interface IMapServer3
Parameters:
mapName - The mapName (in)
pLayerDesciscription - A reference to a com.esri.arcgis.carto.ILayerDescription (in)
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFIDSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryFeatureData2

public IQueryResult queryFeatureData2(java.lang.String mapName,
                                      ILayerDescription pLayerDesciscription,
                                      IQueryFilter filter,
                                      IQueryResultOptions options)
                               throws java.io.IOException,
                                      AutomationException
Returns a record set of features that meet the query filter selection criteria for the specified layer.

Specified by:
queryFeatureData2 in interface IMapServer2
Specified by:
queryFeatureData2 in interface IMapServer3
Parameters:
mapName - The mapName (in)
pLayerDesciscription - A reference to a com.esri.arcgis.carto.ILayerDescription (in)
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
options - A reference to a com.esri.arcgis.carto.IQueryResultOptions (in)
Returns:
A reference to a com.esri.arcgis.carto.IQueryResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServiceConfigurationInfo

public IPropertySet getServiceConfigurationInfo()
                                         throws java.io.IOException,
                                                AutomationException
A set of name-value pairs for properties set for the MapServer Service Configuration Restrictions.

Specified by:
getServiceConfigurationInfo in interface IMapServer2
Specified by:
getServiceConfigurationInfo in interface IMapServer3
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryData

public IQueryResult queryData(java.lang.String mapName,
                              IMapTableDescription pMapTableDescription,
                              IQueryFilter filter,
                              IQueryResultOptions options)
                       throws java.io.IOException,
                              AutomationException
Returns a record set of rows that meet the query filter selection criteria for the specified table.

Specified by:
queryData in interface IMapServer3
Parameters:
mapName - The mapName (in)
pMapTableDescription - A reference to a com.esri.arcgis.carto.IMapTableDescription (in)
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
options - A reference to a com.esri.arcgis.carto.IQueryResultOptions (in)
Returns:
A reference to a com.esri.arcgis.carto.IQueryResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryRowCount

public int queryRowCount(java.lang.String mapName,
                         IMapTableDescription pTableDescription,
                         IQueryFilter pFilter)
                  throws java.io.IOException,
                         AutomationException
Returns the count of the rows that meet the query filter selection criteria for the specified table.

Specified by:
queryRowCount in interface IMapServer3
Parameters:
mapName - The mapName (in)
pTableDescription - A reference to a com.esri.arcgis.carto.IMapTableDescription (in)
pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
The pCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryRowIDs

public ILongArray queryRowIDs(java.lang.String mapName,
                              IMapTableDescription pTableDescription,
                              IQueryFilter pFilter)
                       throws java.io.IOException,
                              AutomationException
Returns the IDs of the rows that meet the query filter selection criteria for the specified table.

Specified by:
queryRowIDs in interface IMapServer3
Parameters:
mapName - The mapName (in)
pTableDescription - A reference to a com.esri.arcgis.carto.IMapTableDescription (in)
pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryRelatedRecords

public IQueryResult queryRelatedRecords(java.lang.String mapName,
                                        int sourceTable,
                                        IFIDSet pFIDs,
                                        IRelateDescription relateDescription)
                                 throws java.io.IOException,
                                        AutomationException
Returns the IDs of the rows that meet the query filter selection criteria for the specified table.

Specified by:
queryRelatedRecords in interface IMapServer3
Parameters:
mapName - The mapName (in)
sourceTable - The sourceTable (in)
pFIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)
relateDescription - A reference to a com.esri.arcgis.carto.IRelateDescription (in)
Returns:
A reference to a com.esri.arcgis.carto.IQueryResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryRasterValue

public IImageResults queryRasterValue(java.lang.String mapName,
                                      int sourceTableID,
                                      ILongArray rowIDs,
                                      java.lang.String fieldName,
                                      IImageType rasterValueType)
                               throws java.io.IOException,
                                      AutomationException
Returns the Raster content that meet the selection criteria for the specified table.

Specified by:
queryRasterValue in interface IMapServer3
Parameters:
mapName - The mapName (in)
sourceTableID - The sourceTableID (in)
rowIDs - A reference to a com.esri.arcgis.system.ILongArray (in)
fieldName - The fieldName (in)
rasterValueType - A reference to a com.esri.arcgis.carto.IImageType (in)
Returns:
A reference to a com.esri.arcgis.carto.IImageResults
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryAttachmentInfos

public IAttachmentInfoArray queryAttachmentInfos(java.lang.String mapName,
                                                 int tableID,
                                                 ILongArray rowIDs)
                                          throws java.io.IOException,
                                                 AutomationException
Returns the attachment info that describe the attachments for the given features/ rows.

Specified by:
queryAttachmentInfos in interface IMapServer3
Parameters:
mapName - The mapName (in)
tableID - The tableID (in)
rowIDs - A reference to a com.esri.arcgis.system.ILongArray (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IAttachmentInfoArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryAttachmentData

public IAttachmentDataArray queryAttachmentData(java.lang.String mapName,
                                                int tableID,
                                                ILongArray attachmentIDs,
                                                int transportType)
                                         throws java.io.IOException,
                                                AutomationException
Returns the attachment data for the given features/ rows.

Specified by:
queryAttachmentData in interface IMapServer3
Parameters:
mapName - The mapName (in)
tableID - The tableID (in)
attachmentIDs - A reference to a com.esri.arcgis.system.ILongArray (in)
transportType - A com.esri.arcgis.system.esriTransportType constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IAttachmentDataArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryHTMLPopups

public IStringArray queryHTMLPopups(java.lang.String mapName,
                                    int tableID,
                                    ILongArray pRowIDs)
                             throws java.io.IOException,
                                    AutomationException
Returns the html as text that can be used in popups.

Specified by:
queryHTMLPopups in interface IMapServer3
Parameters:
mapName - The mapName (in)
tableID - The tableID (in)
pRowIDs - A reference to a com.esri.arcgis.system.ILongArray (in)
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultLayerDrawingDescriptions

public ILayerDrawingDescriptions getDefaultLayerDrawingDescriptions(java.lang.String mapName,
                                                                    ILongArray pLayerIDs,
                                                                    IServerSymbolOutputOptions outputOptions)
                                                             throws java.io.IOException,
                                                                    AutomationException
Get Layer Drawing Description

Specified by:
getDefaultLayerDrawingDescriptions in interface IMapServer3
Parameters:
mapName - The mapName (in)
pLayerIDs - A reference to a com.esri.arcgis.system.ILongArray (in)
outputOptions - A reference to a com.esri.arcgis.carto.IServerSymbolOutputOptions (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayerDrawingDescriptions
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapTableSubtypeInfos

public IMapTableSubtypeInfos getMapTableSubtypeInfos(java.lang.String mapName,
                                                     ILongArray pTableIDs)
                                              throws java.io.IOException,
                                                     AutomationException
Returns the MapTableSubtypeInfos in the current map.

Specified by:
getMapTableSubtypeInfos in interface IMapServer3
Parameters:
mapName - The mapName (in)
pTableIDs - A reference to a com.esri.arcgis.system.ILongArray (in)
Returns:
A reference to a com.esri.arcgis.carto.IMapTableSubtypeInfos
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onAdd

public IPropertySet onAdd(IPropertySet pProps)
                   throws java.io.IOException,
                          AutomationException
Is called when the configuration is added.

Specified by:
onAdd in interface IServerObjectConfigurationManager
Parameters:
pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onRemove

public void onRemove()
              throws java.io.IOException,
                     AutomationException
Is called when the configuration is removed.

Specified by:
onRemove in interface IServerObjectConfigurationManager
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onStart

public void onStart(IServerObjectAdmin pAdmin,
                    IPropertySet pProps)
             throws java.io.IOException,
                    AutomationException
Is called when the configuration is started.

Specified by:
onStart in interface IServerObjectConfigurationManager2
Parameters:
pAdmin - A reference to a com.esri.arcgis.server.IServerObjectAdmin (in)
pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onStop

public void onStop(IServerObjectAdmin pAdmin,
                   IPropertySet pProps)
            throws java.io.IOException,
                   AutomationException
Is called when the configuration is stopped.

Specified by:
onStop in interface IServerObjectConfigurationManager2
Parameters:
pAdmin - A reference to a com.esri.arcgis.server.IServerObjectAdmin (in)
pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onRemoveEx

public void onRemoveEx(IServerObjectAdmin pAdmin,
                       IPropertySet props)
                throws java.io.IOException,
                       AutomationException
Is called when the configuration is removed.

Specified by:
onRemoveEx in interface IServerObjectConfigurationManager2
Parameters:
pAdmin - A reference to a com.esri.arcgis.server.IServerObjectAdmin (in)
props - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

beforeStart

public void beforeStart(IServerObjectAdmin pAdmin,
                        IPropertySet props)
                 throws java.io.IOException,
                        AutomationException
Is called before the configuration is started.

Specified by:
beforeStart in interface IServerObjectConfigurationManager2
Parameters:
pAdmin - A reference to a com.esri.arcgis.server.IServerObjectAdmin (in)
props - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

beforeStop

public void beforeStop(IServerObjectAdmin pAdmin,
                       IPropertySet props)
                throws java.io.IOException,
                       AutomationException
Is called before the configuration is stopped.

Specified by:
beforeStop in interface IServerObjectConfigurationManager2
Parameters:
pAdmin - A reference to a com.esri.arcgis.server.IServerObjectAdmin (in)
props - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validate

public void validate(IPropertySet props)
              throws java.io.IOException,
                     AutomationException
Validates an object.

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

getDataSource

public java.lang.Object getDataSource(java.lang.String mapName,
                                      int layerID)
                               throws java.io.IOException,
                                      AutomationException
Get Data Source

Specified by:
getDataSource in interface IMapServerDataAccess
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayDataSource

public java.lang.Object getDisplayDataSource(java.lang.String mapName,
                                             int layerOrTableID)
                                      throws java.io.IOException,
                                             AutomationException
Get Display Data Source

Specified by:
getDisplayDataSource in interface IMapServerDataAccess
Parameters:
mapName - The mapName (in)
layerOrTableID - The layerOrTableID (in)
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

handleRESTRequest

public byte[] handleRESTRequest(java.lang.String capabilities,
                                java.lang.String resourceName,
                                java.lang.String operationName,
                                java.lang.String operationInput,
                                java.lang.String outputFormat,
                                java.lang.String requestProperties,
                                java.lang.String[] responseProperties)
                         throws java.io.IOException,
                                AutomationException
Handles REST requests for SOE.

This method is invoked by ArcGIS Server's REST handler, which intercepts client's request (in URL form), parses it and passes it on to this method in form of parameter values.

The REST SOE developer must add logic to use these parameter values to determine which resource/operation is being requested and accordingly handle these requests and generate responses in the output format indicated by the "outputFormat" parameter. For more information on developing REST SOEs, please consult the Java ArcObjects Developer Guide.

Developer doc: Developing extensions > Server Object Extensions > SOE Web Services > REST Web Services > Developing SOE REST Web Services
Samples: Samples > Server Object Extensions section

Specified by:
handleRESTRequest in interface IRESTRequestHandler
Parameters:
capabilities - The capabilities supported by the SOE. An admin can choose which capabilities are enabled on a particular SOE (in ArcGIS Manager or ArcCatalog), based on certain criteria such as security roles. This list of allowed capabilities is then sent to this method, at runtime, as a comma separated list. (in)
resourceName - Name of the resource being addressed. If empty, its assumed that root resource is being addressed. (in)
operationName - Name of the operation being invoked. If empty, description of resource is returned. (in)
operationInput - Input parameters, in form of comma separated list, to the operation specified by operationName parameter. (in)
outputFormat - OutputFormat of operation. Possible formats are JSON, HTML, AMF, etc. (in)
requestProperties - The requestProperties (in)
responseProperties - The responseProperties (out)
Returns:
Output generated by the SOE
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchema

public java.lang.String getSchema()
                           throws java.io.IOException,
                                  AutomationException
This method returns the resource hierarchy of a REST based SOE. This hierarchy is in JSON format as shown in the example below:

For an SOE that has a root resource (called "root") with one operation ("operation0"), and 2 sub-resources with one operation each ("operation1" and "operation2" respectively), the schema would look like: 


 {
   "name": "MyRESTSOE",
   "description": "My REST SOE with 3 resources and 1 operation each.",
   "isCollection": false,
   "operations": [
   {
      "name": "operation0",
      "parameters": ["param01"],
      "supportedOutputFormats": ["json"]
    }
 ],
 "resources": [
  {
      "name": "subresource1",
      "description": "Sub Resource 1",
      "isCollection": true,
      "operations": [
       {
          "name": "operation1",
          "parameters": ["param10", "param11"],
          "supportedOutputFormats": ["json"]
       }
    ]
  },
  {
      "name": "subresource2",
      "description": "Sub Resource 2",
      "isCollection": true,
      "operations": [
       {
          "name": "operation2",
          "parameters": ["param20", "param21"],
          "supportedOutputFormats": ["json"]
       }
    ]
  }
 ]
}

Specified by:
getSchema in interface IRESTRequestHandler
Returns:
resource hierarchy of REST SOE, as String
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD