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, java.io.Externalizable, java.io.Serializable

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

COM Class 'ACMap'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Container for the display and manipulation of ArcIMS map services.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

IID, IID74e45210_dfe6_11d3_9ff7_00c04f6bc6a5, xxDummy

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

IID, IID849696ae_8694_4666_b5f1_9137bad51136, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

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.
ACMap theACMap = (ACMap) obj;

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.
IColor	getBackgroundColor() The background color.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getImageRequestXml(IEnvelope pExtent, double dpi, int width, int height, boolean scaleSymbols) The xml to request an image.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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(java.io.ObjectInput in)
void	release() Release a ACMap.
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) save
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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

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

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ACMap.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

sendAxlRequest

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

Sends an Axl request.

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

Sends an Axl query request.

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

The background color.

Specified by:

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

setBackgroundColor

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

The background color.

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

The transparent color.

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

The transparent color.

Specified by:

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

requestImage

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

The new image location as an URL.

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

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

Specified by:

requestImageWithXml in interface IACMap

Parameters:

xml - The xml (in)

Returns:

The imageURL

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageRequestXml

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

The xml to request an image.

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

The number of layers in the ArcIMS service.

Specified by:

getLayerCount in interface IACMap

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

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

The layer at the given index.

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

Moves a layer to another position.

Specified by:

moveLayer in interface IACMap

Parameters:

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

toIndex - The toIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getNativeSpatialReference

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

The native spatial reference of the data.

Specified by:

getNativeSpatialReference in interface IACMap

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

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

The area of interest for the ArcIMS service.

Specified by:

getAreaOfInterest in interface IACMap

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapUnits

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

The map units for the ArcIMS service.

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

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

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

Connects to the ArcIMS service.

Specified by:

connect in interface IACMapAdmin

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException