com.esri.arcgis.carto
Class ACMap

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

All Implemented Interfaces:

IACMap, IACMapAdmin, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class ACMap
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IACMap, IACMapAdmin, IPersist, IPersistStream, Externalizable

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(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ACMap theACMap = (ACMap) obj;

Method Summary

void	connect(IIMSAxlRequest request) Connects to the ArcIMS service.
boolean	equals(Object o) Compare this object with another
IEnvelope	getAreaOfInterest() The area of interest for the ArcIMS service.
IColor	getBackgroundColor() The background color.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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) getSizeMax
IColor	getTransparentColor() The transparent color.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	moveLayer(IACLayer layer, int toIndex) Moves a layer to another position.
void	readExternal(ObjectInput in)
String	requestImage(IEnvelope pExtent, double dpi, int width, int height, boolean scaleSymbols) The new image location as an URL.
String	requestImageWithXml(String xml) The new image location as an URL.
void	save(IStream pstm, int fClearDirty) save
String	sendAxlQueryRequest(String axl, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends an Axl query request.
String	sendAxlRequest(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.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ACMap

public ACMap()
      throws IOException,
             UnknownHostException

Constructs a ACMap using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ACMap

public ACMap(Object obj)
      throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ACMap theACMap = (ACMap) obj;

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.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

sendAxlRequest

public String sendAxlRequest(String axl,
                             ITrackCancel trackCancel,
                             boolean showConnectingAVI,
                             boolean processMessages)
                      throws IOException,
                             AutomationException

Sends an Axl request.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendAxlQueryRequest

public String sendAxlQueryRequest(String axl,
                                  ITrackCancel trackCancel,
                                  boolean showConnectingAVI,
                                  boolean processMessages)
                           throws IOException,
                                  AutomationException

Sends an Axl query request.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

The background color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackgroundColor in interface IACMap

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws IOException,
                               AutomationException

The background color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBackgroundColor in interface IACMap

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparentColor

public IColor getTransparentColor()
                           throws IOException,
                                  AutomationException

The transparent color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransparentColor in interface IACMap

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparentColor

public void setTransparentColor(IColor color)
                         throws IOException,
                                AutomationException

The transparent color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransparentColor in interface IACMap

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

requestImage

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

The new image location as an URL.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

requestImageWithXml

public String requestImageWithXml(String xml)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

requestImageWithXml in interface IACMap

Parameters:

xml - The xml (in)

Returns:

The imageURL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageRequestXml

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

The xml to request an image.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCount

public int getLayerCount()
                  throws IOException,
                         AutomationException

The number of layers in the ArcIMS service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLayerCount in interface IACMap

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public IACLayer getLayer(int index)
                  throws IOException,
                         AutomationException

The layer at the given index.

Product Availability

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

Specified by:

getLayer in interface IACMap

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveLayer

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

Moves a layer to another position.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException

The spatial reference of the ArcIMS service.

Product Availability

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

Specified by:

setSpatialReferenceByRef in interface IACMap

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeSpatialReference

public ISpatialReference getNativeSpatialReference()
                                            throws IOException,
                                                   AutomationException

The native spatial reference of the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeSpatialReference in interface IACMap

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The area of interest for the ArcIMS service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaOfInterest in interface IACMap

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnits

public int getMapUnits()
                throws IOException,
                       AutomationException

The map units for the ArcIMS service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapUnits in interface IACMap

Returns:

A com.esri.arcgis.gisclient.acMapUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxPrintPixels

public int getMaxPrintPixels()
                      throws IOException,
                             AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxPrintPixels in interface IACMap

Returns:

The pMaxPrintPixels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public void connect(IIMSAxlRequest request)
             throws IOException,
                    AutomationException

Connects to the ArcIMS service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

connect in interface IACMapAdmin

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException