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
Interface IMapServer4

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IMapServer4Proxy, MapServerIP, MapServerLP
public interface IMapServer4
extends java.io.Serializable

COM Interface 'IMapServer4'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that serve maps.' 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
static java.lang.String IID
          Deprecated. Internal use only
static int IIDf1ec368e_d632_4f3f_a595_7742ec824e2b
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 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.
 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.
 void fromMapPoints(IMapDescription mapDescription, IImageDisplay mapDisplay, IPointCollection mapPoints, ILongArray[] screenXValues, ILongArray[] screenYValues)
          Converts a map coordinate to a screen location.
 IFeatureRenderer generateDataClasses(java.lang.String mapName, IMapTableDescription pTableDescription, IDataClassificationDef pDataClassificationDef)
          Returns the class breaks or unique values for the specified dynamic layer.
 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).
 IPropertySet getDocumentInfo()
          A set of name-value pairs for properties set for the map document (mxd only).
 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.
 IMapServerLegendInfos getLegendInfo2(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.
 IMapTableSubtypeInfos getMapTableSubtypeInfos(java.lang.String mapName, ILongArray pTableIDs)
          Returns the MapTableSubtypeInfos in the current map.
 IMapTableSubtypeInfos getMapTableSubtypeInfos2(java.lang.String mapName, ILayerDescriptions pLayers)
          Returns the MapTableSubtypeInfos in the current map.
 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.
 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.
 IAttachmentDataArray queryAttachmentData(java.lang.String mapName, int tableID, ILongArray attachmentIDs, int transportType)
          Returns the attachment data for the given features/ rows.
 IAttachmentDataArray queryAttachmentData2(java.lang.String mapName, IMapTableDescription pTableDescription, 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.
 IAttachmentInfoArray queryAttachmentInfos2(java.lang.String mapName, IMapTableDescription pTableDescription, 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.
 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.
 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.
 IStringArray queryHTMLPopups2(java.lang.String mapName, IMapTableDescription pTableDescription, 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.
 IImageResults queryRasterValue2(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, int sourceTable, IFIDSet pFIDs, IRelateDescription relateDescription)
          Returns the IDs of the rows that meet the query filter selection criteria for the specified table.
 IQueryResult queryRelatedRecords2(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

IIDf1ec368e_d632_4f3f_a595_7742ec824e2b

static final int IIDf1ec368e_d632_4f3f_a595_7742ec824e2b
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

generateDataClasses

IFeatureRenderer generateDataClasses(java.lang.String mapName,
                                     IMapTableDescription pTableDescription,
                                     IDataClassificationDef pDataClassificationDef)
                                     throws java.io.IOException,
                                            AutomationException
Returns the class breaks or unique values for the specified dynamic layer.

Parameters:
mapName - The mapName (in)
pTableDescription - A reference to a com.esri.arcgis.carto.IMapTableDescription (in)
pDataClassificationDef - A reference to a com.esri.arcgis.carto.IDataClassificationDef (in)
Returns:
A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryRelatedRecords2

IQueryResult queryRelatedRecords2(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.

queryRasterValue2

IImageResults queryRasterValue2(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.

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.

queryAttachmentInfos2

IAttachmentInfoArray queryAttachmentInfos2(java.lang.String mapName,
                                           IMapTableDescription pTableDescription,
                                           ILongArray rowIDs)
                                           throws java.io.IOException,
                                                  AutomationException
Returns the attachment info that describe the attachments for the given features/ rows.

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

queryAttachmentData2

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

Parameters:
mapName - The mapName (in)
pTableDescription - A reference to a com.esri.arcgis.carto.IMapTableDescription (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.

queryHTMLPopups2

IStringArray queryHTMLPopups2(java.lang.String mapName,
                              IMapTableDescription pTableDescription,
                              ILongArray pRowIDs)
                              throws java.io.IOException,
                                     AutomationException
Returns the html as text that can be used in popups.

Parameters:
mapName - The mapName (in)
pTableDescription - A reference to a com.esri.arcgis.carto.IMapTableDescription (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.

getMapTableSubtypeInfos2

IMapTableSubtypeInfos getMapTableSubtypeInfos2(java.lang.String mapName,
                                               ILayerDescriptions pLayers)
                                               throws java.io.IOException,
                                                      AutomationException
Returns the MapTableSubtypeInfos in the current map.

Parameters:
mapName - The mapName (in)
pLayers - A reference to a com.esri.arcgis.carto.ILayerDescriptions (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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

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

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

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.

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.

queryFeatureCount

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.

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

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.

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

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.

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

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.

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

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

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

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.

exportScaleBar

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.

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.

queryFeatureCount2

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.

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

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.

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

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.

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

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

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.

getLegendInfo2

IMapServerLegendInfos getLegendInfo2(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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD