com.esri.arcgis.carto
Class TopologyLayer

java.lang.Object
  extended by com.esri.arcgis.carto.TopologyLayer
All Implemented Interfaces:
IDataLayer, IDataLayer2, ILayer, ILayerDrawingProperties, ILayerEffects, ILayerInfo, ILayerPosition, ILegendInfo, IPublishLayer, ITopologyErrorSelection, ITopologyLayer, IDisplayAdmin, IDisplayFilterManager, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class TopologyLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, IDataLayer, IDataLayer2, ITopologyLayer, ITopologyErrorSelection, IGeoDataset, ILayerDrawingProperties, IPersistStream, ILegendInfo, ILayerPosition, IDisplayAdmin, IDisplayFilterManager, ILayerEffects, ILayerInfo, IPublishLayer, java.io.Externalizable

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

Description 'A collection of properties for a topology layer.' 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.IDataLayer
IID, IID6ca416b1_e160_11d2_9f4e_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDataLayer2
IID, IIDe9d11f65_6936_4408_b69f_d91552eb9c4a, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ITopologyLayer
IID, IIDfb6337e3_610a_4bc2_9142_760d954c22eb, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ITopologyErrorSelection
IID, IID82e0d83a_8bc3_4eee_9cc9_95775ab39ba9, 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
 
Fields inherited from interface com.esri.arcgis.carto.ILayerPosition
IID, IIDc0dc8820_e10f_4285_aab1_6c6b685dbb84, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayFilterManager
IID, IIDf0815360_19e1_11d3_80c8_0080c79f0371, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin
IID12e361f0_1907_11d3_80c7_0080c79f0371
 
Fields inherited from interface com.esri.arcgis.carto.ILayerEffects
IID, IID09998199_1fb8_11d3_ab4e_000000000000, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerInfo
IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IPublishLayer
IID, IID7453c805_9d64_44a6_bf2f_73e477dce18f, xxDummy
 
Constructor Summary
TopologyLayer()
          Constructs a TopologyLayer using ArcGIS Engine.
TopologyLayer(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TopologyLayer theTopologyLayer = (TopologyLayer) obj;
 
Method Summary
 boolean connect(IName pOptRepairName)
          Connects the layer to its data source.
 void disconnect()
          Disconnects the data from the layer.
 void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel)
          Draws the layer to the specified display for the given draw phase.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IEnvelope getAreaOfInterest()
          The default area of interest for the layer.
 short getBrightness()
          Layer brightness in percent (-100 - 100).
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 short getContrast()
          Layer contrast in percent (-100 - 100).
 java.lang.String getDataDetails(java.lang.String bsPadding)
          Details of the layer's data.
 IName getDataSourceName()
          Name of the data object for the layer.
 IDisplayFilter getDisplayFilter()
          The display filter.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getLargeImage()
          Large image that represents the layer.
 int getLargeSelectedImage()
          Large image that represents the layer when it is selected.
 double getLayerWeight()
          Default layer position.
 ILegendGroup getLegendGroup(int index)
          Legend group at the specified index.
 int getLegendGroupCount()
          Number of legend groups contained by the object.
 ILegendItem getLegendItem()
          Optional.
 double getMaximumScale()
          Maximum scale (representative fraction) at which the layer will display.
 double getMinimumScale()
          Minimum scale (representative fraction) at which the layer will display.
 java.lang.String getName()
          Layer name.
 java.lang.String getPublishingDescription()
          The layer description reported to the publisher.
 java.lang.String getRelativeBase()
          Base path used when storing relative path names.
 IFeatureRenderer getRenderer(int index)
          Renderer used to draw the topology layer.
 int getRuleType(int index)
          The topology rule type.
 int getRuleTypeCount()
          The number of rule types in the topology.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getSmallImage()
          Small image that represents the layer.
 int getSmallSelectedImage()
          Small image that represents the layer when it is selected.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 int getSupportedDrawPhases()
          Supported draw phases.
 java.lang.String getTipText(double x, double y, double tolerance)
          Map tip text at the specified location.
 ITopology getTopology()
          The current topology.
 short getTransparency()
          Layer transparency in percent (0-100).
 int hashCode()
          the hashcode for this object
 boolean inWorkspace(IWorkspace workspace)
          Returns TRUE if the layer is in the specified workspace.
 boolean isCached()
          Indicates if the layer needs its own display cache.
 boolean isDataSourceSupported(IName name)
          Indicates if the specified data object name is supported by the layer.
 boolean isDataValid()
          Indicates if the data for the layer is currently valid.
 void isDirty()
          isDirty
 boolean isDrawingPropsDirty()
          Indicates if the layer drawing properties are dirty.
 boolean isSelectable(int index)
          Indicates if errors of a given rule type are selectable.
 boolean isSelectErrors()
          Indicates if errors are selectable.
 boolean isSelectExceptions()
          Indicates if exceptions are selectable.
 boolean isShowTips()
          Indicates if the layer shows map tips.
 boolean isSupportsBrightnessChange()
          Indicates if the layer supports brightness changes.
 boolean isSupportsContrastChange()
          Indicates if the layer supports contrast changes.
 boolean isSupportsInteractive()
          Indicates if the layer supports interactive effects changes.
 boolean isSupportsPublishing()
          Indicates if the layer supports the publishing process.
 boolean isSupportsTransparency()
          Indicates if the layer supports transparency.
 boolean isSymbolsAreGraduated()
          Indicates if symbols are graduated.
 boolean isUsesFilter()
          Indicates if the current object draws using a filter.
 boolean isValid()
          Indicates if the layer is currently valid.
 boolean isVisible()
          Indicates if the layer is currently visible.
 void load(IStream pstm)
          load
 void prepareForPublishing()
          Prepare the layer for the publishing process.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a TopologyLayer.
 void save(IStream pstm, int fClearDirty)
          save
 void setBrightness(short brightnessValue)
          Layer brightness in percent (-100 - 100).
 void setCached(boolean cached)
          Indicates if the layer needs its own display cache.
 void setContrast(short contrastValue)
          Layer contrast in percent (-100 - 100).
 void setDataSourceName(IName name)
          Name of the data object for the layer.
 void setDisplayFilter(IDisplayFilter displayFilter)
          The display filter.
 void setDrawingPropsDirty(boolean dirty)
          Indicates if the layer drawing properties are dirty.
 void setLayerWeight(double layerWeight)
          Default layer position.
 void setMaximumScale(double maxScale)
          Maximum scale (representative fraction) at which the layer will display.
 void setMinimumScale(double minScale)
          Minimum scale (representative fraction) at which the layer will display.
 void setName(java.lang.String name)
          Layer name.
 void setRelativeBase(java.lang.String basePath)
          Base path used when storing relative path names.
 void setRendererByRef(int index, IFeatureRenderer renderer)
          Renderer used to draw the topology layer.
 void setSelectable(int index, boolean sel)
          Indicates if errors of a given rule type are selectable.
 void setSelectErrors(boolean sel)
          Indicates if errors are selectable.
 void setSelectExceptions(boolean sel)
          Indicates if exceptions are selectable.
 void setShowTips(boolean show)
          Indicates if the layer shows map tips.
 void setSpatialReferenceByRef(ISpatialReference rhs1)
          Spatial reference for the layer.
 void setSupportsInteractive(boolean supported)
          Indicates if the layer supports interactive effects changes.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 void setTopologyByRef(ITopology topology)
          The current topology.
 void setTransparency(short alpha)
          Layer transparency in percent (0-100).
 void setVisible(boolean visible)
          Indicates if the layer is currently visible.
 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

TopologyLayer

public TopologyLayer()
              throws java.io.IOException,
                     java.net.UnknownHostException
Constructs a TopologyLayer using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

TopologyLayer

public TopologyLayer(java.lang.Object obj)
              throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TopologyLayer theTopologyLayer = (TopologyLayer) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

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

Description


Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface ILayer
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
Layer name.

Description

Use the Name property to associate a string with the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setName in interface ILayer
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException
Indicates if the layer is currently valid.

Remarks

The valid property indicates if the layer is currently valid. Layers that reference feature classes are valid when they hold a reference to a valid feature class. The property does not however validate the integrity of the feature classes reference to the database. Therefore, in rare situations if a datasource is removed after a layer is initialized, the layer will report itself as valid but query attempts to the data source will error due to the lack of underlying data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isValid in interface ILayer
Returns:
The valid
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 default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAreaOfInterest in interface ILayer
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.

getMinimumScale

public double getMinimumScale()
                       throws java.io.IOException,
                              AutomationException
Minimum scale (representative fraction) at which the layer will display.

Remarks

Specifies the minimum scale at which the layer will be displayed. This means that if you zoom out beyond this scale, the layer will not display. For example, specify 1000 to have the layer not display when zoomed out beyond 1:1000.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMinimumScale in interface ILayer
Returns:
The minScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws java.io.IOException,
                            AutomationException
Minimum scale (representative fraction) at which the layer will display.

Description

MinimumScale property specifies the minimum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMinimumScale in interface ILayer
Parameters:
minScale - The minScale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws java.io.IOException,
                              AutomationException
Maximum scale (representative fraction) at which the layer will display.

Remarks

Specifies the maximum scale at which the layer will be displayed. This means that if you zoom in beyond this scale, the layer will not display. For example, specify 500 to have the layer not display when zoomed in beyond 1:500.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaximumScale in interface ILayer
Returns:
The maxScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws java.io.IOException,
                            AutomationException
Maximum scale (representative fraction) at which the layer will display.

Description

MaximumScale property specifies the maximum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaximumScale in interface ILayer
Parameters:
maxScale - The maxScale (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 if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isVisible in interface ILayer
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 if the layer is currently visible.

Description

Use Visible property to set the visibility of the layer. When assigned False, the layer is invisible in the current view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVisible in interface ILayer
Parameters:
visible - The visible (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowTips

public boolean isShowTips()
                   throws java.io.IOException,
                          AutomationException
Indicates if the layer shows map tips.

Remarks

Indicates whether or not map tips are shown for the layer. If set to True, then map tips will be shown for the layer. You can determine the text that will be shown via TipText. For a FeatureLayer, this text comes from the data for IFeatureLayer::DisplayField.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isShowTips in interface ILayer
Returns:
The show
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws java.io.IOException,
                        AutomationException
Indicates if the layer shows map tips.

Description

ShowTips is set to True when the layer shows map tips specified in the TipText property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setShowTips in interface ILayer
Parameters:
show - The show (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTipText

public java.lang.String getTipText(double x,
                                   double y,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException
Map tip text at the specified location.

Product Availability

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

Specified by:
getTipText in interface ILayer
Parameters:
x - The x (in)
y - The y (in)
tolerance - The tolerance (in)
Returns:
The text
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws java.io.IOException,
                        AutomationException
Indicates if the layer needs its own display cache.

Remarks

This property indicates whether or not the layer requires its own display cache. If this property is True, then the Map will use a separate display cache for the layer so that it can be refreshed indpendently of other layers.

The Map is responsible for cache management. See IScreenDisplay::AddCache for more information on caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCached in interface ILayer
Returns:
The cached
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws java.io.IOException,
                      AutomationException
Indicates if the layer needs its own display cache.

Description

Use Cached property to indicate if the layer needs its own cache for display.

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCached in interface ILayer
Parameters:
cached - The cached (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws java.io.IOException,
                                  AutomationException
Supported draw phases.

Remarks

Indicates the draw phases supported by the layer (esriDPGeography, esriDPAnnotation, esriDPSelection, or any combination of the three). The supported draw phases are defined by esriDrawPhase. When multiple draw phases are supported, the sum of the constants is used. For example, if SupportedDrawPhases = 3 then the layer supports drawing in the geography and annotation phases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSupportedDrawPhases in interface ILayer
Returns:
The drawPhases
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
Spatial reference for the layer.

Remarks

This property is only used for map display, setting this property does not change the spatial reference of the layer's underlying data. The ArcGIS framework uses this property to pass the spatial reference from the map to the layer in order to support on-the-fly projection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSpatialReferenceByRef in interface ILayer
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.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException
Draws the layer to the specified display for the given draw phase.

Remarks

This method draws the layer to the Display for the specified DrawPhase. Use the TrackCancel object to allow the drawing of the layer to be interrupted by the user.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface ILayer
Parameters:
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataSourceName

public IName getDataSourceName()
                        throws java.io.IOException,
                               AutomationException
Name of the data object for the layer.

Specified by:
getDataSourceName in interface IDataLayer
Specified by:
getDataSourceName in interface IDataLayer2
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws java.io.IOException,
                              AutomationException
Name of the data object for the layer.

Specified by:
setDataSourceName in interface IDataLayer
Specified by:
setDataSourceName in interface IDataLayer2
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws java.io.IOException,
                                     AutomationException
Indicates if the specified data object name is supported by the layer.

Specified by:
isDataSourceSupported in interface IDataLayer
Specified by:
isDataSourceSupported in interface IDataLayer2
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws java.io.IOException,
                       AutomationException
Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Specified by:
connect in interface IDataLayer
Specified by:
connect in interface IDataLayer2
Parameters:
pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The succeeded
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public java.lang.String getRelativeBase()
                                 throws java.io.IOException,
                                        AutomationException
Base path used when storing relative path names.

Specified by:
getRelativeBase in interface IDataLayer
Specified by:
getRelativeBase in interface IDataLayer2
Returns:
The basePath
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(java.lang.String basePath)
                     throws java.io.IOException,
                            AutomationException
Base path used when storing relative path names.

Specified by:
setRelativeBase in interface IDataLayer
Specified by:
setRelativeBase in interface IDataLayer2
Parameters:
basePath - The basePath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws java.io.IOException,
                       AutomationException
Disconnects the data from the layer.

Specified by:
disconnect in interface IDataLayer2
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws java.io.IOException,
                           AutomationException
Returns TRUE if the layer is in the specified workspace.

Specified by:
inWorkspace in interface IDataLayer2
Parameters:
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
The inWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTopology

public ITopology getTopology()
                      throws java.io.IOException,
                             AutomationException
The current topology.

Specified by:
getTopology in interface ITopologyLayer
Returns:
A reference to a com.esri.arcgis.geodatabase.ITopology
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTopologyByRef

public void setTopologyByRef(ITopology topology)
                      throws java.io.IOException,
                             AutomationException
The current topology.

Specified by:
setTopologyByRef in interface ITopologyLayer
Parameters:
topology - A reference to a com.esri.arcgis.geodatabase.ITopology (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRenderer

public IFeatureRenderer getRenderer(int index)
                             throws java.io.IOException,
                                    AutomationException
Renderer used to draw the topology layer.

Specified by:
getRenderer in interface ITopologyLayer
Parameters:
index - A com.esri.arcgis.carto.esriTopologyRenderer constant (in)
Returns:
A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRendererByRef

public void setRendererByRef(int index,
                             IFeatureRenderer renderer)
                      throws java.io.IOException,
                             AutomationException
Renderer used to draw the topology layer.

Specified by:
setRendererByRef in interface ITopologyLayer
Parameters:
index - A com.esri.arcgis.carto.esriTopologyRenderer constant (in)
renderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRuleTypeCount

public int getRuleTypeCount()
                     throws java.io.IOException,
                            AutomationException
The number of rule types in the topology.

Specified by:
getRuleTypeCount in interface ITopologyErrorSelection
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRuleType

public int getRuleType(int index)
                throws java.io.IOException,
                       AutomationException
The topology rule type.

Specified by:
getRuleType in interface ITopologyErrorSelection
Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.geodatabase.esriTopologyRuleType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectable

public void setSelectable(int index,
                          boolean sel)
                   throws java.io.IOException,
                          AutomationException
Indicates if errors of a given rule type are selectable.

Specified by:
setSelectable in interface ITopologyErrorSelection
Parameters:
index - The index (in)
sel - The sel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSelectable

public boolean isSelectable(int index)
                     throws java.io.IOException,
                            AutomationException
Indicates if errors of a given rule type are selectable.

Specified by:
isSelectable in interface ITopologyErrorSelection
Parameters:
index - The index (in)
Returns:
The sel
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSelectExceptions

public boolean isSelectExceptions()
                           throws java.io.IOException,
                                  AutomationException
Indicates if exceptions are selectable.

Specified by:
isSelectExceptions in interface ITopologyErrorSelection
Returns:
The sel
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectExceptions

public void setSelectExceptions(boolean sel)
                         throws java.io.IOException,
                                AutomationException
Indicates if exceptions are selectable.

Specified by:
setSelectExceptions in interface ITopologyErrorSelection
Parameters:
sel - The sel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSelectErrors

public boolean isSelectErrors()
                       throws java.io.IOException,
                              AutomationException
Indicates if errors are selectable.

Specified by:
isSelectErrors in interface ITopologyErrorSelection
Returns:
The sel
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectErrors

public void setSelectErrors(boolean sel)
                     throws java.io.IOException,
                            AutomationException
Indicates if errors are selectable.

Specified by:
setSelectErrors in interface ITopologyErrorSelection
Parameters:
sel - The sel (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 GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSpatialReference in interface IGeoDataset
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.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IGeoDataset
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.

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws java.io.IOException,
                                   AutomationException
Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDrawingPropsDirty in interface ILayerDrawingProperties
Returns:
The dirty
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws java.io.IOException,
                                 AutomationException
Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDrawingPropsDirty in interface ILayerDrawingProperties
Parameters:
dirty - The dirty (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.

getLegendGroupCount

public int getLegendGroupCount()
                        throws java.io.IOException,
                               AutomationException
Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendGroupCount in interface ILegendInfo
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.IOException,
                                   AutomationException
Legend group at the specified index.

Product Availability

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

Specified by:
getLegendGroup in interface ILegendInfo
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ILegendGroup
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.IOException,
                                 AutomationException
Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendItem in interface ILegendInfo
Returns:
A reference to a com.esri.arcgis.carto.ILegendItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws java.io.IOException,
                                     AutomationException
Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSymbolsAreGraduated in interface ILegendInfo
Returns:
The symbolsAreGraduated
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.IOException,
                                   AutomationException
Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymbolsAreGraduated in interface ILegendInfo
Parameters:
symbolsAreGraduated - The symbolsAreGraduated (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerWeight

public double getLayerWeight()
                      throws java.io.IOException,
                             AutomationException
Default layer position.

Specified by:
getLayerWeight in interface ILayerPosition
Returns:
The layerWeight
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws java.io.IOException,
                           AutomationException
Default layer position.

Specified by:
setLayerWeight in interface ILayerPosition
Parameters:
layerWeight - The layerWeight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws java.io.IOException,
                            AutomationException
Indicates if the current object draws using a filter.

Specified by:
isUsesFilter in interface IDisplayAdmin
Returns:
The usesFilter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayFilter

public void setDisplayFilter(IDisplayFilter displayFilter)
                      throws java.io.IOException,
                             AutomationException
The display filter.

Specified by:
setDisplayFilter in interface IDisplayFilterManager
Parameters:
displayFilter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayFilter

public IDisplayFilter getDisplayFilter()
                                throws java.io.IOException,
                                       AutomationException
The display filter.

Specified by:
getDisplayFilter in interface IDisplayFilterManager
Returns:
A reference to a com.esri.arcgis.display.IDisplayFilter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws java.io.IOException,
                                      AutomationException
Indicates if the layer supports transparency.

Specified by:
isSupportsTransparency in interface ILayerEffects
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws java.io.IOException,
                                        AutomationException
Indicates if the layer supports contrast changes.

Specified by:
isSupportsContrastChange in interface ILayerEffects
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws java.io.IOException,
                                          AutomationException
Indicates if the layer supports brightness changes.

Specified by:
isSupportsBrightnessChange in interface ILayerEffects
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws java.io.IOException,
                                   AutomationException
Indicates if the layer supports interactive effects changes.

Specified by:
setSupportsInteractive in interface ILayerEffects
Parameters:
supported - The supported (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws java.io.IOException,
                                     AutomationException
Indicates if the layer supports interactive effects changes.

Specified by:
isSupportsInteractive in interface ILayerEffects
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws java.io.IOException,
                             AutomationException
Layer transparency in percent (0-100).

Specified by:
getTransparency in interface ILayerEffects
Returns:
The alpha
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws java.io.IOException,
                            AutomationException
Layer transparency in percent (0-100).

Specified by:
setTransparency in interface ILayerEffects
Parameters:
alpha - The alpha (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws java.io.IOException,
                         AutomationException
Layer contrast in percent (-100 - 100).

Specified by:
getContrast in interface ILayerEffects
Returns:
The contrastValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws java.io.IOException,
                        AutomationException
Layer contrast in percent (-100 - 100).

Specified by:
setContrast in interface ILayerEffects
Parameters:
contrastValue - The contrastValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws java.io.IOException,
                           AutomationException
Layer brightness in percent (-100 - 100).

Specified by:
getBrightness in interface ILayerEffects
Returns:
The brightnessValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws java.io.IOException,
                          AutomationException
Layer brightness in percent (-100 - 100).

Specified by:
setBrightness in interface ILayerEffects
Parameters:
brightnessValue - The brightnessValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws java.io.IOException,
                         AutomationException
Small image that represents the layer.

Specified by:
getSmallImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws java.io.IOException,
                                 AutomationException
Small image that represents the layer when it is selected.

Specified by:
getSmallSelectedImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws java.io.IOException,
                         AutomationException
Large image that represents the layer.

Specified by:
getLargeImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws java.io.IOException,
                                 AutomationException
Large image that represents the layer when it is selected.

Specified by:
getLargeSelectedImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsPublishing

public boolean isSupportsPublishing()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the layer supports the publishing process.

Specified by:
isSupportsPublishing in interface IPublishLayer
Returns:
The bValid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPublishingDescription

public java.lang.String getPublishingDescription()
                                          throws java.io.IOException,
                                                 AutomationException
The layer description reported to the publisher.

Specified by:
getPublishingDescription in interface IPublishLayer
Returns:
The bsDescription
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDataValid

public boolean isDataValid()
                    throws java.io.IOException,
                           AutomationException
Indicates if the data for the layer is currently valid.

Specified by:
isDataValid in interface IPublishLayer
Returns:
The bDataValid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataDetails

public java.lang.String getDataDetails(java.lang.String bsPadding)
                                throws java.io.IOException,
                                       AutomationException
Details of the layer's data.

Specified by:
getDataDetails in interface IPublishLayer
Parameters:
bsPadding - The bsPadding (in)
Returns:
The bsDataDetails
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

prepareForPublishing

public void prepareForPublishing()
                          throws java.io.IOException,
                                 AutomationException
Prepare the layer for the publishing process.

Specified by:
prepareForPublishing in interface IPublishLayer
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