NetworkLayer (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class NetworkLayer

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

All Implemented Interfaces:: IDataLayer, IDataLayer2, IIdentify, IIdentify2, ILayer, ILayer2, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILegendInfo, INetworkLayer, INetworkRendererCollection, IPublishLayer, ITimeData, ITimeData2, ITimeDataCustomUI, ITimeDataDisplay, IConnectionPointContainer, IDisplayAdmin, IDisplayFilterManager, IMapLevel, IDataset, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IPropertySupport, Externalizable, Serializable

public class NetworkLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, ILayer2, INetworkLayer, IDataset, INetworkRendererCollection, ITimeData, ITimeData2, ITimeDataDisplay, ITimeDataCustomUI, IGeoDataset, IPropertySupport, ILegendInfo, IIdentify, IIdentify2, IDataLayer, IDataLayer2, ILayerDrawingProperties, ILayerInfo, IDisplayAdmin, IDisplayFilterManager, ILayerEffects, ILayerExtensions, IMapLevel, IConnectionPointContainer, ILayerPosition, IPersistStream, IPublishLayer, ILayerGeneralProperties, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, ILayer2, INetworkLayer, IDataset, INetworkRendererCollection, ITimeData, ITimeData2, ITimeDataDisplay, ITimeDataCustomUI, IGeoDataset, IPropertySupport, ILegendInfo, IIdentify, IIdentify2, IDataLayer, IDataLayer2, ILayerDrawingProperties, ILayerInfo, IDisplayAdmin, IDisplayFilterManager, ILayerEffects, ILayerExtensions, IMapLevel, IConnectionPointContainer, ILayerPosition, IPersistStream, IPublishLayer, ILayerGeneralProperties, Externalizable

Esri Network Layer CoClass.

Remarks

The NetworkLayer is a type of Layer in the Map that holds a reference to a NetworkDataset. You can open its network dataset by calling INetworkLayer::NetworkDataset.

Product Availability

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

See Also:: Serialized Form

Constructor Summary
`NetworkLayer()` Constructs a NetworkLayer using ArcGIS Engine.
`NetworkLayer(Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `NetworkLayer theNetworkLayer = (NetworkLayer) obj;`

Method Summary
`void`	`add(INetworkRenderer renderer)` Adds a network renderer to the collection.
`void`	`addExtension(Object ext)` Adds a new extension.
`void`	`addILayerEventsListener(ILayerEvents theListener)` addILayerEventsListener.
`boolean`	`applies(Object pUnk)` Indicates if the receiver can apply the given object at any given time.
`Object`	`apply(Object newObject)` Applies the given property to the receiver and returns the old object.
`boolean`	`canApply(Object pUnk)` Indicates if the receiver can apply the given object at that particular moment.
`boolean`	`canCopy()` True if this dataset can be copied.
`boolean`	`canDelete()` True if this dataset can be deleted.
`boolean`	`canRename()` True if this dataset can be renamed.
`boolean`	`connect(IName pOptRepairName)` Connects the layer to its data source.
`IDataset`	`copy(String copyName, IWorkspace copyWorkspace)` Copies this dataset to a new dataset with the specified name.
`void`	`delete()` Deletes this dataset.
`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.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` enumConnectionPoints
`boolean`	`equals(Object o)` Compare this object with another
`void`	`expandRegionForSymbols(IDisplay display, IGeometry region)` Expands the given geometry by an amount that will include the layer's symbology for the given display.
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`IEnvelope`	`getAreaOfInterest()` The default area of interest for the layer.
`short`	`getBrightness()` Layer brightness in percent (-100 - 100).
`String`	`getBrowseName()` The browse name of the dataset.
`String`	`getCategory()` The category of the dataset.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static String`	`getClsid()` getClsid.
`short`	`getContrast()` Layer contrast in percent (-100 - 100).
`int`	`getCount()` Number of network renderers in the collection.
`Object`	`getCurrent(Object pUnk)` The object currently being used.
`String`	`getDataDetails(String bsPadding)` Details of the layer's data.
`IName`	`getDataSourceName()` Name of the data object for the layer.
`String`	`getDisplayAttribute()` The primary display network attribute.
`IDisplayFilter`	`getDisplayFilter()` The display filter.
`Object`	`getExtension(int index)` The extension at the specified index.
`int`	`getExtensionCount()` Number of extensions.
`IEnvelope`	`getExtent()` The extent of the GeoDataset.
`IName`	`getFullName()` The associated name object.
`ITimeExtent`	`getFullTimeExtent()` Returns the time extent for all the data in the layer.
`int`	`getLargeImage()` Large image that represents the layer.
`int`	`getLargeSelectedImage()` Large image that represents the layer when it is selected.
`double`	`getLastMaximumScale()` Last maximum scale setting used by layer.
`double`	`getLastMinimumScale()` Last minimum scale setting used by layer.
`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.
`int`	`getMapLevel()` Current map level for drawing multi-level symbols.
`double`	`getMaximumScale()` Maximum scale (representative fraction) at which the layer will display.
`double`	`getMinimumScale()` Minimum scale (representative fraction) at which the layer will display.
`String`	`getName()` Layer name.
`INetworkDataset`	`getNetworkDataset()` The Network Dataset used to define the layer.
`IPropertySet`	`getPropertySet()` The set of properties for the dataset.
`String`	`getPublishingDescription()` The layer description reported to the publisher.
`String`	`getRelativeBase()` Base path used when storing relative path names.
`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.
`IEnumDataset`	`getSubsets()` Datasets contained within this dataset.
`int`	`getSupportedDrawPhases()` Supported draw phases.
`double`	`getTimeInterval()` Returns recommended time interval to be used to animate this layer/ table.
`int`	`getTimeIntervalUnits()` Returns recommended time interval units to be used to animate this layer/ table.
`double`	`getTimeOffset()` Returns time offset that needs to be applied to the data for drawing.
`int`	`getTimeOffsetUnits()` Returns recommended time interval units to be used to animate this layer/ table.
`ITimeReference`	`getTimeReference()` Time reference for the contents of the layer.
`String`	`getTipText(double x, double y, double tolerance)` Map tip text at the specified location.
`short`	`getTransparency()` Layer transparency in percent (0-100).
`int`	`getType()` The type of the Dataset.
`IWorkspace`	`getWorkspace()` The workspace containing this dataset.
`int`	`hashCode()` the hashcode for this object
`IArray`	`identify(IGeometry pGeom)` Identifies objects at the specified location.
`IArray`	`identify(IGeometry pGeom, ITrackCancel pTrackCancel)` Identifies objects at the specified location.
`String`	`ILayerGeneralProperties_getLayerDescription()` Description for the layer.
`void`	`insert(INetworkRenderer renderer, int index)` Inserts a network renderer at the specified position in the collection.
`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`	`isHasLiveData()` isHasLiveData
`boolean`	`isScaleRangeReadOnly()` Indicates if the minimum and maximum scale range values are read-only.
`boolean`	`isScaleSymbols()` Indicates if symbols are scaled for the layer.
`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`	`isSupportsTime()` Indicates whether the layer has any time data.
`boolean`	`isSupportsTransparency()` Indicates if the layer supports transparency.
`boolean`	`isSymbolsAreGraduated()` Indicates if symbols are graduated.
`boolean`	`isTimeDataCumulative()` Indicates that features will be animated cumilatively.
`boolean`	`isUsesFilter()` Indicates if the current object draws using a filter.
`boolean`	`isUseTime()` Indicates whether to use the time for animation purposes.
`boolean`	`isValid()` Indicates if the layer is currently valid.
`boolean`	`isVisible()` Indicates if the layer is currently visible.
`boolean`	`isVisible(int index)` Indicates if a network renderer at the specific position is visible.
`void`	`load(IStream pstm)` load
`INetworkRenderer`	`next()` Retrieves the next network renderer in the enumeration.
`void`	`prepareForPublishing()` Prepare the layer for the publishing process.
`void`	`readExternal(ObjectInput in)`
`void`	`remove(INetworkRenderer renderer)` Removes a network renderer from the collection.
`void`	`removeAll()` Removes all of the network renderers from the collection.
`void`	`removeExtension(int index)` Removes the specified extension.
`void`	`removeILayerEventsListener(ILayerEvents theListener)` removeILayerEventsListener.
`void`	`rename(String name)` Renames this Dataset.
`void`	`reset()` Resets the enumeration sequence to the beginning.
`void`	`save(IStream pstm, int fClearDirty)` save
`IEnumLocatedNetworkElement`	`searchLocatedNetworkElements(String sourceName, IGeometry geometry)` Searches through the specified network dataset's source and returns an enumeration of network locations that intersect the input geometry.
`void`	`setAreaOfInterest(IEnvelope aoi)` The default area of interest for the layer.
`void`	`setBrightness(short brightnessValue)` Layer brightness in percent (-100 - 100).
`void`	`setBrowseName(String name)` The browse name of the dataset.
`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`	`setDisplayAttribute(String attName)` The primary display network attribute.
`void`	`setDisplayFilter(IDisplayFilter displayFilter)` The display filter.
`void`	`setDrawingPropsDirty(boolean dirty)` Indicates if the layer drawing properties are dirty.
`void`	`setHasLiveData(boolean useTime)` setHasLiveData
`void`	`setLayerDescription(String text)` Description for the layer.
`void`	`setLayerWeight(double layerWeight)` Default layer position.
`void`	`setMapLevel(int mapLevel)` Current map level for drawing multi-level symbols.
`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(String name)` Layer name.
`void`	`setNetworkDatasetByRef(INetworkDataset nds)` The Network Dataset used to define the layer.
`void`	`setRelativeBase(String basePath)` Base path used when storing relative path names.
`void`	`setScale(double rhs1)` The current scale of the display.
`void`	`setScaleSymbols(boolean scale)` Indicates if symbols are scaled for the layer.
`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`	`setTimeDataCumulative(boolean cumilative)` Indicates that features will be animated cumilatively.
`void`	`setTimeInterval(double interval)` Returns recommended time interval to be used to animate this layer/ table.
`void`	`setTimeIntervalUnits(int units)` Returns recommended time interval units to be used to animate this layer/ table.
`void`	`setTimeOffset(double timeOffset)` Returns time offset that needs to be applied to the data for drawing.
`void`	`setTimeOffsetUnits(int units)` Returns recommended time interval units to be used to animate this layer/ table.
`void`	`setTransparency(short alpha)` Layer transparency in percent (0-100).
`void`	`setUseTime(boolean useTime)` Indicates whether to use the time for animation purposes.
`void`	`setVisible(boolean visible)` Indicates if the layer is currently visible.
`void`	`setVisible(int index, boolean visible)` Indicates if a network renderer at the specific position is visible.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

NetworkLayer

public NetworkLayer()
             throws IOException,
                    UnknownHostException

Constructs a NetworkLayer using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

NetworkLayer

public NetworkLayer(Object obj)
             throws IOException

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

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

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

addILayerEventsListener

public void addILayerEventsListener(ILayerEvents theListener)
                             throws IOException

addILayerEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
Throws:: IOException - If there are communications problems.

removeILayerEventsListener

public void removeILayerEventsListener(ILayerEvents theListener)
                                throws IOException

removeILayerEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
Throws:: IOException - If there are communications problems.

getName

public String getName()
               throws 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
Specified by:: getName in interface ILayer2
Specified by:: getName in interface IDataset

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws 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
Specified by:: setName in interface ILayer2

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws 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
Specified by:: isValid in interface ILayer2

Returns:: The valid
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws 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
Specified by:: getAreaOfInterest in interface ILayer2

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws 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
Specified by:: getMinimumScale in interface ILayer2

Returns:: The minScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws 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
Specified by:: setMinimumScale in interface ILayer2

Parameters:: minScale - The minScale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws 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
Specified by:: getMaximumScale in interface ILayer2

Returns:: The maxScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws 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
Specified by:: setMaximumScale in interface ILayer2

Parameters:: maxScale - The maxScale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws 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
Specified by:: isVisible in interface ILayer2

Returns:: The visible
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws 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
Specified by:: setVisible in interface ILayer2

Parameters:: visible - The visible (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowTips

public boolean isShowTips()
                   throws 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
Specified by:: isShowTips in interface ILayer2

Returns:: The show
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws 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
Specified by:: setShowTips in interface ILayer2

Parameters:: show - The show (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTipText

public String getTipText(double x,
                         double y,
                         double tolerance)
                  throws 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
Specified by:: getTipText in interface ILayer2

Parameters:: x - The x (in); y - The y (in); tolerance - The tolerance (in)
Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws 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
Specified by:: isCached in interface ILayer2

Returns:: The cached
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws 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
Specified by:: setCached in interface ILayer2

Parameters:: cached - The cached (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws 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
Specified by:: getSupportedDrawPhases in interface ILayer2

Returns:: The drawPhases
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws 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
Specified by:: setSpatialReferenceByRef in interface ILayer2

Parameters:: rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws 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
Specified by:: draw in interface ILayer2

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws IOException,
                                    AutomationException

Indicates if the minimum and maximum scale range values are read-only.

Remarks

Some layer types do not support a writeable MinimumScale or MaximumScale. Use this property to determine whether or not a layer supports this.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isScaleRangeReadOnly in interface ILayer2

Returns:: The flag
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws IOException,
                              AutomationException

The default area of interest for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAreaOfInterest in interface ILayer2

Parameters:: aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getNetworkDataset

public INetworkDataset getNetworkDataset()
                                  throws IOException,
                                         AutomationException

The Network Dataset used to define the layer.

Product Availability

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

Specified by:: getNetworkDataset in interface INetworkLayer

Returns:: A reference to a com.esri.arcgis.geodatabase.INetworkDataset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setNetworkDatasetByRef

public void setNetworkDatasetByRef(INetworkDataset nds)
                            throws IOException,
                                   AutomationException

The Network Dataset used to define the layer.

Product Availability

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

Specified by:: setNetworkDatasetByRef in interface INetworkLayer

Parameters:: nds - A reference to a com.esri.arcgis.geodatabase.INetworkDataset (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplayAttribute

public String getDisplayAttribute()
                           throws IOException,
                                  AutomationException

The primary display network attribute.

Product Availability

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

Specified by:: getDisplayAttribute in interface INetworkLayer

Returns:: The attName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDisplayAttribute

public void setDisplayAttribute(String attName)
                         throws IOException,
                                AutomationException

The primary display network attribute.

Product Availability

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

Specified by:: setDisplayAttribute in interface INetworkLayer

Parameters:: attName - The attName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

public boolean isScaleSymbols()
                       throws IOException,
                              AutomationException

Indicates if symbols are scaled for the layer.

Product Availability

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

Specified by:: isScaleSymbols in interface INetworkLayer

Returns:: The scale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws IOException,
                            AutomationException

Indicates if symbols are scaled for the layer.

Product Availability

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

Specified by:: setScaleSymbols in interface INetworkLayer

Parameters:: scale - The scale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay display,
                                   IGeometry region)
                            throws IOException,
                                   AutomationException

Expands the given geometry by an amount that will include the layer's symbology for the given display.

Product Availability

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

Specified by:: expandRegionForSymbols in interface INetworkLayer

Parameters:: display - A reference to a com.esri.arcgis.display.IDisplay (in); region - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

searchLocatedNetworkElements

public IEnumLocatedNetworkElement searchLocatedNetworkElements(String sourceName,
                                                               IGeometry geometry)
                                                        throws IOException,
                                                               AutomationException

Searches through the specified network dataset's source and returns an enumeration of network locations that intersect the input geometry.

Product Availability

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

Specified by:: searchLocatedNetworkElements in interface INetworkLayer

Parameters:: sourceName - The sourceName (in); geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: A reference to a com.esri.arcgis.carto.IEnumLocatedNetworkElement
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The associated name object.

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFullName in interface IDataset

Returns:: A reference to a com.esri.arcgis.system.IName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException

The browse name of the dataset.

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBrowseName in interface IDataset

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(String name)
                   throws IOException,
                          AutomationException

The browse name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBrowseName in interface IDataset

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the Dataset.

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

Example:


// Assume we have a reference to an IfeatureClass (pFeatureClass)

      IDataset pDataset = null;


      pDataset = new IDatasetProxy(pFeatureClass);


      System.out.println(pDataset.getName() + " " + pDataset.getType());


      if(pFeatureClass != null){


        pDataset = pFeatureClass.getFeatureDataset();


        System.out.println(pDataset.getName() + " " + pDataset.getType());


      }


      pDataset = new IDatasetProxy(pDataset.getWorkspace());


     System.out.println(pDataset.getName() + " " + 
pDataset.getType());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getType in interface IDataset

Returns:: A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the dataset.

Remarks

IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCategory in interface IDataset

Returns:: The category
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws IOException,
                               AutomationException

Datasets contained within this dataset.

Description

The Subsets property returns other Dataset objects contained in this dataset.

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubsets in interface IDataset

Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The workspace containing this dataset.

Description

The Workspace property returns the containing workspace for this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWorkspace in interface IDataset

Returns:: A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

The set of properties for the dataset.

Description

The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.

Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPropertySet in interface IDataset

Returns:: A reference to a com.esri.arcgis.system.IPropertySet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException

True if this dataset can be copied.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

CAD Drawings
Coverages
DBase Tables
Info Tables
Raster Datasets
SDC datasets
SDC Network Datasets
Shapefiles
Shapefile Network Datasets

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canCopy in interface IDataset

Returns:: The canCopy
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(String copyName,
                     IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException

Copies this dataset to a new dataset with the specified name.

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: copy in interface IDataset

Parameters:: copyName - The copyName (in); copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException

True if this dataset can be deleted.

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canDelete in interface IDataset

Returns:: The canDelete
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes this dataset.

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: delete in interface IDataset

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException

True if this dataset can be renamed.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canRename in interface IDataset

Returns:: The canRename
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rename

public void rename(String name)
            throws IOException,
                   AutomationException

Renames this Dataset.

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rename in interface IDataset

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

add

public void add(INetworkRenderer renderer)
         throws IOException,
                AutomationException

Adds a network renderer to the collection.

Product Availability

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

Specified by:: add in interface INetworkRendererCollection

Parameters:: renderer - A reference to a com.esri.arcgis.carto.INetworkRenderer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

remove

public void remove(INetworkRenderer renderer)
            throws IOException,
                   AutomationException

Removes a network renderer from the collection.

Product Availability

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

Specified by:: remove in interface INetworkRendererCollection

Parameters:: renderer - A reference to a com.esri.arcgis.carto.INetworkRenderer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Removes all of the network renderers from the collection.

Product Availability

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

Specified by:: removeAll in interface INetworkRendererCollection

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

insert

public void insert(INetworkRenderer renderer,
                   int index)
            throws IOException,
                   AutomationException

Inserts a network renderer at the specified position in the collection.

Product Availability

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

Specified by:: insert in interface INetworkRendererCollection

Parameters:: renderer - A reference to a com.esri.arcgis.carto.INetworkRenderer (in); index - The index (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible(int index)
                  throws IOException,
                         AutomationException

Indicates if a network renderer at the specific position is visible.

Product Availability

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

Specified by:: isVisible in interface INetworkRendererCollection

Parameters:: index - The index (in)
Returns:: The visible
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(int index,
                       boolean visible)
                throws IOException,
                       AutomationException

Indicates if a network renderer at the specific position is visible.

Product Availability

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

Specified by:: setVisible in interface INetworkRendererCollection

Parameters:: index - The index (in); visible - The visible (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

Number of network renderers in the collection.

Product Availability

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

Specified by:: getCount in interface INetworkRendererCollection

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Resets the enumeration sequence to the beginning.

Product Availability

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

Specified by:: reset in interface INetworkRendererCollection

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

public INetworkRenderer next()
                      throws IOException,
                             AutomationException

Retrieves the next network renderer in the enumeration.

Product Availability

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

Specified by:: next in interface INetworkRendererCollection

Returns:: A reference to a com.esri.arcgis.carto.INetworkRenderer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsTime

public boolean isSupportsTime()
                       throws IOException,
                              AutomationException

Indicates whether the layer has any time data.

Description

This property indicates whether the layer is able to render time-related data. If this property is false, it means that time-related data cannot be handled by the underlying software.

Product Availability

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

Specified by:: isSupportsTime in interface ITimeData

Returns:: The hasTime
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUseTime

public boolean isUseTime()
                  throws IOException,
                         AutomationException

Indicates whether to use the time for animation purposes.

Description

This property indicates whether the meta-data used to properly configure time-related rendering has been provided. The property is also used to indicate whether the layer should use the time-related meta-data to render time-related data. If the property is false, it can mean two things:

1. The layer has not yet been provided with information like the name of the attribute in the data which contains the time of each feature.

2. The layer has simply been told not to display time-related data. This may be a temporary state change desired by a user that does not want the layer to change when running an animation.

Product Availability

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

Specified by:: isUseTime in interface ITimeData

Returns:: The useTime
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setUseTime

public void setUseTime(boolean useTime)
                throws IOException,
                       AutomationException

Indicates whether to use the time for animation purposes.

Product Availability

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

Specified by:: setUseTime in interface ITimeData

Parameters:: useTime - The useTime (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

Time reference for the contents of the layer.

Description

This is the time reference for the data that this layer is rendering/providing. This property is read-only in the ITimeData interface because not all layers have the ability to change the TimeReference property of the data they represent. If the layer has the ability to change this property, it will implement the ITimeTableDefinition interface, and through that interface provide the ability to change the property's value.

Product Availability

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

Specified by:: getTimeReference in interface ITimeData

Returns:: A reference to a com.esri.arcgis.system.ITimeReference
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws IOException,
                                     AutomationException

Returns the time extent for all the data in the layer.

Description

This property provides a TimeExtent which represents the time from the earliest time stamp in the data to the latests time stamp in the data.

Product Availability

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

Specified by:: getFullTimeExtent in interface ITimeData

Returns:: A reference to a com.esri.arcgis.system.ITimeExtent
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasLiveData

public boolean isHasLiveData()
                      throws IOException,
                             AutomationException

isHasLiveData

Product Availability

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

Specified by:: isHasLiveData in interface ITimeData2

Returns:: The useTime
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHasLiveData

public void setHasLiveData(boolean useTime)
                    throws IOException,
                           AutomationException

setHasLiveData

Product Availability

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

Specified by:: setHasLiveData in interface ITimeData2

Parameters:: useTime - The useTime (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeDataCumulative

public void setTimeDataCumulative(boolean cumilative)
                           throws IOException,
                                  AutomationException

Indicates that features will be animated cumilatively.

Product Availability

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

Specified by:: setTimeDataCumulative in interface ITimeDataDisplay

Parameters:: cumilative - The cumilative (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isTimeDataCumulative

public boolean isTimeDataCumulative()
                             throws IOException,
                                    AutomationException

Indicates that features will be animated cumilatively.

Description

TimeDataCumulative is true when the data should be persist on the display as it ages. This is useful in settings where the new data "builds upon" historical data. For example when displaying the location of a wild animal, this property will cause the layer to display all of the historical locations for the animal, providing a good view of the animal's territory.

Product Availability

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

Specified by:: isTimeDataCumulative in interface ITimeDataDisplay

Returns:: The cumilative
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeInterval

public void setTimeInterval(double interval)
                     throws IOException,
                            AutomationException

Returns recommended time interval to be used to animate this layer/ table.

Product Availability

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

Specified by:: setTimeInterval in interface ITimeDataDisplay

Parameters:: interval - The interval (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeInterval

public double getTimeInterval()
                       throws IOException,
                              AutomationException

Returns recommended time interval to be used to animate this layer/ table.

Description

This property represents the time interval of the data used when rendering the layer. The time interval represents the minimum expected time between changes in the data. For example, when using weather imagery that is updated every 10 minutes, you would set the time interval to 10 minutes. When using census data that is recorded every year, the time interval would be set to 1 year. Note that this property is the value of the interval, and must be set along with the units for the time interval.

Product Availability

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

Specified by:: getTimeInterval in interface ITimeDataDisplay

Returns:: The interval
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeIntervalUnits

public void setTimeIntervalUnits(int units)
                          throws IOException,
                                 AutomationException

Returns recommended time interval units to be used to animate this layer/ table.

Product Availability

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

Specified by:: setTimeIntervalUnits in interface ITimeDataDisplay

Parameters:: units - A com.esri.arcgis.system.esriTimeUnits constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

public int getTimeIntervalUnits()
                         throws IOException,
                                AutomationException

Returns recommended time interval units to be used to animate this layer/ table.

Description

This property is the enumerated value representing the time units used when measuring the time interval. This property should be read/written along with the time interval value. For more information about the time interval, see the documentation on the TimeInterval property.

Product Availability

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

Specified by:: getTimeIntervalUnits in interface ITimeDataDisplay

Returns:: A com.esri.arcgis.system.esriTimeUnits constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeOffset

public void setTimeOffset(double timeOffset)
                   throws IOException,
                          AutomationException

Returns time offset that needs to be applied to the data for drawing.

Product Availability

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

Specified by:: setTimeOffset in interface ITimeDataDisplay

Parameters:: timeOffset - The timeOffset (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeOffset

public double getTimeOffset()
                     throws IOException,
                            AutomationException

Returns time offset that needs to be applied to the data for drawing.

Description

The TimeOffset is used to display data at a different time on the timeline. This is for temporary purposes only. It can be useful for comparing data sets from different time period when you need to display the two sets of data together. For example, to visualize the growth pattern of two wild fires that happened in two different years, one of the layers can be given an offset that will cause it to appear as if the fire started at the same time as the other fire. In this way the growth patterns can be seen together, and compared.

Product Availability

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

Specified by:: getTimeOffset in interface ITimeDataDisplay

Returns:: The timeOffset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeOffsetUnits

public void setTimeOffsetUnits(int units)
                        throws IOException,
                               AutomationException

Returns recommended time interval units to be used to animate this layer/ table.

Product Availability

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

Specified by:: setTimeOffsetUnits in interface ITimeDataDisplay

Parameters:: units - A com.esri.arcgis.system.esriTimeUnits constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeOffsetUnits

public int getTimeOffsetUnits()
                       throws IOException,
                              AutomationException

Returns recommended time interval units to be used to animate this layer/ table.

Description

This property is the enumerated value representing the time units used when measuring the time offset. This property should be read/written along with the time offset value. For more information about the time offset, see the documentation on the TimeOffset property.

Product Availability

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

Specified by:: getTimeOffsetUnits in interface ITimeDataDisplay

Returns:: A com.esri.arcgis.system.esriTimeUnits constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: applies in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The applies
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canApply in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The canApply
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

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

Specified by:: getCurrent in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: apply in interface IPropertySupport

Parameters:: newObject - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: identify in interface IIdentify

Parameters:: pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom,
                       ITrackCancel pTrackCancel)
                throws IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: identify in interface IIdentify2

Parameters:: pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in); pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(double rhs1)
              throws IOException,
                     AutomationException

The current scale of the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScale in interface IIdentify2

Parameters:: rhs1 - The rhs1 (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDataSourceName

public IName getDataSourceName()
                        throws IOException,
                               AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDataSourceName in interface IDataLayer
Specified by:: getDataSourceName in interface IDataLayer2

Returns:: A reference to a com.esri.arcgis.system.IName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws IOException,
                              AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws IOException,
                                     AutomationException

Indicates if the specified data object name is supported by the layer.

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws IOException,
                       AutomationException

Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public String getRelativeBase()
                       throws IOException,
                              AutomationException

Base path used when storing relative path names.

Remarks

The RelativeBase property is used internally when persisting and loading documents with a relative path. When a document has been fully loaded the path is realized to a complete path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRelativeBase in interface IDataLayer
Specified by:: getRelativeBase in interface IDataLayer2

Returns:: The basePath
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(String basePath)
                     throws IOException,
                            AutomationException

Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setRelativeBase in interface IDataLayer
Specified by:: setRelativeBase in interface IDataLayer2

Parameters:: basePath - The basePath (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException

Disconnects the data from the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: disconnect in interface IDataLayer2

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws IOException,
                           AutomationException

Returns TRUE if the layer is in the specified workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: inWorkspace in interface IDataLayer2

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

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException

Small image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSmallImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws IOException,
                                 AutomationException

Small image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSmallSelectedImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException

Large image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLargeImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws IOException,
                                 AutomationException

Large image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLargeSelectedImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException

Indicates if the current object draws using a filter.

Remarks

The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUsesFilter in interface IDisplayAdmin

Returns:: The usesFilter
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDisplayFilter

public void setDisplayFilter(IDisplayFilter displayFilter)
                      throws IOException,
                             AutomationException

The display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDisplayFilter in interface IDisplayFilterManager

Parameters:: displayFilter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplayFilter

public IDisplayFilter getDisplayFilter()
                                throws IOException,
                                       AutomationException

The display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplayFilter in interface IDisplayFilterManager

Returns:: A reference to a com.esri.arcgis.display.IDisplayFilter
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws IOException,
                                      AutomationException

Indicates if the layer supports transparency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsTransparency in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws IOException,
                                        AutomationException

Indicates if the layer supports contrast changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsContrastChange in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws IOException,
                                          AutomationException

Indicates if the layer supports brightness changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsBrightnessChange in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSupportsInteractive in interface ILayerEffects

Parameters:: supported - The supported (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws IOException,
                                     AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsInteractive in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws IOException,
                             AutomationException

Layer transparency in percent (0-100).

Remarks

When you set Transparency for a FeatureLayer, a TransparencyDisplayFilter is created and applied to the layer. You can accomplish the same effect by manually creating a new TransparencyDisplayFilter using IDisplayFilter, and then assigning it to a layer using IDisplayFilterManager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTransparency in interface ILayerEffects

Returns:: The alpha
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws IOException,
                            AutomationException

Layer transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setTransparency in interface ILayerEffects

Parameters:: alpha - The alpha (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getContrast in interface ILayerEffects

Returns:: The contrastValue
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setContrast in interface ILayerEffects

Parameters:: contrastValue - The contrastValue (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBrightness in interface ILayerEffects

Returns:: The brightnessValue
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBrightness in interface ILayerEffects

Parameters:: brightnessValue - The brightnessValue (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws IOException,
                             AutomationException

Number of extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtensionCount in interface ILayerExtensions

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtension

public Object getExtension(int index)
                    throws IOException,
                           AutomationException

The extension at the specified index.

Product Availability

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

Specified by:: getExtension in interface ILayerExtensions

Parameters:: index - The index (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(Object ext)
                  throws IOException,
                         AutomationException

Adds a new extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addExtension in interface ILayerExtensions

Parameters:: ext - A reference to another Object (IUnknown) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws IOException,
                            AutomationException

Removes the specified extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeExtension in interface ILayerExtensions

Parameters:: index - The index (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMapLevel

public int getMapLevel()
                throws IOException,
                       AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMapLevel in interface IMapLevel

Returns:: The mapLevel
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws IOException,
                        AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMapLevel in interface IMapLevel

Parameters:: mapLevel - The mapLevel (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: enumConnectionPoints in interface IConnectionPointContainer

Parameters:: ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findConnectionPoint in interface IConnectionPointContainer

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in); ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLayerWeight

public double getLayerWeight()
                      throws IOException,
                             AutomationException

Default layer position.

Description

The LayerWeight property defines the weight of the layer in the auto arrange order. During auto arrange, the higher weight layers are added to the map first, which means they draw lower in the draw order.

Default weights for layers are these values:
Annotation layers = 97
Points layers = 98
Polyline layers = 99
Polygon Layers = 100

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLayerWeight in interface ILayerPosition

Returns:: The layerWeight
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws IOException,
                           AutomationException

Default layer position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLayerWeight in interface ILayerPosition

Parameters:: layerWeight - The layerWeight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDirty in interface IPersistStream

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsPublishing

public boolean isSupportsPublishing()
                             throws IOException,
                                    AutomationException

Indicates if the layer supports the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsPublishing in interface IPublishLayer

Returns:: The bValid
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPublishingDescription

public String getPublishingDescription()
                                throws IOException,
                                       AutomationException

The layer description reported to the publisher.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPublishingDescription in interface IPublishLayer

Returns:: The bsDescription
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDataValid

public boolean isDataValid()
                    throws IOException,
                           AutomationException

Indicates if the data for the layer is currently valid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDataValid in interface IPublishLayer

Returns:: The bDataValid
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDataDetails

public String getDataDetails(String bsPadding)
                      throws IOException,
                             AutomationException

Details of the layer's data.

Product Availability

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

Specified by:: getDataDetails in interface IPublishLayer

Parameters:: bsPadding - The bsPadding (in)
Returns:: The bsDataDetails
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

prepareForPublishing

public void prepareForPublishing()
                          throws IOException,
                                 AutomationException

Prepare the layer for the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: prepareForPublishing in interface IPublishLayer

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

public double getLastMinimumScale()
                           throws IOException,
                                  AutomationException

Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLastMinimumScale in interface ILayerGeneralProperties

Returns:: The minScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws IOException,
                                  AutomationException

Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLastMaximumScale in interface ILayerGeneralProperties

Returns:: The maxScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public String ILayerGeneralProperties_getLayerDescription()
                                                   throws IOException,
                                                          AutomationException

Description for the layer.

Product Availability

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

Specified by:: ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties

Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(String text)
                         throws IOException,
                                AutomationException

Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLayerDescription in interface ILayerGeneralProperties

Parameters:: text - The text (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable

Throws:: IOException; ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto Class NetworkLayer

Remarks

Product Availability

NetworkLayer

NetworkLayer

getClsid

equals

hashCode

addILayerEventsListener

removeILayerEventsListener

getName

Description

Remarks

Product Availability

Supported Platforms

setName

Description

Product Availability

Supported Platforms

isValid

Remarks

Product Availability

Supported Platforms

getAreaOfInterest

Remarks

Product Availability

Supported Platforms

getMinimumScale

Remarks

Product Availability

Supported Platforms

setMinimumScale

Description

Product Availability

Supported Platforms

getMaximumScale

Remarks

Product Availability

Supported Platforms

setMaximumScale

Description

Product Availability

Supported Platforms

isVisible

Product Availability

Supported Platforms

setVisible

Description

Product Availability

Supported Platforms

isShowTips

Remarks

Product Availability

Supported Platforms

setShowTips

Description

Product Availability

Supported Platforms

getTipText

Product Availability

isCached

Remarks

Product Availability

Supported Platforms

setCached

Description

Remarks

Product Availability

Supported Platforms

getSupportedDrawPhases

Remarks

Product Availability

Supported Platforms

setSpatialReferenceByRef

Remarks

Product Availability

Supported Platforms

draw

Remarks

Product Availability

com.esri.arcgis.carto
Class NetworkLayer