com.esri.arcgis.carto

Class MapServer

java.lang.Object

com.esri.arcgis.carto.MapServer

All Implemented Interfaces:

IMapServer, IMapServerDataAccess, ITiledMapServer, ITiledMapServer2, ITiledMapServer3, com.esri.arcgis.interop.RemoteObjRef, IServerObject, 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, IObjectActivate, IObjectUpdate, ILogSupport, ISupportErrorInfo, IServerObject, IServerObjectExtensionManager, IObjectValidate, IMapServerDataAccess, IRESTRequestHandler

COM Class 'MapServer'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriCarto.tlb'

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, IIDc1ee7009_1027_4f5a_89ae_0e2cec6fcef4, 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.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.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

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
void	activate() Activates the object.
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	construct(IPropertySet props) Two phase object construction.
void	deactivate() Deactivates the object.
boolean	equals(java.lang.Object o) Compare this object with another
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.
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.
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
java.lang.String	getDefaultMapName() Name of the document's active map (data frame).
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).
java.lang.String	getFilePath() The map document path.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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(IMapDescription pMapDescription, IImageDisplay pImageDisplay, ILongArray layerIDs, IMapServerLegendPatch patch, IImageType imgType) Returns a collection of Map Server Legend Info objects for the specified layers.
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.
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.
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).
ISQLSyntaxInfo	getSQLSyntaxInfo(java.lang.String mapName, int layerID) Returns the SQL syntax information for the specified layer.
int	getSupportedImageReturnTypes() The supported image return types for the map server.
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(java.lang.String mapName, int layerID) Gets the virtual cache directory for a given layer within a map.
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.
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.
IRecordSet	queryDataStatistics(java.lang.String mapName, IMapTableDescription pTableDescription, IStatisticsRequest pRequest, IQueryFilter pQueryFilter) Calculates aggregate statistics for one or more fields on a table or layer.
IImageResults	queryRasterValue(java.lang.String mapName, IMapTableDescription pTableDescription, ILongArray rowIDs, java.lang.String fieldName, IImageType rasterValueType) Returns the Raster content that meet the selection criteria for the specified dynamic layer.
IQueryResult	queryRelatedRecords(java.lang.String mapName, IMapTableDescription pTableDescription, IFIDSet pFIDs, IRelateDescription relateDescription) Returns the IDs of the rows that meet the query filter selection criteria for the specified dynamic layer.
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	release() Release this COM object reference
IPointCollection	toMapPoints(IMapDescription mapDescription, IImageDisplay mapDisplay, ILongArray screenXValues, ILongArray screenYValues) Converts a screen location to a map 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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

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

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

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

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

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

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

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

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

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.

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

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

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

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

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(IMapDescription pMapDescription,
                                           IImageDisplay pImageDisplay,
                                           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

Parameters:

pMapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)

pImageDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (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

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

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.

queryDataStatistics

public IRecordSet queryDataStatistics(java.lang.String mapName,
                                      IMapTableDescription pTableDescription,
                                      IStatisticsRequest pRequest,
                                      IQueryFilter pQueryFilter)
                               throws java.io.IOException,
                                      AutomationException

Calculates aggregate statistics for one or more fields on a table or layer.

Specified by:

queryDataStatistics in interface IMapServer

Parameters:

mapName - The mapName (in)

pTableDescription - A reference to a com.esri.arcgis.carto.IMapTableDescription (in)

pRequest - A reference to a com.esri.arcgis.geodatabase.IStatisticsRequest (in)

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

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 IMapServer

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.

queryRelatedRecords

public IQueryResult queryRelatedRecords(java.lang.String mapName,
                                        IMapTableDescription pTableDescription,
                                        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 dynamic layer.

Specified by:

queryRelatedRecords in interface IMapServer

Parameters:

mapName - The mapName (in)

pTableDescription - A reference to a com.esri.arcgis.carto.IMapTableDescription (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.

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 IMapServer

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. Use QueryRowIDsEx instead of this for 64 bit OIDs.

Specified by:

queryRowIDs in interface IMapServer

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.

queryRasterValue

public IImageResults queryRasterValue(java.lang.String mapName,
                                      IMapTableDescription pTableDescription,
                                      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 dynamic layer. Use QueryRasterValueEx instead of this for 64 bit OIDs.

Specified by:

queryRasterValue in interface IMapServer

Parameters:

mapName - The mapName (in)

pTableDescription - A reference to a com.esri.arcgis.carto.IMapTableDescription (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.

getFilePath

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

The map document path.

Specified by:

getFilePath in interface IMapServer

Returns:

The filePath

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 IMapServer

Returns:

The dirPath

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 IMapServer

Returns:

The pCacheDir

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.

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.

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.