com.esri.arcgis.carto
Class CadLayer

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

All Implemented Interfaces:

ICad3DRenderMode, ICadLayer, IDataLayer, IDataLayer2, IGeoReference, IIdentify, ILayer, ILayerEffects, ILayerExtensions, ILayerGeneralProperties, ILayerInfo, ILayerPosition, IPublishLayer, ICadDrawingLayers, ICadTransformations, IConnectionPointContainer, IDisplayAdmin, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class CadLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, ICadLayer, ICadDrawingLayers, ICadTransformations, IGeoReference, ICad3DRenderMode, IConnectionPointContainer, IGeoDataset, IPersistStream, IDataLayer, IDataLayer2, IDisplayAdmin, IIdentify, ILayerInfo, ILayerEffects, ILayerPosition, ILayerExtensions, IPublishLayer, ILayerGeneralProperties, Externalizable

Esri CAD Layer class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

CadLayer()
Constructs a CadLayer using ArcGIS Engine.

CadLayer(Object obj)
Construct a CadLayer using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addExtension(Object ext) Adds a new extension.
boolean	connect(IName pOptRepairName) Connects the layer to its data source.
void	disconnect() Disconnects the data from the layer.
void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	flip() Flip operation of layer.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
short	getBrightness() Layer brightness in percent (-100 - 100).
int	getCad3DRenderMode() Render mode type for Cad drawing.
ICadDrawingDataset	getCadDrawingDataset() The dataset of the CAD drawing.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
short	getContrast() Layer contrast in percent (-100 - 100).
String	getDataDetails(String bsPadding) Details of the layer's data.
IName	getDataSourceName() Name of the data object for the layer.
int	getDrawingLayerCount() The number of layers in the CAD drawing.
String	getDrawingLayerName(int index) The name of the CAD drawing layer at the specified index.
Object	getExtension(int index) The extension at the specified index.
int	getExtensionCount() Number of extensions.
IEnvelope	getExtent() The extent of the GeoDataset.
String	getFilePath() Full pathname of the CAD drawing.
void	getFromToTransform(_WKSPoint[] fromPoint1, _WKSPoint[] fromPoint2, _WKSPoint[] toPoint1, _WKSPoint[] toPoint2) Returns the points of a two point transformation.
int	getLargeImage() Large image that represents the layer.
int	getLargeSelectedImage() Large image that represents the layer when it is selected.
double	getLastMaximumScale() Last maximum scale setting used by layer.
double	getLastMinimumScale() Last minimum scale setting used by layer.
double	getLayerWeight() Default layer position.
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.
int	getSupportedDrawPhases() Supported draw phases.
String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
void	getTransformation(_WKSPoint[] from, _WKSPoint[] to, double[] angle, double[] scale) Returns the rotation, scale, and translation of a transformation.
int	getTransformMode() The transformation type.
short	getTransparency() Layer transparency in percent (0-100).
String	getWorldFileName() The pathname of the world file.
int	hashCode() the hashcode for this object
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
String	ILayerGeneralProperties_getLayerDescription() Description for the layer.
boolean	inWorkspace(IWorkspace workspace) Returns TRUE if the layer is in the specified workspace.
boolean	is2d() Indicates if the CAD drawing is 2D.
boolean	is3d() Indicates if the CAD drawing is 3D.
boolean	isAutoCad() Indicates if the CAD drawing is an AutoCAD file.
boolean	isCached() Indicates if the layer needs its own display cache.
boolean	isCanGeoRef() Indicates if layer can be georeferenced.
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.
boolean	isDgn() Indicates if the CAD drawing is a MicroStation file.
void	isDirty() isDirty
boolean	isDrawingLayerVisible(int index) Indicates if the specified CAD drawing layer visible in the CAD layer in ArcMap.
boolean	isEnableTransformations() Indicates if global transformations are enabled.
boolean	isOriginalDrawingLayerVisible(int index) Indicates if the specified CAD drawing layer visible in the CAD drawing itself.
boolean	isShowTips() Indicates if the layer shows map tips.
boolean	isSupportsBrightnessChange() Indicates if the layer supports brightness changes.
boolean	isSupportsContrastChange() Indicates if the layer supports contrast changes.
boolean	isSupportsInteractive() Indicates if the layer supports interactive effects changes.
boolean	isSupportsPublishing() Indicates if the layer supports the publishing process.
boolean	isSupportsTransparency() Indicates if the layer supports transparency.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
boolean	isValid() Indicates if the layer is currently valid.
boolean	isVisible() Indicates if the layer is currently visible.
void	load(IStream pstm) load
void	mirror() Mirror operation of layer.
IPointCollection	pointsTransform(IPointCollection inPoints, boolean isForward) Transform operation of Raster.
void	prepareForPublishing() Prepare the layer for the publishing process.
void	readExternal(ObjectInput in)
void	rectify(String fullpath, String format) Save transformed result to a new dataset.
void	register() Save transformation parameters and tie-points.
void	removeExtension(int index) Removes the specified extension.
void	reScale(double xScale, double yScale) ReScale operation of layer.
void	reset() Reset operation of layer.
void	rotate(IPoint ipPivotPoint, double angle) Rotate operation of layer.
void	save(IStream pstm, int fClearDirty) save
void	setBrightness(short brightnessValue) Layer brightness in percent (-100 - 100).
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setCad3DRenderMode(int mode) Render mode type for Cad drawing.
void	setCadDrawingDatasetByRef(ICadDrawingDataset cadDrawingDataset) The dataset of the CAD drawing.
void	setContrast(short contrastValue) Layer contrast in percent (-100 - 100).
void	setDataSourceName(IName name) Name of the data object for the layer.
void	setDrawingLayerVisible(int index, boolean visible) Indicates if the specified CAD drawing layer visible in the CAD layer in ArcMap.
void	setEnableTransformations(boolean enabled) Indicates if global transformations are enabled.
void	setFromToTransform(_WKSPoint fromPoint1, _WKSPoint fromPoint2, _WKSPoint toPoint1, _WKSPoint toPoint2) Sets the points of a two point transformation.
void	setLayerDescription(String text) Description for the layer.
void	setLayerWeight(double layerWeight) Default layer position.
void	setMaximumScale(double maxScale) Maximum scale (representative fraction) at which the layer will display.
void	setMinimumScale(double minScale) Minimum scale (representative fraction) at which the layer will display.
void	setName(String name) Layer name.
void	setRelativeBase(String basePath) Base path used when storing relative path names.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setSupportsInteractive(boolean supported) Indicates if the layer supports interactive effects changes.
void	setTransformation(_WKSPoint from, _WKSPoint to, double angle, double scale) Sets the rotation, scale, and translation of a transformation.
void	setTransformMode(int mode) The transformation type.
void	setTransparency(short alpha) Layer transparency in percent (0-100).
void	setVisible(boolean visible) Indicates if the layer is currently visible.
void	setWorldFileName(String filePath) The pathname of the world file.
void	shift(double deltaX, double deltaY) Shift operation of layer.
void	twoPointsAdjust(IPointCollection fromPoints, IPointCollection toPoints) Two points adjust operation of layer.
void	warp(IPointCollection fromPoints, IPointCollection toPoints, int order) Warp operation of layer.
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

CadLayer

public CadLayer()
         throws IOException,
                UnknownHostException

Constructs a CadLayer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CadLayer

public CadLayer(Object obj)
         throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems CadLayer theCadLayer = (CadLayer) obj;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

getCadDrawingDataset

public ICadDrawingDataset getCadDrawingDataset()
                                        throws IOException,
                                               AutomationException

The dataset of the CAD drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCadDrawingDataset in interface ICadLayer

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ICadDrawingDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCadDrawingDatasetByRef

public void setCadDrawingDatasetByRef(ICadDrawingDataset cadDrawingDataset)
                               throws IOException,
                                      AutomationException

The dataset of the CAD drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCadDrawingDatasetByRef in interface ICadLayer

Parameters:

cadDrawingDataset - A reference to a com.esri.arcgis.datasourcesfile.ICadDrawingDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilePath

public String getFilePath()
                   throws IOException,
                          AutomationException

Full pathname of the CAD drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilePath in interface ICadLayer

Returns:

The filePath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILayer

is2d

public boolean is2d()
             throws IOException,
                    AutomationException

Indicates if the CAD drawing is 2D.

Product Availability

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

Specified by:

is2d in interface ICadLayer

Returns:

The is2d

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

is3d

public boolean is3d()
             throws IOException,
                    AutomationException

Indicates if the CAD drawing is 3D.

Product Availability

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

Specified by:

is3d in interface ICadLayer

Returns:

The is3d

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoCad

public boolean isAutoCad()
                  throws IOException,
                         AutomationException

Indicates if the CAD drawing is an AutoCAD file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAutoCad in interface ICadLayer

Returns:

The isAutoCad

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILayer

isDgn

public boolean isDgn()
              throws IOException,
                     AutomationException

Indicates if the CAD drawing is a MicroStation file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDgn in interface ICadLayer

Returns:

The isDgn

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILayer

getDrawingLayerCount

public int getDrawingLayerCount()
                         throws IOException,
                                AutomationException

The number of layers in the CAD drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDrawingLayerCount in interface ICadDrawingLayers

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDrawingLayerName

public String getDrawingLayerName(int index)
                           throws IOException,
                                  AutomationException

The name of the CAD drawing layer at the specified index.

Product Availability

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

Specified by:

getDrawingLayerName in interface ICadDrawingLayers

Parameters:

index - The index (in)

Returns:

The filePath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDrawingLayerVisible

public boolean isDrawingLayerVisible(int index)
                              throws IOException,
                                     AutomationException

Indicates if the specified CAD drawing layer visible in the CAD layer in ArcMap.

Product Availability

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

Specified by:

isDrawingLayerVisible in interface ICadDrawingLayers

Parameters:

index - The index (in)

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawingLayerVisible

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

Indicates if the specified CAD drawing layer visible in the CAD layer in ArcMap.

Product Availability

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

Specified by:

setDrawingLayerVisible in interface ICadDrawingLayers

Parameters:

index - The index (in)

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOriginalDrawingLayerVisible

public boolean isOriginalDrawingLayerVisible(int index)
                                      throws IOException,
                                             AutomationException

Indicates if the specified CAD drawing layer visible in the CAD drawing itself.

Product Availability

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

Specified by:

isOriginalDrawingLayerVisible in interface ICadDrawingLayers

Parameters:

index - The index (in)

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableTransformations

public boolean isEnableTransformations()
                                throws IOException,
                                       AutomationException

Indicates if global transformations are enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEnableTransformations in interface ICadTransformations

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableTransformations

public void setEnableTransformations(boolean enabled)
                              throws IOException,
                                     AutomationException

Indicates if global transformations are enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEnableTransformations in interface ICadTransformations

Parameters:

enabled - The enabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorldFileName

public String getWorldFileName()
                        throws IOException,
                               AutomationException

The pathname of the world file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorldFileName in interface ICadTransformations

Returns:

The filePath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorldFileName

public void setWorldFileName(String filePath)
                      throws IOException,
                             AutomationException

The pathname of the world file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWorldFileName in interface ICadTransformations

Parameters:

filePath - The filePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransformMode

public int getTransformMode()
                     throws IOException,
                            AutomationException

The transformation type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransformMode in interface ICadTransformations

Returns:

A com.esri.arcgis.datasourcesfile.esriCadTransform constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransformMode

public void setTransformMode(int mode)
                      throws IOException,
                             AutomationException

The transformation type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransformMode in interface ICadTransformations

Parameters:

mode - A com.esri.arcgis.datasourcesfile.esriCadTransform constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromToTransform

public void getFromToTransform(_WKSPoint[] fromPoint1,
                               _WKSPoint[] fromPoint2,
                               _WKSPoint[] toPoint1,
                               _WKSPoint[] toPoint2)
                        throws IOException,
                               AutomationException

Returns the points of a two point transformation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFromToTransform in interface ICadTransformations

Parameters:

fromPoint1 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array)

fromPoint2 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array)

toPoint1 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array)

toPoint2 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromToTransform

public void setFromToTransform(_WKSPoint fromPoint1,
                               _WKSPoint fromPoint2,
                               _WKSPoint toPoint1,
                               _WKSPoint toPoint2)
                        throws IOException,
                               AutomationException

Sets the points of a two point transformation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFromToTransform in interface ICadTransformations

Parameters:

fromPoint1 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in)

fromPoint2 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in)

toPoint1 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in)

toPoint2 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransformation

public void getTransformation(_WKSPoint[] from,
                              _WKSPoint[] to,
                              double[] angle,
                              double[] scale)
                       throws IOException,
                              AutomationException

Returns the rotation, scale, and translation of a transformation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransformation in interface ICadTransformations

Parameters:

from - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array)

to - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array)

angle - The angle (out: use single element array)

scale - The scale (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransformation

public void setTransformation(_WKSPoint from,
                              _WKSPoint to,
                              double angle,
                              double scale)
                       throws IOException,
                              AutomationException

Sets the rotation, scale, and translation of a transformation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransformation in interface ICadTransformations

Parameters:

from - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in)

to - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in)

angle - The angle (in)

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanGeoRef

public boolean isCanGeoRef()
                    throws IOException,
                           AutomationException

Indicates if layer can be georeferenced.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanGeoRef in interface IGeoReference

Returns:

The canGeoRef

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shift

public void shift(double deltaX,
                  double deltaY)
           throws IOException,
                  AutomationException

Shift operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

shift in interface IGeoReference

Parameters:

deltaX - The deltaX (in)

deltaY - The deltaY (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reScale

public void reScale(double xScale,
                    double yScale)
             throws IOException,
                    AutomationException

ReScale operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reScale in interface IGeoReference

Parameters:

xScale - The xScale (in)

yScale - The yScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flip

public void flip()
          throws IOException,
                 AutomationException

Flip operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

flip in interface IGeoReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mirror

public void mirror()
            throws IOException,
                   AutomationException

Mirror operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

mirror in interface IGeoReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotate

public void rotate(IPoint ipPivotPoint,
                   double angle)
            throws IOException,
                   AutomationException

Rotate operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

rotate in interface IGeoReference

Parameters:

ipPivotPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pointsTransform

public IPointCollection pointsTransform(IPointCollection inPoints,
                                        boolean isForward)
                                 throws IOException,
                                        AutomationException

Transform operation of Raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

pointsTransform in interface IGeoReference

Parameters:

inPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

isForward - The isForward (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPointCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

twoPointsAdjust

public void twoPointsAdjust(IPointCollection fromPoints,
                            IPointCollection toPoints)
                     throws IOException,
                            AutomationException

Two points adjust operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

twoPointsAdjust in interface IGeoReference

Parameters:

fromPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

toPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

warp

public void warp(IPointCollection fromPoints,
                 IPointCollection toPoints,
                 int order)
          throws IOException,
                 AutomationException

Warp operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

warp in interface IGeoReference

Parameters:

fromPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

toPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

order - The order (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Reset operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IGeoReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

register

public void register()
              throws IOException,
                     AutomationException

Save transformation parameters and tie-points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

register in interface IGeoReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rectify

public void rectify(String fullpath,
                    String format)
             throws IOException,
                    AutomationException

Save transformed result to a new dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

rectify in interface IGeoReference

Parameters:

fullpath - The fullpath (in)

format - The format (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCad3DRenderMode

public int getCad3DRenderMode()
                       throws IOException,
                              AutomationException

Render mode type for Cad drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCad3DRenderMode in interface ICad3DRenderMode

Returns:

A com.esri.arcgis.carto.esriCad3DRenderMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCad3DRenderMode

public void setCad3DRenderMode(int mode)
                        throws IOException,
                               AutomationException

Render mode type for Cad drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCad3DRenderMode in interface ICad3DRenderMode

Parameters:

mode - A com.esri.arcgis.carto.esriCad3DRenderMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

enumConnectionPoints

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException

Indicates if the current object draws using a filter.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUsesFilter in interface IDisplayAdmin

Returns:

The usesFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

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.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws IOException,
                                      AutomationException

Indicates if the layer supports transparency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsTransparency in interface ILayerEffects

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws IOException,
                                        AutomationException

Indicates if the layer supports contrast changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsContrastChange in interface ILayerEffects

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws IOException,
                                          AutomationException

Indicates if the layer supports brightness changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsBrightnessChange in interface ILayerEffects

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSupportsInteractive in interface ILayerEffects

Parameters:

supported - The supported (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws IOException,
                                     AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsInteractive in interface ILayerEffects

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws IOException,
                             AutomationException

Layer transparency in percent (0-100).

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransparency in interface ILayerEffects

Returns:

The alpha

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws IOException,
                            AutomationException

Layer transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransparency in interface ILayerEffects

Parameters:

alpha - The alpha (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getContrast in interface ILayerEffects

Returns:

The contrastValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setContrast in interface ILayerEffects

Parameters:

contrastValue - The contrastValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBrightness in interface ILayerEffects

Returns:

The brightnessValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBrightness in interface ILayerEffects

Parameters:

brightnessValue - The brightnessValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

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.

isSupportsPublishing

public boolean isSupportsPublishing()
                             throws IOException,
                                    AutomationException

Indicates if the layer supports the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsPublishing in interface IPublishLayer

Returns:

The bValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPublishingDescription

public String getPublishingDescription()
                                throws IOException,
                                       AutomationException

The layer description reported to the publisher.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPublishingDescription in interface IPublishLayer

Returns:

The bsDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDataValid

public boolean isDataValid()
                    throws IOException,
                           AutomationException

Indicates if the data for the layer is currently valid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDataValid in interface IPublishLayer

Returns:

The bDataValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataDetails

public String getDataDetails(String bsPadding)
                      throws IOException,
                             AutomationException

Details of the layer's data.

Product Availability

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

Specified by:

getDataDetails in interface IPublishLayer

Parameters:

bsPadding - The bsPadding (in)

Returns:

The bsDataDetails

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepareForPublishing

public void prepareForPublishing()
                          throws IOException,
                                 AutomationException

Prepare the layer for the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

prepareForPublishing in interface IPublishLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

public double getLastMinimumScale()
                           throws IOException,
                                  AutomationException

Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMinimumScale in interface ILayerGeneralProperties

Returns:

The minScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws IOException,
                                  AutomationException

Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMaximumScale in interface ILayerGeneralProperties

Returns:

The maxScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public String ILayerGeneralProperties_getLayerDescription()
                                                   throws IOException,
                                                          AutomationException

Description for the layer.

Product Availability

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

Specified by:

ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(String text)
                         throws IOException,
                                AutomationException

Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLayerDescription in interface ILayerGeneralProperties

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException