com.esri.arcgis.carto
Class ACMap

java.lang.Object
  com.esri.arcgis.carto.ACMap

All Implemented Interfaces:

IACMap, IACMapAdmin, IPersist, IPersistStream, java.io.Serializable

public class ACMap

extends java.lang.Object

implements IACMap, IACMapAdmin, IPersist, IPersistStream

Container for the display and manipulation of ArcIMS map services.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ACMap()
Constructs a ACMap using ArcGIS Engine.

ACMap(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	connect(IIMSAxlRequest request) Connects to the ArcIMS service.
boolean	equals(java.lang.Object o) Compare this object with another
IEnvelope	getAreaOfInterest() The area of interest for the ArcIMS service.
IACMap	getAsIACMap() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACMapAdmin	getAsIACMapAdmin() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IColor	getBackgroundColor() The background color.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
java.lang.String	getImageRequestXml(IEnvelope pExtent, double dpi, int width, int height, boolean scaleSymbols) The xml to request an image.
IACLayer	getLayer(int index) The layer at the given index.
int	getLayerCount() The number of layers in the ArcIMS service.
int	getMapUnits() The map units for the ArcIMS service.
int	getMaxPrintPixels() The maximum number of pixels allowed for an image print request.
ISpatialReference	getNativeSpatialReference() The native spatial reference of the data.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
IColor	getTransparentColor() The transparent color.
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
void	load(IStream pstm) Supported Platforms
void	moveLayer(IACLayer layer, int toIndex) Moves a layer to another position.
java.lang.String	requestImage(IEnvelope pExtent, double dpi, int width, int height, boolean scaleSymbols) The new image location as an URL.
java.lang.String	requestImageWithXml(java.lang.String xml) The new image location as an URL.
void	save(IStream pstm, int fClearDirty) Supported Platforms
java.lang.String	sendAxlQueryRequest(java.lang.String axl, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends an Axl query request.
java.lang.String	sendAxlRequest(java.lang.String axl, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends an Axl request.
void	setBackgroundColor(IColor color) The background color.
void	setSpatialReferenceByRef(ISpatialReference rhs1) The spatial reference of the ArcIMS service.
void	setTransparentColor(IColor color) The transparent color.

Methods inherited from class java.lang.Object

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

Constructor Detail

ACMap

public ACMap()
      throws java.io.IOException,
             java.net.UnknownHostException

Constructs a ACMap using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACMap

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a ACMap using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ACMap.
ACMap theACMap = (ACMap) obj;

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

getAsIACMap

public IACMap getAsIACMap()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACMapAdmin

public IACMapAdmin getAsIACMapAdmin()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

sendAxlRequest

public java.lang.String sendAxlRequest(java.lang.String axl,
                                       ITrackCancel trackCancel,
                                       boolean showConnectingAVI,
                                       boolean processMessages)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IACMap

Sends an Axl request.

Supported Platforms

Windows, Solaris, Linux

Specified by:

sendAxlRequest in interface IACMap

Parameters:

axl - The axl (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The response

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sendAxlQueryRequest

public java.lang.String sendAxlQueryRequest(java.lang.String axl,
                                            ITrackCancel trackCancel,
                                            boolean showConnectingAVI,
                                            boolean processMessages)
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IACMap

Sends an Axl query request.

Supported Platforms

Windows, Solaris, Linux

Specified by:

sendAxlQueryRequest in interface IACMap

Parameters:

axl - The axl (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The response

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IACMap

The background color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackgroundColor in interface IACMap

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IACMap

The background color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBackgroundColor in interface IACMap

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparentColor

public IColor getTransparentColor()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IACMap

The transparent color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransparentColor in interface IACMap

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparentColor

public void setTransparentColor(IColor color)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IACMap

The transparent color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransparentColor in interface IACMap

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

requestImage

public java.lang.String requestImage(IEnvelope pExtent,
                                     double dpi,
                                     int width,
                                     int height,
                                     boolean scaleSymbols)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IACMap

The new image location as an URL.

Supported Platforms

Windows, Solaris, Linux

Specified by:

requestImage in interface IACMap

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

dpi - The dpi (in)

width - The width (in)

height - The height (in)

scaleSymbols - The scaleSymbols (in)

Returns:

The imageURL

Throws:

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

AutomationException - If the ArcObject component throws an exception.

requestImageWithXml

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

Description copied from interface: IACMap

The new image location as an URL. Call ImageRequestXml first.

Supported Platforms

Windows, Solaris, Linux

Specified by:

requestImageWithXml in interface IACMap

Parameters:

xml - The xml (in)

Returns:

The imageURL

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getImageRequestXml

public java.lang.String getImageRequestXml(IEnvelope pExtent,
                                           double dpi,
                                           int width,
                                           int height,
                                           boolean scaleSymbols)
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IACMap

The xml to request an image.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getImageRequestXml in interface IACMap

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

dpi - The dpi (in)

width - The width (in)

height - The height (in)

scaleSymbols - The scaleSymbols (in)

Returns:

The xml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerCount

public int getLayerCount()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACMap

The number of layers in the ArcIMS service.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLayerCount in interface IACMap

Returns:

The count

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getLayer

public IACLayer getLayer(int index)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACMap

The layer at the given index.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLayer in interface IACMap

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveLayer

public void moveLayer(IACLayer layer,
                      int toIndex)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IACMap

Moves a layer to another position.

Supported Platforms

Windows, Solaris, Linux

Specified by:

moveLayer in interface IACMap

Parameters:

layer - A reference to a com.esri.arcgis.carto.IACLayer (in)

toIndex - The toIndex (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IACMap

The spatial reference of the ArcIMS service.

Specified by:

setSpatialReferenceByRef in interface IACMap

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getNativeSpatialReference

public ISpatialReference getNativeSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException

Description copied from interface: IACMap

The native spatial reference of the data.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeSpatialReference in interface IACMap

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IACMap

The area of interest for the ArcIMS service.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaOfInterest in interface IACMap

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMapUnits

public int getMapUnits()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IACMap

The map units for the ArcIMS service.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapUnits in interface IACMap

Returns:

A com.esri.arcgis.gisclient.acMapUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxPrintPixels

public int getMaxPrintPixels()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IACMap

The maximum number of pixels allowed for an image print request.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxPrintPixels in interface IACMap

Returns:

The pMaxPrintPixels

Throws:

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

AutomationException - If the ArcObject component throws an exception.

connect

public void connect(IIMSAxlRequest request)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IACMapAdmin

Connects to the ArcIMS service.

Supported Platforms

Windows, Solaris, Linux

Specified by:

connect in interface IACMapAdmin

Parameters:

request - A reference to a com.esri.arcgis.gisclient.IIMSAxlRequest (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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