com.esri.arcgis.carto

Class LayerDescription

java.lang.Object

com.esri.arcgis.carto.LayerDescription

All Implemented Interfaces:

ILayerDescription, IMapTableDescription, IMapTableTimeDescription, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class LayerDescription
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayerDescription, IMapTableDescription, IMapTableTimeDescription, IXMLSerialize, IPersistStream, IPersist, java.io.Externalizable

COM Class 'LayerDescription'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description 'The Layer Description coclass contains settings of a layer in a map.' 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

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

IID, IIDf763bdbe_8ef9_4da8_9628_dbe8ee4eb6de, xxDummy

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

IID, IIDdba8935b_8fa9_49bd_80a7_061d5f0295aa, xxDummy

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

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

Constructors

Constructor and Description
LayerDescription() Constructs a LayerDescription using ArcGIS Engine.
LayerDescription(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. LayerDescription theLayerDescription = (LayerDescription) obj;

Method Summary

Modifier and Type	Method and Description
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getDefinitionExpression() The definition expression for the layer.
int	getID() The layer ID.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
ILayerResultOptions	getLayerResultOptions() Indicate whether to include and/or modify Geometry.
double	getSelectionBufferDistance() The selection buffer distance.
IFIDSet	getSelectionFeatures() Array of selected features.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getSourceID() The id of the data source to connect to.
double	getTimeOffset() Draw time offset to overlay the data on a earlier or later time span.
int	getTimeOffsetUnits() Draw time offset units.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isScaleSymbols() Indicates whether the layer should scale its symbols according to the reference scale.
boolean	isShowLabels() Indicates whether the layer should display its dynamic labels.
boolean	isShowSelectionBuffer() Indicates whether the selection buffer should be displayed.
boolean	isTimeDataCumulative() Draw the data cumulatively from the first instance of time in data as time progresses.
boolean	isUseTime() Indicates whether use time for display.
boolean	isVisible() Indicates whether the layer is visible as defined in the TOC (i.e.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setDefinitionExpression(java.lang.String expression) The definition expression for the layer.
void	setID(int layerID) The layer ID.
void	setLayerResultOptionsByRef(ILayerResultOptions layerResultOptions) Indicate whether to include and/or modify Geometry.
void	setScaleSymbols(boolean scale) Indicates whether the layer should scale its symbols according to the reference scale.
void	setSelectionBufferDistance(double distance) The selection buffer distance.
void	setSelectionFeatures(IFIDSet featureIDs) Array of selected features.
void	setShowLabels(boolean show) Indicates whether the layer should display its dynamic labels.
void	setShowSelectionBuffer(boolean show) Indicates whether the selection buffer should be displayed.
void	setSourceID(java.lang.String srcID) The id of the data source to connect to.
void	setTimeDataCumulative(boolean drawCumilative) Draw the data cumulatively from the first instance of time in data as time progresses.
void	setTimeOffset(double offset) Draw time offset to overlay the data on a earlier or later time span.
void	setTimeOffsetUnits(int offsetUnits) Draw time offset units.
void	setUseTime(boolean useTime) Indicates whether use time for display.
void	setVisible(boolean visible) Indicates whether the layer is visible as defined in the TOC (i.e.
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

LayerDescription

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

Constructs a LayerDescription using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LayerDescription

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

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

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

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

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getID

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

The layer ID. This is a unique ID for the layer, and is used to identify the layer in a number of method calls.

Specified by:

getID in interface ILayerDescription

Specified by:

getID in interface IMapTableDescription

Returns:

The layerID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int layerID)
           throws java.io.IOException,
                  AutomationException

The layer ID. This is a unique ID for the layer, and is used to identify the layer in a number of method calls.

Specified by:

setID in interface ILayerDescription

Specified by:

setID in interface IMapTableDescription

Parameters:

layerID - The layerID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates whether the layer is visible as defined in the TOC (i.e. marked on).

Specified by:

isVisible in interface ILayerDescription

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates whether the layer is visible as defined in the TOC (i.e. marked on).

Specified by:

setVisible in interface ILayerDescription

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

public boolean isScaleSymbols()
                       throws java.io.IOException,
                              AutomationException

Indicates whether the layer should scale its symbols according to the reference scale.

Specified by:

isScaleSymbols in interface ILayerDescription

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the layer should scale its symbols according to the reference scale.

Specified by:

setScaleSymbols in interface ILayerDescription

Parameters:

scale - The scale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowLabels

public boolean isShowLabels()
                     throws java.io.IOException,
                            AutomationException

Indicates whether the layer should display its dynamic labels.

Specified by:

isShowLabels in interface ILayerDescription

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowLabels

public void setShowLabels(boolean show)
                   throws java.io.IOException,
                          AutomationException

Indicates whether the layer should display its dynamic labels.

Specified by:

setShowLabels in interface ILayerDescription

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionFeatures

public IFIDSet getSelectionFeatures()
                             throws java.io.IOException,
                                    AutomationException

Array of selected features.

Specified by:

getSelectionFeatures in interface ILayerDescription

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.

setSelectionFeatures

public void setSelectionFeatures(IFIDSet featureIDs)
                          throws java.io.IOException,
                                 AutomationException

Array of selected features.

Specified by:

setSelectionFeatures in interface ILayerDescription

Parameters:

featureIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionBufferDistance

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

The selection buffer distance. When drawing, and if a selection filter is specified, a buffer zone of the specified distance will be displayed around the selected features.

Specified by:

getSelectionBufferDistance in interface ILayerDescription

Returns:

The distance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionBufferDistance

public void setSelectionBufferDistance(double distance)
                                throws java.io.IOException,
                                       AutomationException

The selection buffer distance. When drawing, and if a selection filter is specified, a buffer zone of the specified distance will be displayed around the selected features.

Specified by:

setSelectionBufferDistance in interface ILayerDescription

Parameters:

distance - The distance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowSelectionBuffer

public boolean isShowSelectionBuffer()
                              throws java.io.IOException,
                                     AutomationException

Indicates whether the selection buffer should be displayed.

Specified by:

isShowSelectionBuffer in interface ILayerDescription

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSelectionBuffer

public void setShowSelectionBuffer(boolean show)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether the selection buffer should be displayed.

Specified by:

setShowSelectionBuffer in interface ILayerDescription

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

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

The definition expression for the layer.

Specified by:

getDefinitionExpression in interface ILayerDescription

Specified by:

getDefinitionExpression in interface IMapTableDescription

Returns:

The expression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

public void setDefinitionExpression(java.lang.String expression)
                             throws java.io.IOException,
                                    AutomationException

The definition expression for the layer.

Specified by:

setDefinitionExpression in interface ILayerDescription

Specified by:

setDefinitionExpression in interface IMapTableDescription

Parameters:

expression - The expression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerResultOptionsByRef

public void setLayerResultOptionsByRef(ILayerResultOptions layerResultOptions)
                                throws java.io.IOException,
                                       AutomationException

Indicate whether to include and/or modify Geometry.

Specified by:

setLayerResultOptionsByRef in interface ILayerDescription

Parameters:

layerResultOptions - A reference to a com.esri.arcgis.carto.ILayerResultOptions (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerResultOptions

public ILayerResultOptions getLayerResultOptions()
                                          throws java.io.IOException,
                                                 AutomationException

Indicate whether to include and/or modify Geometry.

Specified by:

getLayerResultOptions in interface ILayerDescription

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSourceID

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

The id of the data source to connect to.

Specified by:

getSourceID in interface IMapTableDescription

Returns:

The srcID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSourceID

public void setSourceID(java.lang.String srcID)
                 throws java.io.IOException,
                        AutomationException

The id of the data source to connect to.

Specified by:

setSourceID in interface IMapTableDescription

Parameters:

srcID - The srcID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseTime

public boolean isUseTime()
                  throws java.io.IOException,
                         AutomationException

Indicates whether use time for display.

Specified by:

isUseTime in interface IMapTableTimeDescription

Returns:

The useTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseTime

public void setUseTime(boolean useTime)
                throws java.io.IOException,
                       AutomationException

Indicates whether use time for display.

Specified by:

setUseTime in interface IMapTableTimeDescription

Parameters:

useTime - The useTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTimeDataCumulative

public boolean isTimeDataCumulative()
                             throws java.io.IOException,
                                    AutomationException

Draw the data cumulatively from the first instance of time in data as time progresses.

Specified by:

isTimeDataCumulative in interface IMapTableTimeDescription

Returns:

The drawCumilative

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeDataCumulative

public void setTimeDataCumulative(boolean drawCumilative)
                           throws java.io.IOException,
                                  AutomationException

Draw the data cumulatively from the first instance of time in data as time progresses.

Specified by:

setTimeDataCumulative in interface IMapTableTimeDescription

Parameters:

drawCumilative - The drawCumilative (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeOffset

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

Draw time offset to overlay the data on a earlier or later time span.

Specified by:

getTimeOffset in interface IMapTableTimeDescription

Returns:

The offset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOffset

public void setTimeOffset(double offset)
                   throws java.io.IOException,
                          AutomationException

Draw time offset to overlay the data on a earlier or later time span.

Specified by:

setTimeOffset in interface IMapTableTimeDescription

Parameters:

offset - The offset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeOffsetUnits

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

Draw time offset units.

Specified by:

getTimeOffsetUnits in interface IMapTableTimeDescription

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOffsetUnits

public void setTimeOffsetUnits(int offsetUnits)
                        throws java.io.IOException,
                               AutomationException

Draw time offset units.

Specified by:

setTimeOffsetUnits in interface IMapTableTimeDescription

Parameters:

offsetUnits - A com.esri.arcgis.system.esriTimeUnits constant (in)

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