com.esri.arcgis.carto
Class MapDescription

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

All Implemented Interfaces:

IMapDescription, IMapDescription2, IMapServerGeoTransformation, IMapTimeDescription, IMapTimeDescription2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class MapDescription
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapDescription, IMapDescription2, IMapTimeDescription, IMapTimeDescription2, IMapServerGeoTransformation, IXMLSerialize, IPersistStream, IPersist, java.io.Externalizable

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

Description 'The Map Description coclass contains settings of a map in the current document.' 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.IMapDescription

IID, IID4a81affe_0883_4062_8536_85ab858a10a5, xxDummy

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

IID, IIDeea2fceb_f704_4de2_b2cf_289d1788cdab, xxDummy

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

IID, IID2305fe16_0e11_4291_b824_8e6ceb1649f4, xxDummy

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

IIDaa4291a6_8c04_4519_8aa5_4edb246f726b

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

IID, IIDae983588_93a2_465f_8228_0617d8d5c23b, xxDummy

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, 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

MapDescription()
Constructs a MapDescription using ArcGIS Engine.

MapDescription(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapDescription theMapDescription = (MapDescription) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IFillSymbol	getBackgroundSymbol() Background symbol of the Map.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IGraphicElements	getCustomGraphics() Custom graphics.
IGeoTransformation	getGeoTransformation() On-the-fly geographic transformations.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILayerDescriptions	getLayerDescriptions() A collection of Layer Description objects, each describing a layer within the map (data frame).
IMapArea	getMapArea() The display area of the map (data frame).
double	getMapRotation() The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.
java.lang.String	getName() The name of the map (data frame).
IColor	getSelectionColor() The default selection color.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The spatial reference of the map (data frame).
ITimeReference	getTimeReference() Time reference used by the time aware content.
int	getTimeRelation() Time relation for the time query.
ITimeValue	getTimeValue() Time value that will be used by the time aware content of the map.
IColor	getTransparentColor() The color that is transparent (100 %).
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a MapDescription.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setBackgroundSymbol(IFillSymbol fillSymbol) Background symbol of the Map.
void	setCustomGraphics(IGraphicElements elements) Custom graphics.
void	setGeoTransformationByRef(IGeoTransformation transformations) On-the-fly geographic transformations.
void	setLayerDescriptions(ILayerDescriptions layerDescriptions) A collection of Layer Description objects, each describing a layer within the map (data frame).
void	setMapArea(IMapArea area) The display area of the map (data frame).
void	setMapRotation(double angleDegrees) The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.
void	setName(java.lang.String name) The name of the map (data frame).
void	setSelectionColor(IColor color) The default selection color.
void	setSpatialReferenceByRef(ISpatialReference spatialReference) The spatial reference of the map (data frame).
void	setTimeReferenceByRef(ITimeReference timeReference) Time reference used by the time aware content.
void	setTimeRelation(int relation) Time relation for the time query.
void	setTimeValueByRef(ITimeValue timeValue) Time value that will be used by the time aware content of the map.
void	setTransparentColor(IColor color) The color that is transparent (100 %).
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

MapDescription

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

Constructs a MapDescription using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MapDescription

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

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

Construct a MapDescription using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MapDescription.

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

Specified by:

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

getName

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

The name of the map (data frame).

Specified by:

getName in interface IMapDescription

Specified by:

getName in interface IMapDescription2

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the map (data frame).

Specified by:

setName in interface IMapDescription

Specified by:

setName in interface IMapDescription2

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapArea

public IMapArea getMapArea()
                    throws java.io.IOException,
                           AutomationException

The display area of the map (data frame).

Specified by:

getMapArea in interface IMapDescription

Specified by:

getMapArea in interface IMapDescription2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapArea

public void setMapArea(IMapArea area)
                throws java.io.IOException,
                       AutomationException

The display area of the map (data frame).

Specified by:

setMapArea in interface IMapDescription

Specified by:

setMapArea in interface IMapDescription2

Parameters:

area - A reference to a com.esri.arcgis.carto.IMapArea (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptions

public ILayerDescriptions getLayerDescriptions()
                                        throws java.io.IOException,
                                               AutomationException

A collection of Layer Description objects, each describing a layer within the map (data frame).

Specified by:

getLayerDescriptions in interface IMapDescription

Specified by:

getLayerDescriptions in interface IMapDescription2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerDescriptions

public void setLayerDescriptions(ILayerDescriptions layerDescriptions)
                          throws java.io.IOException,
                                 AutomationException

A collection of Layer Description objects, each describing a layer within the map (data frame).

Specified by:

setLayerDescriptions in interface IMapDescription

Specified by:

setLayerDescriptions in interface IMapDescription2

Parameters:

layerDescriptions - A reference to a com.esri.arcgis.carto.ILayerDescriptions (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapRotation

public double getMapRotation()
                      throws java.io.IOException,
                             AutomationException

The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.

Specified by:

getMapRotation in interface IMapDescription

Specified by:

getMapRotation in interface IMapDescription2

Returns:

The angleDegrees

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapRotation

public void setMapRotation(double angleDegrees)
                    throws java.io.IOException,
                           AutomationException

The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.

Specified by:

setMapRotation in interface IMapDescription

Specified by:

setMapRotation in interface IMapDescription2

Parameters:

angleDegrees - The angleDegrees (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

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

The spatial reference of the map (data frame).

Specified by:

getSpatialReference in interface IMapDescription

Specified by:

getSpatialReference in interface IMapDescription2

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.

setSpatialReferenceByRef

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

The spatial reference of the map (data frame).

Specified by:

setSpatialReferenceByRef in interface IMapDescription

Specified by:

setSpatialReferenceByRef in interface IMapDescription2

Parameters:

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

getCustomGraphics

public IGraphicElements getCustomGraphics()
                                   throws java.io.IOException,
                                          AutomationException

Custom graphics.

Specified by:

getCustomGraphics in interface IMapDescription

Specified by:

getCustomGraphics in interface IMapDescription2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomGraphics

public void setCustomGraphics(IGraphicElements elements)
                       throws java.io.IOException,
                              AutomationException

Custom graphics.

Specified by:

setCustomGraphics in interface IMapDescription

Specified by:

setCustomGraphics in interface IMapDescription2

Parameters:

elements - A reference to a com.esri.arcgis.carto.IGraphicElements (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 color that is transparent (100 %).

Specified by:

getTransparentColor in interface IMapDescription

Specified by:

getTransparentColor in interface IMapDescription2

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 color that is transparent (100 %).

Specified by:

setTransparentColor in interface IMapDescription

Specified by:

setTransparentColor in interface IMapDescription2

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.

getSelectionColor

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

The default selection color.

Specified by:

getSelectionColor in interface IMapDescription

Specified by:

getSelectionColor in interface IMapDescription2

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.

setSelectionColor

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

The default selection color.

Specified by:

setSelectionColor in interface IMapDescription

Specified by:

setSelectionColor in interface IMapDescription2

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.

getBackgroundSymbol

public IFillSymbol getBackgroundSymbol()
                                throws java.io.IOException,
                                       AutomationException

Background symbol of the Map.

Specified by:

getBackgroundSymbol in interface IMapDescription2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundSymbol

public void setBackgroundSymbol(IFillSymbol fillSymbol)
                         throws java.io.IOException,
                                AutomationException

Background symbol of the Map.

Specified by:

setBackgroundSymbol in interface IMapDescription2

Parameters:

fillSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeValue

public ITimeValue getTimeValue()
                        throws java.io.IOException,
                               AutomationException

Time value that will be used by the time aware content of the map.

Specified by:

getTimeValue in interface IMapTimeDescription

Returns:

A reference to a com.esri.arcgis.system.ITimeValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeValueByRef

public void setTimeValueByRef(ITimeValue timeValue)
                       throws java.io.IOException,
                              AutomationException

Time value that will be used by the time aware content of the map.

Specified by:

setTimeValueByRef in interface IMapTimeDescription

Parameters:

timeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException

Time reference used by the time aware content.

Specified by:

getTimeReference in interface IMapTimeDescription

Returns:

A reference to a com.esri.arcgis.system.ITimeReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference timeReference)
                           throws java.io.IOException,
                                  AutomationException

Time reference used by the time aware content.

Specified by:

setTimeReferenceByRef in interface IMapTimeDescription

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeRelation

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

Time relation for the time query.

Specified by:

getTimeRelation in interface IMapTimeDescription2

Returns:

A com.esri.arcgis.system.esriTimeRelation constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeRelation

public void setTimeRelation(int relation)
                     throws java.io.IOException,
                            AutomationException

Time relation for the time query.

Specified by:

setTimeRelation in interface IMapTimeDescription2

Parameters:

relation - A com.esri.arcgis.system.esriTimeRelation constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeoTransformationByRef

public void setGeoTransformationByRef(IGeoTransformation transformations)
                               throws java.io.IOException,
                                      AutomationException

On-the-fly geographic transformations.

Specified by:

setGeoTransformationByRef in interface IMapServerGeoTransformation

Parameters:

transformations - A reference to a com.esri.arcgis.geometry.IGeoTransformation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeoTransformation

public IGeoTransformation getGeoTransformation()
                                        throws java.io.IOException,
                                               AutomationException

On-the-fly geographic transformations.

Specified by:

getGeoTransformation in interface IMapServerGeoTransformation

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

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.

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.

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