com.esri.arcgis.networkanalyst
Class NALayer

java.lang.Object
  extended by 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, IDataset, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, INALayer, INALayer2, INALayer3, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

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

COM Class 'NALayer'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description 'The layer for defining, solving, and viewing network analysis results.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALayer3
IID, IID2ff75aa1_fa95_4567_8dec_e658f4e74d60, xxDummy
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALayer2
IID734a3ec8_8345_4f7b_8e49_3cd871603aa7
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALayer
IID667b776b_5905_4450_9c94_18b214ece8fb
 
Fields inherited from interface com.esri.arcgis.carto.ILayer2
IID, IID599dee2e_2182_4e54_8a86_725145c9d989, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerInfo
IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerExtensions
IID, IIDbb6a78ca_9c28_4f75_899f_dff65174082c, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDataset
IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDataLayer
IID, IID6ca416b1_e160_11d2_9f4e_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDataLayer2
IID, IIDe9d11f65_6936_4408_b69f_d91552eb9c4a, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ICompositeLayer
IID, IIDba119bc4_939a_11d2_a2f4_080009b6f22b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ICompositeLayer2
IID, IID88130d17_5762_453a_96cf_8e7503fa1aa0, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IStandaloneTableCollection
IID, IID3c2aceaa_e3dc_11d3_a096_00c04f6bc626, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IIdentify2
IID, IID0483dc2f_8726_4640_98cd_5888ff1a4fa4, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IIdentifyGroup
IID, IID543ecd8a_b231_4fd1_a114_3a69f983933e, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin
IID, IID12e361f0_1907_11d3_80c7_0080c79f0371, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin2
IID, IIDd915ec07_7b4f_47fd_b59b_3252f3a3b610, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerPosition
IID, IIDc0dc8820_e10f_4285_aab1_6c6b685dbb84, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IMapLevel
IID, IIDcef72580_c1d9_11d2_9888_0080c7e04196, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerSymbologyExtents
IID, IID02cbda2f_d2e8_4b28_af9c_71cb096213e1, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ISymbolLevels
IID, IID7a3e4ac0_d4e0_4f56_97df_709ab216daa1, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IPublishLayer
IID, IID7453c805_9d64_44a6_bf2f_73e477dce18f, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
NALayer()
          Constructs a NALayer using ArcGIS Engine.
NALayer(java.lang.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(java.lang.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.
 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.
 void clear()
          Clear all analysis layers.
 boolean connect(IName pOptRepairName)
          Connects the layer to its data source.
 IDataset copy(java.lang.String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 INAContext copyContext()
          Returns a copy of the NAContext referenced by the NALayer.
 void delete()
          Deletes this dataset.
 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(java.lang.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(java.lang.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.
 java.lang.String getBrowseName()
          The browse name of the dataset.
 java.lang.String getCategory()
          The category of the dataset.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 INAContext getContext()
          The network analysis context.
 int getCount()
          Number of layers in the collection.
 java.lang.String getDataDetails(java.lang.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(java.lang.String name)
          The network analysis layer or standalone table by class name.
 IName getDataSourceName()
          Name of the data object for the layer.
 java.lang.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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getLargeImage()
          Large image that represents the layer.
 int getLargeSelectedImage()
          Large image that represents the layer when it is selected.
 double 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(java.lang.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.
 java.lang.String getName()
          Layer name.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 java.lang.String getPublishingDescription()
          The layer description reported to the publisher.
 java.lang.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.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getSupportedDrawPhases()
          Supported draw phases.
 java.lang.String getTipText(double x, double y, double tolerance)
          Map tip text at the specified location.
 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.
 java.lang.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(java.io.ObjectInput in)
           
 void release()
          Release a NALayer.
 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 rename(java.lang.String name)
          Renames this Dataset.
 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 setBrowseName(java.lang.String name)
          The browse name of the dataset.
 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(java.lang.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(java.lang.String name)
          Layer name.
 void setRelativeBase(java.lang.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(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

NALayer

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

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

NALayer

public NALayer(java.lang.Object obj)
        throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

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

addILayerEventsListener

public void addILayerEventsListener(ILayerEvents theListener)
                             throws java.io.IOException
addILayerEventsListener. Listen to events generated by this class.

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

removeILayerEventsListener

public void removeILayerEventsListener(ILayerEvents theListener)
                                throws java.io.IOException
removeILayerEventsListener. Stop listening to events generated by this class.

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

addINALayerEventsListener

public void addINALayerEventsListener(INALayerEvents theListener)
                               throws java.io.IOException
addINALayerEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.networkanalyst.INALayerEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeINALayerEventsListener

public void removeINALayerEventsListener(INALayerEvents theListener)
                                  throws java.io.IOException
removeINALayerEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.networkanalyst.INALayerEvents interface.
Throws:
java.io.IOException - If there are communications problems.

release

public void release()
Release a NALayer.

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

setContextByRef

public void setContextByRef(INAContext nAContext)
                     throws java.io.IOException,
                            AutomationException
The network analysis context.

Specified by:
setContextByRef in interface INALayer
Parameters:
nAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContext

public INAContext getContext()
                      throws java.io.IOException,
                             AutomationException
The network analysis context.

Specified by:
getContext in interface INALayer
Returns:
A reference to a com.esri.arcgis.networkanalyst.INAContext
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerByNAClassName

public ILayer getLayerByNAClassName(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException
The network analysis layer by class name.

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

add

public void add(ILayer layer)
         throws java.io.IOException,
                AutomationException
Add a new layer.

Specified by:
add in interface INALayer
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete(ILayer layer)
            throws java.io.IOException,
                   AutomationException
Delete an existing layer.

Specified by:
delete in interface INALayer
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException
Clear all analysis layers.

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

isExpanded

public boolean isExpanded()
                   throws java.io.IOException,
                          AutomationException
Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.

Specified by:
isExpanded in interface ICompositeLayer2
Specified by:
isExpanded in interface INALayer
Returns:
The expanded
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpanded

public void setExpanded(boolean expanded)
                 throws java.io.IOException,
                        AutomationException
Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.

Specified by:
setExpanded in interface ICompositeLayer2
Specified by:
setExpanded in interface INALayer
Parameters:
expanded - The expanded (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copyContext

public INAContext copyContext()
                       throws java.io.IOException,
                              AutomationException
Returns a copy of the NAContext referenced by the NALayer.

Specified by:
copyContext in interface INALayer2
Returns:
A reference to a com.esri.arcgis.networkanalyst.INAContext
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

attachContext

public void attachContext(INAContext nAContext)
                   throws java.io.IOException,
                          AutomationException
Sets the NALayer to reference the NAContext and the sublayers to reference the NAClasses of the NAContext.

Specified by:
attachContext in interface INALayer2
Parameters:
nAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataLayerByNAClassName

public IDataLayer getDataLayerByNAClassName(java.lang.String name)
                                     throws java.io.IOException,
                                            AutomationException
The network analysis layer or standalone table by class name.

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

getAllDataLayerCount

public int getAllDataLayerCount()
                         throws java.io.IOException,
                                AutomationException
The total number of data layers (layers and standalone tables) in the network analysis layer.

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

getAllLayerCount

public int getAllLayerCount()
                     throws java.io.IOException,
                            AutomationException
The total number of layers in the network analysis layer.

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

getAllStandaloneTableCount

public int getAllStandaloneTableCount()
                               throws java.io.IOException,
                                      AutomationException
The total number of standalone tables in the network analysis layer.

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

findDataLayerByNAClassName

public int findDataLayerByNAClassName(java.lang.String name)
                               throws java.io.IOException,
                                      AutomationException
The index of the named datalayer in the collection of DataLayers of the network analysis layer.

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

getDataLayer

public IDataLayer getDataLayer(int index)
                        throws java.io.IOException,
                               AutomationException
The datalayer at the specified index in the collection of DataLayers of the network analysis layer.

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

isCanRestrictAccessibility

public boolean isCanRestrictAccessibility(int index)
                                   throws java.io.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.

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

isAccessible

public boolean isAccessible(int index)
                     throws java.io.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.

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

setAccessible

public void setAccessible(int index,
                          boolean flag)
                   throws java.io.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.

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

reorder

public void reorder(ILongArray reorderedIndices)
             throws java.io.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.

Specified by:
reorder in interface INALayer3
Parameters:
reorderedIndices - A reference to a com.esri.arcgis.system.ILongArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

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

Description


Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setName

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isValid

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException
The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAreaOfInterest in interface ILayer
Specified by:
getAreaOfInterest in interface ILayer2
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumScale

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMinimumScale

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaximumScale

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaximumScale

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isVisible

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException
Indicates if the layer is currently visible.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isShowTips

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setShowTips

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTipText

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

Product Availability

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

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

isCached

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

Remarks

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCached

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

Description

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

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSupportedDrawPhases

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.IOException,
                                     AutomationException
Spatial reference for the layer.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSpatialReferenceByRef in interface ILayer
Specified by:
setSpatialReferenceByRef in interface ILayer2
Parameters:
rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface ILayer
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the minimum and maximum scale range values are read-only.

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

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException
The default area of interest for the layer.

Specified by:
setAreaOfInterest in interface ILayer2
Parameters:
aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

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

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

getSmallSelectedImage

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

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

getLargeImage

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

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

getLargeSelectedImage

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

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

getExtensionCount

public int getExtensionCount()
                      throws java.io.IOException,
                             AutomationException
Number of extensions.

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

getExtension

public java.lang.Object getExtension(int index)
                              throws java.io.IOException,
                                     AutomationException
The extension at the specified index.

Specified by:
getExtension in interface ILayerExtensions
Parameters:
index - The index (in)
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(java.lang.Object ext)
                  throws java.io.IOException,
                         AutomationException
Adds a new extension.

Specified by:
addExtension in interface ILayerExtensions
Parameters:
ext - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws java.io.IOException,
                            AutomationException
Removes the specified extension.

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

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException
The associated name object.

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

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException
The browse name of the dataset.

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

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
The browse name of the dataset.

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

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
The type of the Dataset.

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The category of the dataset.

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

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException
Datasets contained within this dataset.

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

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException
The workspace containing this dataset.

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

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
The set of properties for the dataset.

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

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException
True if this dataset can be copied.

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

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException
Copies this dataset to a new dataset with the specified name.

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

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be deleted.

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

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Deletes this dataset.

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

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be renamed.

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

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException
Renames this Dataset.

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The spatial reference of the GeoDataset.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSpatialReference in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

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

Remarks

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

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

The red box represents the IGeoDataset extent

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

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

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataSourceName

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

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

setDataSourceName

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

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

isDataSourceSupported

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

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

connect

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

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

getRelativeBase

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

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

setRelativeBase

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

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

disconnect

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

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

inWorkspace

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

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

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException
Number of layers in the collection.

Specified by:
getCount in interface ICompositeLayer
Specified by:
getCount in interface ICompositeLayer2
Returns:
The layerCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException
Layer in the collection at the specified index.

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

getStandaloneTableCount

public int getStandaloneTableCount()
                            throws java.io.IOException,
                                   AutomationException
Number of standalone tables.

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

getStandaloneTable

public IStandaloneTable getStandaloneTable(int index)
                                    throws java.io.IOException,
                                           AutomationException
The standalone table at the given index.

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

addStandaloneTable

public void addStandaloneTable(IStandaloneTable table)
                        throws java.io.IOException,
                               AutomationException
Adds a standalone table to the collection.

Specified by:
addStandaloneTable in interface IStandaloneTableCollection
Parameters:
table - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeStandaloneTable

public void removeStandaloneTable(IStandaloneTable table)
                           throws java.io.IOException,
                                  AutomationException
Removes the standalone table from the collection.

Specified by:
removeStandaloneTable in interface IStandaloneTableCollection
Parameters:
table - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAllStandaloneTables

public void removeAllStandaloneTables()
                               throws java.io.IOException,
                                      AutomationException
Removes all standalone tables from the collection.

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

identify

public IArray identify(IGeometry pGeom)
                throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom,
                       ITrackCancel pTrackCancel)
                throws java.io.IOException,
                       AutomationException
Identifies objects at the specified location.

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

setScale

public void setScale(double rhs1)
              throws java.io.IOException,
                     AutomationException
The current scale of the display.

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

isUsesFilter

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

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

isRequiresBanding

public boolean isRequiresBanding()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the output from the drawing object requires banding. Generally this is true if the output is raster.

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

isDoesBlending

public boolean isDoesBlending()
                       throws java.io.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.

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

getLayerWeight

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

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

setLayerWeight

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

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

getMapLevel

public int getMapLevel()
                throws java.io.IOException,
                       AutomationException
Current map level for drawing multi-level symbols.

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

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException
Current map level for drawing multi-level symbols.

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

isDrawingPropsDirty

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDrawingPropsDirty

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLastMinimumScale

public double getLastMinimumScale()
                           throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public java.lang.String ILayerGeneralProperties_getLayerDescription()
                                                             throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(java.lang.String text)
                         throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay pDisplay,
                                   IGeometry pRegion)
                            throws java.io.IOException,
                                   AutomationException
Enlarges the specified region if necessary to account for the symbology sizes.

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

isUseSymbolLevels

public boolean isUseSymbolLevels()
                          throws java.io.IOException,
                                 AutomationException
Indicates if symbol levels are used for drawing.

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

setUseSymbolLevels

public void setUseSymbolLevels(boolean useSymbolLevels)
                        throws java.io.IOException,
                               AutomationException
Indicates if symbol levels are used for drawing.

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

isSupportsPublishing

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

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

getPublishingDescription

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

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

isDataValid

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

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

getDataDetails

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

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

prepareForPublishing

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

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

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

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

getSizeMax

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

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException