com.esri.arcgis.networkanalyst
Class NALayer

java.lang.Object
  com.esri.arcgis.networkanalyst.NALayer

All Implemented Interfaces:

ICompositeLayer, ICompositeLayer2, IDataLayer, IDataLayer2, IIdentify, IIdentify2, IIdentifyGroup, ILayer, ILayer2, ILayerDrawingProperties, ILayerExtensions, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerSymbologyExtents, IPublishLayer, IStandaloneTableCollection, ISymbolLevels, IConnectionPointContainer, IDisplayAdmin, IDisplayAdmin2, IMapLevel, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, INALayer, INALayer2, INALayer3, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class NALayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INALayer, INALayer2, INALayer3, ILayer, ILayer2, ILayerInfo, ILayerExtensions, IGeoDataset, IDataLayer, IDataLayer2, ICompositeLayer, ICompositeLayer2, IStandaloneTableCollection, IIdentify, IIdentify2, IIdentifyGroup, IDisplayAdmin, IDisplayAdmin2, ILayerPosition, IMapLevel, ILayerDrawingProperties, ILayerGeneralProperties, ILayerSymbologyExtents, ISymbolLevels, IPublishLayer, IPersist, IPersistStream, IConnectionPointContainer, ISupportErrorInfo, Externalizable

The layer for defining, solving, and viewing network analysis results.

Remarks

NALayer is a composite layer that holds a reference to the NAContext and exposes the NAClasses within the NAContext as feature layers.

The NALayer behaves like any other composite layer within ArcGIS. Use ICompositeLayer and ICompositeLayer2 to access these properties.

It is possible to find an NALayer in ArcMap by enumerating through the layers in the table of contents and checking to see which ones implement the interface INALayer. Or, you can determine the NALayer currently selected in the network analyst window by asking the NAWindow for its ActiveAnalysis.

The entire NAContext, including the contents of the NAClasses, is persisted within the NALayer. If there are a lot of NALocationFeatures in the NAContext, the size of the NALayer saved in a map document and in a layer file could be large. The NATraversalResult is not persisted within the NALayer.

In ArcGIS Server, starting a MapServer with multiple pooled objects that contain NALayers may cause some NALayers to not bind to their internal network dataset due to contention opening the network dataset. By default, the NALayer retries connecting to the network dataset for 60 seconds before returning a failure. If 60 seconds is not the appropriate amount of time for your server, create a registry key named "HKEY_LOCAL_MACHINE\Software\ESRI\ArcServer\NetworkAnalyst\OpenTimeout" of type DWORD with a decimal value between 0 and 600 which specifies the amount of time you would like to retry opening the network dataset before failing. A value of 600 would mean keep trying to open the network analysis layer's network dataset for 10 minutes before failing. Setting it to 0 would indicate to fail immediately if it could not connect to the network dataset on it's first attempt. This is only applicable to ArcGIS Server MapServer objects containing NALayers.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NALayer()
Constructs a NALayer using ArcGIS Engine.

NALayer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NALayer theNALayer = (NALayer) obj;

Method Summary

void	add(ILayer layer) Add a new layer.
void	addExtension(Object ext) Adds a new extension.
void	addILayerEventsListener(ILayerEvents theListener) addILayerEventsListener.
void	addINALayerEventsListener(INALayerEvents theListener) addINALayerEventsListener.
void	addStandaloneTable(IStandaloneTable table) Adds a standalone table to the collection.
void	attachContext(INAContext nAContext) Sets the NALayer to reference the NAContext and the sublayers to reference the NAClasses of the NAContext.
void	clear() Clear all analysis layers.
boolean	connect(IName pOptRepairName) Connects the layer to its data source.
INAContext	copyContext() Returns a copy of the NAContext referenced by the NALayer.
void	delete(ILayer layer) Delete an existing layer.
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 pDisplay, IGeometry pRegion) Enlarges the specified region if necessary to account for the symbology sizes.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
int	findDataLayerByNAClassName(String name) The index of the named datalayer in the collection of DataLayers of the network analysis layer.
int	getAllDataLayerCount() The total number of data layers (layers and standalone tables) in the network analysis layer.
int	getAllLayerCount() The total number of layers in the network analysis layer.
int	getAllStandaloneTableCount() The total number of standalone tables in the network analysis layer.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
INAContext	getContext() The network analysis context.
int	getCount() Number of layers in the collection.
String	getDataDetails(String bsPadding) Details of the layer's data.
IDataLayer	getDataLayer(int index) The datalayer at the specified index in the collection of DataLayers of the network analysis layer.
IDataLayer	getDataLayerByNAClassName(String name) The network analysis layer or standalone table by class name.
IName	getDataSourceName() Name of the data object for the layer.
Object	getExtension(int index) The extension at the specified index.
int	getExtensionCount() Number of extensions.
IEnvelope	getExtent() The extent of the GeoDataset.
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.
ILayer	getLayer(int index) Layer in the collection at the specified index.
ILayer	getLayerByNAClassName(String name) The network analysis layer by class name.
double	getLayerWeight() Default layer position.
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.
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.
IStandaloneTable	getStandaloneTable(int index) The standalone table at the given index.
int	getStandaloneTableCount() Number of standalone tables.
int	getSupportedDrawPhases() Supported draw phases.
String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
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	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	inWorkspace(IWorkspace workspace) Returns TRUE if the layer is in the specified workspace.
boolean	isAccessible(int index) Indicates whether the datalayer at the specified index in the collection of DataLayers of the network analysis layer is accessible by ICompositeLayer methods.
boolean	isCached() Indicates if the layer needs its own display cache.
boolean	isCanRestrictAccessibility(int index) Indicates whether the datalayer at the specified index in the collection of DataLayers of the network analysis layer can be hidden from ICompositeLayer methods.
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	isDoesBlending() Indicates whether the drawing object blends its output with the background.
boolean	isDrawingPropsDirty() Indicates if the layer drawing properties are dirty.
boolean	isExpanded() Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.
boolean	isRequiresBanding() Indicates whether the output from the drawing object requires banding.
boolean	isScaleRangeReadOnly() Indicates if the minimum and maximum scale range values are read-only.
boolean	isShowTips() Indicates if the layer shows map tips.
boolean	isSupportsPublishing() Indicates if the layer supports the publishing process.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
boolean	isUseSymbolLevels() Indicates if symbol levels are used for drawing.
boolean	isValid() Indicates if the layer is currently valid.
boolean	isVisible() Indicates if the layer is currently visible.
void	load(IStream pstm) load
void	prepareForPublishing() Prepare the layer for the publishing process.
void	readExternal(ObjectInput in)
void	removeAllStandaloneTables() Removes all standalone tables from the collection.
void	removeExtension(int index) Removes the specified extension.
void	removeILayerEventsListener(ILayerEvents theListener) removeILayerEventsListener.
void	removeINALayerEventsListener(INALayerEvents theListener) removeINALayerEventsListener.
void	removeStandaloneTable(IStandaloneTable table) Removes the standalone table from the collection.
void	reorder(ILongArray reorderedIndices) Reorders the data layers in the network analysis layer based on the input array containing the new datalayer index value for each current index.
void	save(IStream pstm, int fClearDirty) save
void	setAccessible(int index, boolean flag) Indicates whether the datalayer at the specified index in the collection of DataLayers of the network analysis layer is accessible by ICompositeLayer methods.
void	setAreaOfInterest(IEnvelope aoi) The default area of interest for the layer.
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setContextByRef(INAContext nAContext) The network analysis context.
void	setDataSourceName(IName name) Name of the data object for the layer.
void	setDrawingPropsDirty(boolean dirty) Indicates if the layer drawing properties are dirty.
void	setExpanded(boolean expanded) Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.
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	setRelativeBase(String basePath) Base path used when storing relative path names.
void	setScale(double rhs1) The current scale of the display.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setUseSymbolLevels(boolean useSymbolLevels) Indicates if symbol levels are used for drawing.
void	setVisible(boolean visible) Indicates if the layer is currently 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

NALayer

public NALayer()
        throws IOException,
               UnknownHostException

Constructs a NALayer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NALayer

public NALayer(Object obj)
        throws IOException

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

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

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.

addINALayerEventsListener

public void addINALayerEventsListener(INALayerEvents theListener)
                               throws IOException

addINALayerEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.networkanalyst.INALayerEvents interface.

Throws:

IOException - If there are communications problems.

removeINALayerEventsListener

public void removeINALayerEventsListener(INALayerEvents theListener)
                                  throws IOException

removeINALayerEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.networkanalyst.INALayerEvents interface.

Throws:

IOException - If there are communications problems.

setContextByRef

public void setContextByRef(INAContext nAContext)
                     throws IOException,
                            AutomationException

The network analysis context.

Remarks

Sets the NAContext associated with the NALayer. If this is done, it is also necessary to re-attach the sublayers to the NAClasses of the new NAContext as well.

Use INALayer2::AttachContext instead if you want to re-attach a context created with INALayer2::CopyContext since this will re-attach the sublayers for you.

Product Availability

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

Specified by:

setContextByRef in interface INALayer

Parameters:

nAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContext

public INAContext getContext()
                      throws IOException,
                             AutomationException

The network analysis context.

Remarks

Returns the NAContext associated with the NALayer.

Product Availability

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

Specified by:

getContext in interface INALayer

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAContext

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerByNAClassName

public ILayer getLayerByNAClassName(String name)
                             throws IOException,
                                    AutomationException

The network analysis layer by class name.

Product Availability

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

Specified by:

getLayerByNAClassName in interface INALayer

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(ILayer layer)
         throws IOException,
                AutomationException

Add a new layer.

Remarks

Adds a sublayer into the NALayer.

Product Availability

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

Specified by:

add in interface INALayer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete(ILayer layer)
            throws IOException,
                   AutomationException

Delete an existing layer.

Remarks

Removes a sublayer from the NALayer.

Product Availability

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

Specified by:

delete in interface INALayer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Clear all analysis layers.

Remarks

Removes all of the sublayers from the NALayer.

Product Availability

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

Specified by:

clear in interface INALayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpanded

public boolean isExpanded()
                   throws IOException,
                          AutomationException

Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.

Remarks

Specifies if the NALayer is expanded.

Product Availability

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

Specified by:

isExpanded in interface ICompositeLayer2

Specified by:

isExpanded in interface INALayer

Returns:

The expanded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpanded

public void setExpanded(boolean expanded)
                 throws IOException,
                        AutomationException

Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.

Remarks

Specifies if the NALayer is expanded.

Product Availability

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

Specified by:

setExpanded in interface ICompositeLayer2

Specified by:

setExpanded in interface INALayer

Parameters:

expanded - The expanded (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copyContext

public INAContext copyContext()
                       throws IOException,
                              AutomationException

Returns a copy of the NAContext referenced by the NALayer.

Remarks

CopyContext makes a copy of the NALayer's NAContext that can later be re-applied to the NALayer. This method should only be used in conjunction with the AttachContext within Server or Engine applications.

Product Availability

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

Specified by:

copyContext in interface INALayer2

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAContext

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attachContext

public void attachContext(INAContext nAContext)
                   throws IOException,
                          AutomationException

Sets the NALayer to reference the NAContext and the sublayers to reference the NAClasses of the NAContext.

Remarks

AttachContext sets the NALayer's NAContext to be the input context and reconnects the NALayer's sublayers to the context.

You must first call INAContextEdit.Bind on the NAContext prior to passing it in to AttachContext.

This method should only be used with NAContext objects created via INALayer2.CopyContext. It should also only be used within Server or Engine applications, using these functions within ArcMap will lead to unexpected behavior within the Network Analyst tools.

Product Availability

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

Specified by:

attachContext in interface INALayer2

Parameters:

nAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataLayerByNAClassName

public IDataLayer getDataLayerByNAClassName(String name)
                                     throws IOException,
                                            AutomationException

The network analysis layer or standalone table by class name.

Product Availability

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

Specified by:

getDataLayerByNAClassName in interface INALayer2

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllDataLayerCount

public int getAllDataLayerCount()
                         throws IOException,
                                AutomationException

The total number of data layers (layers and standalone tables) in the network analysis layer.

Product Availability

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

Specified by:

getAllDataLayerCount in interface INALayer3

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllLayerCount

public int getAllLayerCount()
                     throws IOException,
                            AutomationException

The total number of layers in the network analysis layer.

Product Availability

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

Specified by:

getAllLayerCount in interface INALayer3

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllStandaloneTableCount

public int getAllStandaloneTableCount()
                               throws IOException,
                                      AutomationException

The total number of standalone tables in the network analysis layer.

Product Availability

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

Specified by:

getAllStandaloneTableCount in interface INALayer3

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findDataLayerByNAClassName

public int findDataLayerByNAClassName(String name)
                               throws IOException,
                                      AutomationException

The index of the named datalayer in the collection of DataLayers of the network analysis layer.

Product Availability

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

Specified by:

findDataLayerByNAClassName in interface INALayer3

Parameters:

name - The name (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataLayer

public IDataLayer getDataLayer(int index)
                        throws IOException,
                               AutomationException

The datalayer at the specified index in the collection of DataLayers of the network analysis layer.

Product Availability

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

Specified by:

getDataLayer in interface INALayer3

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanRestrictAccessibility

public boolean isCanRestrictAccessibility(int index)
                                   throws IOException,
                                          AutomationException

Indicates whether the datalayer at the specified index in the collection of DataLayers of the network analysis layer can be hidden from ICompositeLayer methods.

Product Availability

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

Specified by:

isCanRestrictAccessibility in interface INALayer3

Parameters:

index - The index (in)

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAccessible

public boolean isAccessible(int index)
                     throws IOException,
                            AutomationException

Indicates whether the datalayer at the specified index in the collection of DataLayers of the network analysis layer is accessible by ICompositeLayer methods.

Product Availability

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

Specified by:

isAccessible in interface INALayer3

Parameters:

index - The index (in)

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAccessible

public void setAccessible(int index,
                          boolean flag)
                   throws IOException,
                          AutomationException

Indicates whether the datalayer at the specified index in the collection of DataLayers of the network analysis layer is accessible by ICompositeLayer methods.

Product Availability

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

Specified by:

setAccessible in interface INALayer3

Parameters:

index - The index (in)

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reorder

public void reorder(ILongArray reorderedIndices)
             throws IOException,
                    AutomationException

Reorders the data layers in the network analysis layer based on the input array containing the new datalayer index value for each current index.

Product Availability

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

Specified by:

reorder in interface INALayer3

Parameters:

reorderedIndices - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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

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.

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.

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.

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.

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.

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.

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.

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.

getCount

public int getCount()
             throws IOException,
                    AutomationException

Number of layers in the collection.

Description

Returns the count, or number of layers. Use the methods in the IGroupLayer interface to manage the contents of GroupLayers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface ICompositeLayer

Specified by:

getCount in interface ICompositeLayer2

Returns:

The layerCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int index)
                throws IOException,
                       AutomationException

Layer in the collection at the specified index.

Product Availability

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

Specified by:

getLayer in interface ICompositeLayer

Specified by:

getLayer in interface ICompositeLayer2

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandaloneTableCount

public int getStandaloneTableCount()
                            throws IOException,
                                   AutomationException

Number of standalone tables.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStandaloneTableCount in interface IStandaloneTableCollection

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandaloneTable

public IStandaloneTable getStandaloneTable(int index)
                                    throws IOException,
                                           AutomationException

The standalone table at the given index.

Product Availability

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

Specified by:

getStandaloneTable in interface IStandaloneTableCollection

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addStandaloneTable

public void addStandaloneTable(IStandaloneTable table)
                        throws IOException,
                               AutomationException

Adds a standalone table to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addStandaloneTable in interface IStandaloneTableCollection

Parameters:

table - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeStandaloneTable

public void removeStandaloneTable(IStandaloneTable table)
                           throws IOException,
                                  AutomationException

Removes the standalone table from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeStandaloneTable in interface IStandaloneTableCollection

Parameters:

table - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllStandaloneTables

public void removeAllStandaloneTables()
                               throws IOException,
                                      AutomationException

Removes all standalone tables from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAllStandaloneTables in interface IStandaloneTableCollection

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.

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

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

Specified by:

isUsesFilter in interface IDisplayAdmin2

Returns:

The usesFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRequiresBanding

public boolean isRequiresBanding()
                          throws IOException,
                                 AutomationException

Indicates whether the output from the drawing object requires banding. Generally this is true if the output is raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRequiresBanding in interface IDisplayAdmin2

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDoesBlending

public boolean isDoesBlending()
                       throws IOException,
                              AutomationException

Indicates whether the drawing object blends its output with the background. For example, if the object is transparent, the background becomes part of its rendering.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDoesBlending in interface IDisplayAdmin2

Returns:

The flag

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.

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.

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.

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.

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay pDisplay,
                                   IGeometry pRegion)
                            throws IOException,
                                   AutomationException

Enlarges the specified region if necessary to account for the symbology sizes.

Product Availability

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

Specified by:

expandRegionForSymbols in interface ILayerSymbologyExtents

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

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

isUseSymbolLevels

public boolean isUseSymbolLevels()
                          throws IOException,
                                 AutomationException

Indicates if symbol levels are used for drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseSymbolLevels in interface ISymbolLevels

Returns:

The useSymbolLevels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSymbolLevels

public void setUseSymbolLevels(boolean useSymbolLevels)
                        throws IOException,
                               AutomationException

Indicates if symbol levels are used for drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseSymbolLevels in interface ISymbolLevels

Parameters:

useSymbolLevels - The useSymbolLevels (in)

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.

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.

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.

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (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