com.esri.arcgis.carto
Class WMSMapLayer

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

All Implemented Interfaces:

ICompositeLayer, ICompositeLayer2, IDataLayer, IDataLayer2, IIdentify, IIdentify2, IIdentifyGroup, ILayer, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerStatus, ILayerSymbologyExtents, IPublishLayer, ISecureLayer, ISecureLayer2, IServiceLayerImageFormat, ITimeData, ITimeDataDisplay, IWMSGroupLayer, IWMSMapLayer, IConnectionPointContainer, IDisplayAdmin, IDisplayAdmin2, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class WMSMapLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IWMSMapLayer, IWMSGroupLayer, ILayer, ICompositeLayer, ICompositeLayer2, IIdentify, IIdentify2, IGeoDataset, IPersistStream, IPersist, IDisplayAdmin, IDisplayAdmin2, ILayerPosition, IDataLayer, IDataLayer2, ILayerDrawingProperties, ILayerEffects, ILayerInfo, ILayerStatus, IPublishLayer, ILayerGeneralProperties, IIdentifyGroup, ILayerExtensions, ILayerSymbologyExtents, ISecureLayer, ISecureLayer2, IConnectionPointContainer, IServiceLayerImageFormat, ITimeData, ITimeDataDisplay, Externalizable

A container for the display and manipulation of WMS layers.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

WMSMapLayer()
Constructs a WMSMapLayer using ArcGIS Engine.

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

Method Summary

void	add(ILayer wMSLayer) Adds the given WMS Layer at the given position.
void	addExtension(Object ext) Adds a new extension.
void	addILayerEventsListener(ILayerEvents theListener) addILayerEventsListener.
void	clear() Deletes all the sub layers.
void	clearDrawCache() Clears the cache of images downloaded from the WMS server for drawing.
void	clearPassword(boolean bForceReconnect) Removes the passwords from the layer used to access data, and forces a reconnection to the data.
boolean	connect(IName pOptRepairName) Connects the layer to its data source.
IWMSGroupLayer	createWMSGroupLayer(String groupName) Creates an empty WMSGroupLayer with the given name.
IWMSGroupLayer	createWMSGroupLayers(IWMSLayerDescription wMSGroupLayerDescription) Creates a new WMSGroupLayer for the given WMSLayerDescription recursively including all the sub layers.
IWMSLayer	createWMSLayer(IWMSLayerDescription pWMSLayerDescription) Creates a new WMSLayer for the given WMSLayerDescription.
void	delete(ILayer pWMSLayer) Deletes the given layer if it exists.
void	disconnect() Disconnects the data from the layer.
void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	expandRegionForSymbols(IDisplay pDisplay, IGeometry pRegion) Enlarges the specified region if necessary to account for the symbology sizes.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
IColor	getBackgroundColor() Background color for the WMS Map Layer image.
short	getBrightness() Layer brightness in percent (-100 - 100).
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
short	getContrast() Layer contrast in percent (-100 - 100).
int	getCount() Number of sub layers.
String	getDataDetails(String bsPadding) Details of the layer's data.
IName	getDataSourceName() Name of the data object for the layer.
Object	getExtension(int index) The extension at the specified index.
int	getExtensionCount() Number of extensions.
IEnvelope	getExtent() The extent of the GeoDataset.
ITimeExtent	getFullTimeExtent() Returns the time extent for all the data in the layer.
int	getLargeImage() Large image that represents the layer.
int	getLargeSelectedImage() Large image that represents the layer when it is selected.
double	getLastMaximumScale() Last maximum scale setting used by layer.
double	getLastMinimumScale() Last minimum scale setting used by layer.
ILayer	getLayer(int index) Sub layer at the given index.
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.
int	getRequestedImageType() The image type requested.
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.
int	getSupportedImageFormat(int index) The individual output image format supported by Server.
int	getSupportedImageFormatCount() The number of output image format supported by Server.
double	getTimeInterval() Returns recommended time interval to be used to animate this layer/ table.
int	getTimeIntervalUnits() Returns recommended time interval units to be used to animate this layer/ table.
double	getTimeOffset() Returns time offset that needs to be applied to the data for drawing.
int	getTimeOffsetUnits() Returns recommended time interval units to be used to animate this layer/ table.
ITimeReference	getTimeReference() Time reference for the contents of the layer.
String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
short	getTransparency() Layer transparency in percent (0-100).
IWMSServiceDescription	getWMSServiceDescription() Associated WMSServiceDescription.
int	hashCode() the hashcode for this object
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
IArray	identify(IGeometry pGeom, ITrackCancel pTrackCancel) Identifies objects at the specified location.
String	ILayerGeneralProperties_getLayerDescription() Description for the layer.
void	insertLayer(ILayer wMSLayer, int insertPosition) Inserts the given WMS Layer at the given position.
void	insertLayers(IEnumLayer wMSLayers, int insertPosition) Inserts the given WMS Layers at the given position.
boolean	inWorkspace(IWorkspace workspace) Returns TRUE if the layer is in the specified workspace.
boolean	isCached() Indicates if the layer needs its own display cache.
boolean	isDataSourceSupported(IName name) Indicates if the specified data object name is supported by the layer.
boolean	isDataValid() Indicates if the data for the layer is currently valid.
void	isDirty() isDirty
boolean	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 layer is expanded or collapsed.
boolean	isHasAuthentication() Indicates if the layer is password protected.
boolean	isRequiresBanding() Indicates whether the output from the drawing object requires banding.
boolean	isServerSupportsTransparency() Indicates whether transparency is suppported by the server.
boolean	isShowTips() Indicates if the layer shows map tips.
boolean	isSupportsBrightnessChange() Indicates if the layer supports brightness changes.
boolean	isSupportsContrastChange() Indicates if the layer supports contrast changes.
boolean	isSupportsInteractive() Indicates if the layer supports interactive effects changes.
boolean	isSupportsPublishing() Indicates if the layer supports the publishing process.
boolean	isSupportsTime() Indicates whether the layer has any time data.
boolean	isSupportsTransparency() Indicates if the layer supports transparency.
boolean	isTimeDataCumulative() Indicates that features will be animated cumilatively.
boolean	isTransparentBackground() Indicates whether to make the background of the WMS Map Layer image transparent.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
boolean	isUseTime() Indicates whether to use the time for animation purposes.
boolean	isValid() Indicates if the layer is currently valid.
boolean	isVisible() Indicates if the layer is currently visible.
void	load(IStream pstm) load
void	moveLayer(ILayer wMSLayer, int toPosition) Moves the given layer to the given position within the group layer.
void	prepareForPublishing() Prepare the layer for the publishing process.
void	readExternal(ObjectInput in)
void	removeExtension(int index) Removes the specified extension.
void	removeILayerEventsListener(ILayerEvents theListener) removeILayerEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	setBackgroundColor(IColor ppColor) Background color for the WMS Map Layer image.
void	setBrightness(short brightnessValue) Layer brightness in percent (-100 - 100).
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setContrast(short contrastValue) Layer contrast in percent (-100 - 100).
void	setDataSourceName(IName name) Name of the data object for the layer.
void	setDrawingPropsDirty(boolean dirty) Indicates if the layer drawing properties are dirty.
void	setExpanded(boolean pValid) Indicates if the layer is expanded or collapsed.
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	setRequestedImageType(int requestedImageFormat) The image type requested.
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	setStepProgressor(IStepProgressor rhs1) The Step Progressor used by the layer to show progress on actions such as drawing.
void	setSupportsInteractive(boolean supported) Indicates if the layer supports interactive effects changes.
void	setTimeDataCumulative(boolean cumilative) Indicates that features will be animated cumilatively.
void	setTimeInterval(double interval) Returns recommended time interval to be used to animate this layer/ table.
void	setTimeIntervalUnits(int units) Returns recommended time interval units to be used to animate this layer/ table.
void	setTimeOffset(double timeOffset) Returns time offset that needs to be applied to the data for drawing.
void	setTimeOffsetUnits(int units) Returns recommended time interval units to be used to animate this layer/ table.
void	setTransparency(short alpha) Layer transparency in percent (0-100).
void	setTransparentBackground(boolean transparent) Indicates whether to make the background of the WMS Map Layer image transparent.
void	setUseTime(boolean useTime) Indicates whether to use the time for animation purposes.
void	setVisible(boolean visible) Indicates if the layer is currently visible.
void	setWMSServiceDescriptionByRef(IWMSServiceDescription rhs1) Associated WMSServiceDescription.
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

WMSMapLayer

public WMSMapLayer()
            throws IOException,
                   UnknownHostException

Constructs a WMSMapLayer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

WMSMapLayer

public WMSMapLayer(Object obj)
            throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addILayerEventsListener

public void addILayerEventsListener(ILayerEvents theListener)
                             throws IOException

addILayerEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.

Throws:

IOException - If there are communications problems.

removeILayerEventsListener

public void removeILayerEventsListener(ILayerEvents theListener)
                                throws IOException

removeILayerEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.

Throws:

IOException - If there are communications problems.

clearDrawCache

public void clearDrawCache()
                    throws IOException,
                           AutomationException

Clears the cache of images downloaded from the WMS server for drawing.

Product Availability

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

Specified by:

clearDrawCache in interface IWMSMapLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

Background color for the WMS Map Layer image.

Product Availability

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

Specified by:

getBackgroundColor in interface IWMSMapLayer

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor ppColor)
                        throws IOException,
                               AutomationException

Background color for the WMS Map Layer image.

Product Availability

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

Specified by:

setBackgroundColor in interface IWMSMapLayer

Parameters:

ppColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTransparentBackground

public boolean isTransparentBackground()
                                throws IOException,
                                       AutomationException

Indicates whether to make the background of the WMS Map Layer image transparent.

Product Availability

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

Specified by:

isTransparentBackground in interface IWMSMapLayer

Returns:

The transparent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparentBackground

public void setTransparentBackground(boolean transparent)
                              throws IOException,
                                     AutomationException

Indicates whether to make the background of the WMS Map Layer image transparent.

Product Availability

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

Specified by:

setTransparentBackground in interface IWMSMapLayer

Parameters:

transparent - The transparent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isServerSupportsTransparency

public boolean isServerSupportsTransparency()
                                     throws IOException,
                                            AutomationException

Indicates whether transparency is suppported by the server.

Product Availability

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

Specified by:

isServerSupportsTransparency in interface IWMSMapLayer

Returns:

The transparent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWMSServiceDescriptionByRef

public void setWMSServiceDescriptionByRef(IWMSServiceDescription rhs1)
                                   throws IOException,
                                          AutomationException

Associated WMSServiceDescription.

Product Availability

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

Specified by:

setWMSServiceDescriptionByRef in interface IWMSMapLayer

Parameters:

rhs1 - A reference to a com.esri.arcgis.gisclient.IWMSServiceDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWMSServiceDescription

public IWMSServiceDescription getWMSServiceDescription()
                                                throws IOException,
                                                       AutomationException

Associated WMSServiceDescription.

Product Availability

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

Specified by:

getWMSServiceDescription in interface IWMSGroupLayer

Returns:

A reference to a com.esri.arcgis.gisclient.IWMSServiceDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createWMSLayer

public IWMSLayer createWMSLayer(IWMSLayerDescription pWMSLayerDescription)
                         throws IOException,
                                AutomationException

Creates a new WMSLayer for the given WMSLayerDescription.

Product Availability

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

Specified by:

createWMSLayer in interface IWMSGroupLayer

Parameters:

pWMSLayerDescription - A reference to a com.esri.arcgis.gisclient.IWMSLayerDescription (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createWMSGroupLayer

public IWMSGroupLayer createWMSGroupLayer(String groupName)
                                   throws IOException,
                                          AutomationException

Creates an empty WMSGroupLayer with the given name.

Product Availability

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

Specified by:

createWMSGroupLayer in interface IWMSGroupLayer

Parameters:

groupName - The groupName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createWMSGroupLayers

public IWMSGroupLayer createWMSGroupLayers(IWMSLayerDescription wMSGroupLayerDescription)
                                    throws IOException,
                                           AutomationException

Creates a new WMSGroupLayer for the given WMSLayerDescription recursively including all the sub layers.

Product Availability

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

Specified by:

createWMSGroupLayers in interface IWMSGroupLayer

Parameters:

wMSGroupLayerDescription - A reference to a com.esri.arcgis.gisclient.IWMSLayerDescription (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertLayers

public void insertLayers(IEnumLayer wMSLayers,
                         int insertPosition)
                  throws IOException,
                         AutomationException

Inserts the given WMS Layers at the given position. Only layers created by this WMS group layer or its parent layers are valid.

Product Availability

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

Specified by:

insertLayers in interface IWMSGroupLayer

Parameters:

wMSLayers - A reference to a com.esri.arcgis.carto.IEnumLayer (in)

insertPosition - The insertPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertLayer

public void insertLayer(ILayer wMSLayer,
                        int insertPosition)
                 throws IOException,
                        AutomationException

Inserts the given WMS Layer at the given position. Only layer created by this WMS group layer or its parent layers are valid.

Product Availability

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

Specified by:

insertLayer in interface IWMSGroupLayer

Parameters:

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

insertPosition - The insertPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveLayer

public void moveLayer(ILayer wMSLayer,
                      int toPosition)
               throws IOException,
                      AutomationException

Moves the given layer to the given position within the group layer.

Product Availability

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

Specified by:

moveLayer in interface IWMSGroupLayer

Parameters:

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

toPosition - The toPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(ILayer wMSLayer)
         throws IOException,
                AutomationException

Adds the given WMS Layer at the given position. Only layer created by this WMS group layer or its parent layers are valid.

Product Availability

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

Specified by:

add in interface IWMSGroupLayer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete(ILayer pWMSLayer)
            throws IOException,
                   AutomationException

Deletes the given layer if it exists.

Product Availability

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

Specified by:

delete in interface IWMSGroupLayer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Deletes all the sub layers.

Product Availability

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

Specified by:

clear in interface IWMSGroupLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpanded

public boolean isExpanded()
                   throws IOException,
                          AutomationException

Indicates if the layer is expanded or collapsed.

Product Availability

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

Specified by:

isExpanded in interface ICompositeLayer2

Specified by:

isExpanded in interface IWMSGroupLayer

Returns:

The pValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpanded

public void setExpanded(boolean pValid)
                 throws IOException,
                        AutomationException

Indicates if the layer is expanded or collapsed.

Product Availability

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

Specified by:

setExpanded in interface ICompositeLayer2

Specified by:

setExpanded in interface IWMSGroupLayer

Parameters:

pValid - The pValid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

Number of sub layers.

Product Availability

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

Specified by:

getCount in interface ICompositeLayer

Specified by:

getCount in interface ICompositeLayer2

Specified by:

getCount in interface IWMSGroupLayer

Returns:

The pLayerCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int index)
                throws IOException,
                       AutomationException

Sub layer at the given index.

Product Availability

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

Specified by:

getLayer in interface ICompositeLayer

Specified by:

getLayer in interface ICompositeLayer2

Specified by:

getLayer in interface IWMSGroupLayer

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

identify

public IArray identify(IGeometry pGeom)
                throws IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

identify in interface IIdentify

Parameters:

pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identify

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

Identifies objects at the specified location.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

identify in interface IIdentify2

Parameters:

pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(double rhs1)
              throws IOException,
                     AutomationException

The current scale of the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setScale in interface IIdentify2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException

Indicates if the current object draws using a filter.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUsesFilter in interface IDisplayAdmin

Specified by:

isUsesFilter in interface IDisplayAdmin2

Returns:

The usesFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRequiresBanding

public boolean isRequiresBanding()
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRequiresBanding in interface IDisplayAdmin2

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDoesBlending

public boolean isDoesBlending()
                       throws IOException,
                              AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDoesBlending in interface IDisplayAdmin2

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerWeight

public double getLayerWeight()
                      throws IOException,
                             AutomationException

Default layer position.

Description

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLayerWeight in interface ILayerPosition

Returns:

The layerWeight

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws IOException,
                           AutomationException

Default layer position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLayerWeight in interface ILayerPosition

Parameters:

layerWeight - The layerWeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSourceName

public IName getDataSourceName()
                        throws IOException,
                               AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDataSourceName in interface IDataLayer

Specified by:

getDataSourceName in interface IDataLayer2

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws IOException,
                              AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDataSourceName in interface IDataLayer

Specified by:

setDataSourceName in interface IDataLayer2

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Specified by:

isDataSourceSupported in interface IDataLayer

Specified by:

isDataSourceSupported in interface IDataLayer2

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws IOException,
                       AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

connect in interface IDataLayer

Specified by:

connect in interface IDataLayer2

Parameters:

pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)

Returns:

The succeeded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public String getRelativeBase()
                       throws IOException,
                              AutomationException

Base path used when storing relative path names.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRelativeBase in interface IDataLayer

Specified by:

getRelativeBase in interface IDataLayer2

Returns:

The basePath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(String basePath)
                     throws IOException,
                            AutomationException

Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRelativeBase in interface IDataLayer

Specified by:

setRelativeBase in interface IDataLayer2

Parameters:

basePath - The basePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException

Disconnects the data from the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

disconnect in interface IDataLayer2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws IOException,
                           AutomationException

Returns TRUE if the layer is in the specified workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

inWorkspace in interface IDataLayer2

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

The inWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws IOException,
                                   AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDrawingPropsDirty in interface ILayerDrawingProperties

Returns:

The dirty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws IOException,
                                 AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDrawingPropsDirty in interface ILayerDrawingProperties

Parameters:

dirty - The dirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

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.

setStepProgressor

public void setStepProgressor(IStepProgressor rhs1)
                       throws IOException,
                              AutomationException

The Step Progressor used by the layer to show progress on actions such as drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStepProgressor in interface ILayerStatus

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IStepProgressor (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.

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.

expandRegionForSymbols

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

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

Product Availability

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

Specified by:

expandRegionForSymbols in interface ILayerSymbologyExtents

Parameters:

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

pRegion - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearPassword

public void clearPassword(boolean bForceReconnect)
                   throws IOException,
                          AutomationException

Removes the passwords from the layer used to access data, and forces a reconnection to the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clearPassword in interface ISecureLayer

Specified by:

clearPassword in interface ISecureLayer2

Parameters:

bForceReconnect - The bForceReconnect (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasAuthentication

public boolean isHasAuthentication()
                            throws IOException,
                                   AutomationException

Indicates if the layer is password protected.

Product Availability

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

Specified by:

isHasAuthentication in interface ISecureLayer2

Returns:

The hasAuthentication

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.

getSupportedImageFormatCount

public int getSupportedImageFormatCount()
                                 throws IOException,
                                        AutomationException

The number of output image format supported by Server.

Product Availability

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

Specified by:

getSupportedImageFormatCount in interface IServiceLayerImageFormat

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedImageFormat

public int getSupportedImageFormat(int index)
                            throws IOException,
                                   AutomationException

The individual output image format supported by Server.

Product Availability

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

Specified by:

getSupportedImageFormat in interface IServiceLayerImageFormat

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.carto.esriImageFormat constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequestedImageType

public int getRequestedImageType()
                          throws IOException,
                                 AutomationException

The image type requested.

Product Availability

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

Specified by:

getRequestedImageType in interface IServiceLayerImageFormat

Returns:

A com.esri.arcgis.carto.esriImageFormat constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequestedImageType

public void setRequestedImageType(int requestedImageFormat)
                           throws IOException,
                                  AutomationException

The image type requested.

Product Availability

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

Specified by:

setRequestedImageType in interface IServiceLayerImageFormat

Parameters:

requestedImageFormat - A com.esri.arcgis.carto.esriImageFormat constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsTime

public boolean isSupportsTime()
                       throws IOException,
                              AutomationException

Indicates whether the layer has any time data.

Description

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

Product Availability

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

Specified by:

isSupportsTime in interface ITimeData

Returns:

The hasTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseTime

public boolean isUseTime()
                  throws IOException,
                         AutomationException

Indicates whether to use the time for animation purposes.

Description

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

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

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

Product Availability

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

Specified by:

isUseTime in interface ITimeData

Returns:

The useTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseTime

public void setUseTime(boolean useTime)
                throws IOException,
                       AutomationException

Indicates whether to use the time for animation purposes.

Product Availability

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

Specified by:

setUseTime in interface ITimeData

Parameters:

useTime - The useTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

Time reference for the contents of the layer.

Description

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

Product Availability

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

Specified by:

getTimeReference in interface ITimeData

Returns:

A reference to a com.esri.arcgis.system.ITimeReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws IOException,
                                     AutomationException

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

Description

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

Product Availability

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

Specified by:

getFullTimeExtent in interface ITimeData

Returns:

A reference to a com.esri.arcgis.system.ITimeExtent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeDataCumulative

public void setTimeDataCumulative(boolean cumilative)
                           throws IOException,
                                  AutomationException

Indicates that features will be animated cumilatively.

Product Availability

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

Specified by:

setTimeDataCumulative in interface ITimeDataDisplay

Parameters:

cumilative - The cumilative (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTimeDataCumulative

public boolean isTimeDataCumulative()
                             throws IOException,
                                    AutomationException

Indicates that features will be animated cumilatively.

Description

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

Product Availability

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

Specified by:

isTimeDataCumulative in interface ITimeDataDisplay

Returns:

The cumilative

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeInterval

public void setTimeInterval(double interval)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Specified by:

setTimeInterval in interface ITimeDataDisplay

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeInterval

public double getTimeInterval()
                       throws IOException,
                              AutomationException

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

Description

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

Product Availability

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

Specified by:

getTimeInterval in interface ITimeDataDisplay

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeIntervalUnits

public void setTimeIntervalUnits(int units)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:

setTimeIntervalUnits in interface ITimeDataDisplay

Parameters:

units - A com.esri.arcgis.system.esriTimeUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

public int getTimeIntervalUnits()
                         throws IOException,
                                AutomationException

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

Description

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

Product Availability

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

Specified by:

getTimeIntervalUnits in interface ITimeDataDisplay

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeOffset

public void setTimeOffset(double timeOffset)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Specified by:

setTimeOffset in interface ITimeDataDisplay

Parameters:

timeOffset - The timeOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeOffset

public double getTimeOffset()
                     throws IOException,
                            AutomationException

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

Description

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

Product Availability

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

Specified by:

getTimeOffset in interface ITimeDataDisplay

Returns:

The timeOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeOffsetUnits

public void setTimeOffsetUnits(int units)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Specified by:

setTimeOffsetUnits in interface ITimeDataDisplay

Parameters:

units - A com.esri.arcgis.system.esriTimeUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeOffsetUnits

public int getTimeOffsetUnits()
                       throws IOException,
                              AutomationException

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

Description

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

Product Availability

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

Specified by:

getTimeOffsetUnits in interface ITimeDataDisplay

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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