com.esri.arcgis.carto
Class IMapServerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IMapServerProxy

All Implemented Interfaces:

IMapServer, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for COM Interface 'IMapServer'. 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 =

public class IMapServerProxy
extends com.esri.arcgis.interop.Dispatch
implements IMapServer, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.carto.IMapServer

IID, IID12353e37_ab79_48f7_9cb1_56ec9d7eb800

Constructor Summary

	IMapServerProxy() Deprecated. For internal use only
	IMapServerProxy(java.lang.Object obj) Deprecated.
protected	IMapServerProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IMapServerProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IMapServerProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
double	computeDistance(java.lang.String mapName, IPoint fromPoint, IPoint toPoint, int units) Deprecated. Computes the distance between two points on the specified map.
double	computeScale(IMapDescription mapDesc, IImageDisplay mapDisplay) Deprecated. 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) Deprecated. 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) Deprecated. 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) Deprecated. Converts a map coordinate to a screen location.
java.lang.String	getDefaultMapName() Deprecated. Name of the document's active map (data frame).
IPropertySet	getDocumentInfo() Deprecated. 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) Deprecated. Returns a collection of Map Server Legend Info objects for the specified layers.
int	getMapCount() Deprecated. The number of maps (data frames) in the document.
java.lang.String	getMapName(int index) Deprecated. Name of the map (data frame) as indicated by the index.
IMapServerInfo	getServerInfo(java.lang.String mapName) Deprecated. Returns information about a map (data frame).
ISQLSyntaxInfo	getSQLSyntaxInfo(java.lang.String mapName, int layerID) Deprecated. Returns the SQL syntax information for the specified layer.
int	getSupportedImageReturnTypes() Deprecated. The supported image return types for the map server.
IMapServerIdentifyResults	identify(IMapDescription mapDesc, IImageDisplay mapImage, IGeometry searchShape, int tolerance, int option, ILongArray layerIds) Deprecated. Returns a collection of Map Server Identify Result objects at the given location.
int	queryFeatureCount(java.lang.String mapName, int layerID, IQueryFilter filter) Deprecated. 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) Deprecated. 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) Deprecated. Returns the IDs of the features that meet the query filter selection criteria for the specified layer.
IMapServerHyperlinks	queryHyperlinks(IMapDescription mapDesc, IImageDisplay mapImage, ILongArray layerIds) Deprecated. Returns a collection of Map Server Hyperlink objects for the specified layers.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
IPointCollection	toMapPoints(IMapDescription mapDescription, IImageDisplay mapDisplay, ILongArray screenXValues, ILongArray screenYValues) Deprecated. Converts a screen location to a map coordinate.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IMapServerProxy

public IMapServerProxy(java.lang.String CLSID,
                       java.lang.String host,
                       com.esri.arcgis.interop.AuthInfo authInfo)
                throws java.net.UnknownHostException,
                       java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

IMapServerProxy

public IMapServerProxy()

Deprecated.

For internal use only

IMapServerProxy

public IMapServerProxy(java.lang.Object obj)
                throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IMapServerProxy

protected IMapServerProxy(java.lang.Object obj,
                          java.lang.String iid)
                   throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IMapServerProxy

protected IMapServerProxy(java.lang.String CLSID,
                          java.lang.String iid,
                          java.lang.String host,
                          com.esri.arcgis.interop.AuthInfo authInfo)
                   throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Deprecated.

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getDocumentInfo

public IPropertySet getDocumentInfo()
                             throws java.io.IOException,
                                    AutomationException

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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.

queryFeatureCount

public int queryFeatureCount(java.lang.String mapName,
                             int layerID,
                             IQueryFilter filter)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

Returns the count of the features that meet the query filter selection criteria for the specified layer.

Specified by:

queryFeatureCount in interface IMapServer

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryFeatureIDs

public IFIDSet queryFeatureIDs(java.lang.String mapName,
                               int layerID,
                               IQueryFilter filter)
                        throws java.io.IOException,
                               AutomationException

Deprecated.

Returns the IDs of the features that meet the query filter selection criteria for the specified layer.

Specified by:

queryFeatureIDs in interface IMapServer

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFIDSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryFeatureData

public IRecordSet queryFeatureData(java.lang.String mapName,
                                   int layerID,
                                   IQueryFilter filter)
                            throws java.io.IOException,
                                   AutomationException

Deprecated.

Returns a record set of features that meet the query filter selection criteria for the specified layer.

Specified by:

queryFeatureData in interface IMapServer

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRecordSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryHyperlinks

public IMapServerHyperlinks queryHyperlinks(IMapDescription mapDesc,
                                            IImageDisplay mapImage,
                                            ILongArray layerIds)
                                     throws java.io.IOException,
                                            AutomationException

Deprecated.

Returns a collection of Map Server Hyperlink objects for the specified layers. Only hyperlinks of visible layers are returned. If LayerIDs is Nothing/Null or empty, all layers are searched.

Specified by:

queryHyperlinks in interface IMapServer

Parameters:

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

mapImage - A reference to a com.esri.arcgis.carto.IImageDisplay (in)

layerIds - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

A reference to a com.esri.arcgis.carto.IMapServerHyperlinks

Throws:

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

AutomationException - If the ArcObject component throws an exception.

computeScale

public double computeScale(IMapDescription mapDesc,
                           IImageDisplay mapDisplay)
                    throws java.io.IOException,
                           AutomationException

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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(java.lang.String mapName,
                                           ILongArray layerIds,
                                           IMapServerLegendPatch patch,
                                           IImageType imgType)
                                    throws java.io.IOException,
                                           AutomationException

Deprecated.

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:

mapName - The mapName (in)

layerIds - A reference to a com.esri.arcgis.system.ILongArray (in)

patch - A reference to a com.esri.arcgis.carto.IMapServerLegendPatch (in)

imgType - A reference to a com.esri.arcgis.carto.IImageType (in)

Returns:

A reference to a com.esri.arcgis.carto.IMapServerLegendInfos

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSQLSyntaxInfo

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

Deprecated.

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

Deprecated.

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.