com.esri.arcgis.carto

Interface IMapServer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IMapServerEx

All Known Implementing Classes:

IMapServerExProxy, IMapServerProxy, MapServer

public interface IMapServer
extends java.io.Serializable

COM Interface 'IMapServer'. Generated 9/24/2024 11:01:31 AM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description: 'Provides access to members for a MapService.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDc1ee7009_1027_4f5a_89ae_0e2cec6fcef4
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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.
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.
void	fromMapPoints(IMapDescription mapDescription, IImageDisplay mapDisplay, IPointCollection mapPoints, ILongArray[] screenXValues, ILongArray[] screenYValues) Converts a map coordinate to a screen location.
java.lang.String	getDefaultMapName() Name of the document's active map (data frame).
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.
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.
java.lang.String	getPhysicalCacheDirectory() The physical directory for cache files.
java.lang.String	getPhysicalOutputDirectory() The physical directory for output files.
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.
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.
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.
IPointCollection	toMapPoints(IMapDescription mapDescription, IImageDisplay mapDisplay, ILongArray screenXValues, ILongArray screenYValues) Converts a screen location to a map coordinate.

Field Detail

IIDc1ee7009_1027_4f5a_89ae_0e2cec6fcef4

static final int IIDc1ee7009_1027_4f5a_89ae_0e2cec6fcef4

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getDocumentInfo

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.

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

int getMapCount()
         throws java.io.IOException,
                AutomationException

The number of maps (data frames) in the document.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapName

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.

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

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

Name of the document's active map (data frame).

Returns:

The mapName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerInfo

IMapServerInfo getServerInfo(java.lang.String mapName)
                      throws java.io.IOException,
                             AutomationException

Returns information about a map (data frame).

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

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

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

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.

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

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.

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

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.

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

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.

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

IPointCollection toMapPoints(IMapDescription mapDescription,
                             IImageDisplay mapDisplay,
                             ILongArray screenXValues,
                             ILongArray screenYValues)
                      throws java.io.IOException,
                             AutomationException

Converts a screen location to a map coordinate.

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

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.

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

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.

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

ISQLSyntaxInfo getSQLSyntaxInfo(java.lang.String mapName,
                                int layerID)
                         throws java.io.IOException,
                                AutomationException

Returns the SQL syntax information for the specified layer.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

The map document path.

Returns:

The filePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPhysicalOutputDirectory

java.lang.String getPhysicalOutputDirectory()
                                     throws java.io.IOException,
                                            AutomationException

The physical directory for output files.

Returns:

The dirPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPhysicalCacheDirectory

java.lang.String getPhysicalCacheDirectory()
                                    throws java.io.IOException,
                                           AutomationException

The physical directory for cache files.

Returns:

The pCacheDir

Throws:

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

AutomationException - If the ArcObject component throws an exception.