com.esri.arcgis.carto
Class MosaicLayer

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

All Implemented Interfaces:

IAttributeTable, ICompositeLayer, ICompositeLayer2, IDataLayer, IDataLayer2, IIdentify, IIdentify2, ILayer, ILayer2, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerGeneralProperties, ILayerInfo, ILayerMasking, ILayerPosition, ILayerSymbologyExtents, IMosaicLayer, IMultidimensionalLayer, IPublishLayer, ITableDefinition, ITimeData, ITimeData2, ITimeDataDisplay, ITimeTableDefinition, IRasterDataManagementEvents, IConnectionPointContainer, IDisplayAdmin, IDisplayAdmin2, IDisplayFilterManager, IDataset, IGeoDataset, IWorkspaceEditEvents, com.esri.arcgis.interop.RemoteObjRef, IClassID, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class MosaicLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, IMosaicLayer, ICompositeLayer2, IDataLayer, IDataLayer2, IGeoDataset, IPersistStream, ITimeData, ITimeData2, ITimeTableDefinition, ITimeDataDisplay, ILayerInfo, IDataset, IAttributeTable, ITableDefinition, ICompositeLayer, IIdentify, IIdentify2, ILayer2, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerGeneralProperties, ILayerMasking, ILayerPosition, ILayerSymbologyExtents, IPublishLayer, IRasterDataManagementEvents, IDisplayAdmin, IDisplayAdmin2, IDisplayFilterManager, IWorkspaceEditEvents, IClassID, ISupportErrorInfo, IConnectionPointContainer, IMultidimensionalLayer, java.io.Externalizable

COM Class 'MosaicLayer'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'The layer implementation of the Mosaic Dataset.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IMosaicLayer

IID, IIDef80da8f_686b_4d8e_87ed_c2213273632f, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ICompositeLayer2

IID, IID88130d17_5762_453a_96cf_8e7503fa1aa0, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDataLayer

IID, IID6ca416b1_e160_11d2_9f4e_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDataLayer2

IID, IIDe9d11f65_6936_4408_b69f_d91552eb9c4a, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.carto.ITimeData2

IID, IID6308f920_d4ef_4e5f_b0fc_7a63ed132b27, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITimeData

IID008331d0_1225_4fe7_ad19_c3431625d337

Fields inherited from interface com.esri.arcgis.carto.ITimeTableDefinition

IID, IID9f45df65_de39_4a88_b174_b2ad3d3020a8, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITimeDataDisplay

IID, IIDf12874c3_3358_40a5_8e32_c824dd1d75fa, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerInfo

IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDataset

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IAttributeTable

IID, IID07f3186c_af91_4ad6_bf67_11167d0f8f60, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITableDefinition

IID, IID7e078ff6_4b77_414e_90a9_8bb352dd1608, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ICompositeLayer

IID, IIDba119bc4_939a_11d2_a2f4_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IIdentify2

IID, IID0483dc2f_8726_4640_98cd_5888ff1a4fa4, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayer2

IID, IID599dee2e_2182_4e54_8a86_725145c9d989, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerEffects

IID, IID09998199_1fb8_11d3_ab4e_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerExtensions

IID, IIDbb6a78ca_9c28_4f75_899f_dff65174082c, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerMasking

IID, IID536427da_5354_491d_ae92_abebaa8bb05b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerPosition

IID, IIDc0dc8820_e10f_4285_aab1_6c6b685dbb84, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerSymbologyExtents

IID, IID02cbda2f_d2e8_4b28_af9c_71cb096213e1, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IPublishLayer

IID, IID7453c805_9d64_44a6_bf2f_73e477dce18f, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterDataManagementEvents

IID, IID5901c657_d66f_4c40_8976_05b663cb38e2, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin2

IID, IIDd915ec07_7b4f_47fd_b59b_3252f3a3b610, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayFilterManager

IID, IIDf0815360_19e1_11d3_80c8_0080c79f0371, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin

IID12e361f0_1907_11d3_80c7_0080c79f0371

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceEditEvents

IID, IID0b437962_89f9_11d4_8b5f_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClassID

IID, IID9f9650f1_5f49_4041_ba0f_d10baff1d7bc, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IMultidimensionalLayer

IID, IID04472b38_e412_4166_9f62_c1c35150d32b, xxDummy

Constructor Summary

MosaicLayer()
Constructs a MosaicLayer using ArcGIS Engine.

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

Method Summary

void	addExtension(java.lang.Object ext) Adds a new extension.
boolean	canCopy() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
void	clearMasking(ILayer layer) Clear masking layers on a layer.
boolean	connect(IName pOptRepairName) Connects the layer to its data source.
IDataset	copy(java.lang.String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
void	createFromFilePath(java.lang.String filePath) Creates the layer from a file path to the mosaic dataset
void	createFromMosaicDataset(IMosaicDataset mosaicDataset) Creates the layer from the mosaic dataset
void	delete() Deletes this dataset.
void	disconnect() Disconnects the data from the layer.
void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	expandRegionForSymbols(IDisplay pDisplay, IGeometry pRegion) Enlarges the specified region if necessary to account for the symbology sizes.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
ITable	getAttributeTable() The attribute table.
IFeatureLayer	getBoundaryLayer() The Boundary layer referenced by the Mosaic Layer.
short	getBrightness() Layer brightness in percent (-100 - 100).
java.lang.String	getBrowseName() The browse name of the dataset.
java.lang.String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
GUID	getCLSID() Identify class ID for an object.
short	getContrast() Layer contrast in percent (-100 - 100).
int	getCount() Number of layers in the collection.
ITimeExtent	getCustomTimeExtent() Custom time extent during which a layer is visible.
java.lang.String	getDataDetails(java.lang.String bsPadding) Details of the layer's data.
IName	getDataSourceName() Name of the data object for the layer.
java.lang.String	getDefinitionExpression() Definition query expression for the existing layer.
ISelectionSet	getDefinitionSelectionSet() The selection set that defines the subset of features in a selection layer.
java.lang.String	getDimensionDefinitionQuery() Dimension definition query for multi-dimensional dataset.
IDisplayFilter	getDisplayFilter() The display filter.
java.lang.String	getEndTimeFieldName() Name of the field that has end time for a row.
java.lang.Object	getExtension(int index) The extension at the specified index.
int	getExtensionCount() Number of extensions.
IEnvelope	getExtent() The extent of the GeoDataset.
java.lang.String	getFilePath() Filepath of the data source.
IFeatureLayer	getFootprintLayer() The footprint layer referenced by the Mosaic Layer.
IName	getFullName() The associated name object.
ITimeExtent	getFullTimeExtent() Returns the time extent for all the data in the layer.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLargeImage() Large image that represents the layer.
int	getLargeSelectedImage() Large image that represents the layer when it is selected.
double	getLastMaximumScale() Last maximum scale setting used by layer.
double	getLastMinimumScale() Last minimum scale setting used by layer.
ILayer	getLayer(int index) Layer in the collection at the specified index.
double	getLayerWeight() Default layer position.
ISet	getMaskedLayers() The set of layers that are being masked.
ISet	getMaskingLayers(ILayer layer) The masks for a layer.
double	getMaximumScale() Maximum scale (representative fraction) at which the layer will display.
double	getMinimumScale() Minimum scale (representative fraction) at which the layer will display.
IMosaicDataset	getMosaicDataset() The Mosaic Dataset referenced by the Mosaic Layer.
IMultidimensionalDefinition	getMultidimensionalDefinition() An array of dimensional value objects.
java.lang.String	getName() Layer name.
IImageServerLayer	getPreviewLayer() The preview layer referenced by the Mosaic Layer.
java.lang.String	getProgID() Identify ProgID for an object.
IPropertySet	getPropertySet() The set of properties for the dataset.
java.lang.String	getPublishingDescription() The layer description reported to the publisher.
java.lang.String	getRelativeBase() Base path used when storing relative path names.
IFeatureLayer	getSeamlineLayer() The seamline layer referenced by the Mosaic Layer.
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.
java.lang.String	getStartTimeFieldName() Name of the field that has start time for a row.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getSupportedDrawPhases() Supported draw phases.
java.lang.String	getTimeDimensionDefinitionQuery() Time definition query for multi-dimensional dataset.
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.
java.lang.String	getTimeValueFormat() Time value format if the field name is of the string format.
java.lang.String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
java.lang.String	getTrackIDFieldName() Field that contains the rows that uniquely identifies the object whose time is being tracked.
short	getTransparency() Layer transparency in percent (0-100).
int	getType() The type of the Dataset.
IWorkspace	getWorkspace() The workspace containing this dataset.
int	hashCode() the hashcode for this object
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
IArray	identify(IGeometry pGeom, ITrackCancel pTrackCancel) Identifies objects at the specified location.
java.lang.String	ILayerGeneralProperties_getLayerDescription() Description for the layer.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	inWorkspace(IWorkspace workspace) Returns TRUE if the layer is in the specified workspace.
boolean	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 in the TOC.
boolean	isHasLiveData() isHasLiveData
boolean	isRequiresBanding() Indicates whether the output from the drawing object requires banding.
boolean	isScaleRangeReadOnly() Indicates if the minimum and maximum scale range values are read-only.
boolean	isShowTips() Indicates if the layer shows map tips.
boolean	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	isUseMasking() Indicates whether to use masking.
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	onAbortEditOperation(IWorkspaceEditEventsOnAbortEditOperationEvent theEvent) This event is fired after an edit operation is aborted.
void	onEvent(IRasterDataManagementEventsOnEventEvent theEvent) Performs operation on the raster data management event.
void	onRedoEditOperation(IWorkspaceEditEventsOnRedoEditOperationEvent theEvent) This event is fired after an undone edit operation is redone.
void	onStartEditing(IWorkspaceEditEventsOnStartEditingEvent theEvent) This event is fired after editing is started on a workspace.
void	onStartEditOperation(IWorkspaceEditEventsOnStartEditOperationEvent theEvent) This event is fired after an edit operation is started.
void	onStopEditing(IWorkspaceEditEventsOnStopEditingEvent theEvent) This event is fired after editing is stopped on a workspace.
void	onStopEditOperation(IWorkspaceEditEventsOnStopEditOperationEvent theEvent) This event is fired after an edit operation is stopped (successfully completed).
void	onUndoEditOperation(IWorkspaceEditEventsOnUndoEditOperationEvent theEvent) This event is fired after a (completed) edit operation is undone.
void	prepareForPublishing() Prepare the layer for the publishing process.
void	readExternal(java.io.ObjectInput in)
void	release() Release a MosaicLayer.
void	removeExtension(int index) Removes the specified extension.
void	rename(java.lang.String name) Renames this Dataset.
void	save(IStream pstm, int fClearDirty) save
void	setAreaOfInterest(IEnvelope aoi) The default area of interest for the layer.
void	setBrightness(short brightnessValue) Layer brightness in percent (-100 - 100).
void	setBrowseName(java.lang.String name) The browse name of the dataset.
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setContrast(short contrastValue) Layer contrast in percent (-100 - 100).
void	setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime) Custom time extent during which a layer is visible.
void	setDataSourceName(IName name) Name of the data object for the layer.
void	setDefinitionExpression(java.lang.String expression) Definition query expression for the existing layer.
void	setDimensionDefinitionQuery(java.lang.String pDefQuery) Dimension definition query for multi-dimensional dataset.
void	setDisplayFilter(IDisplayFilter displayFilter) The display filter.
void	setDrawingPropsDirty(boolean dirty) Indicates if the layer drawing properties are dirty.
void	setEndTimeFieldName(java.lang.String fieldName) Name of the field that has end time for a row.
void	setExpanded(boolean expanded) Indicates if the layer is expanded in the TOC.
void	setHasLiveData(boolean useTime) setHasLiveData
void	setLayerDescription(java.lang.String text) Description for the layer.
void	setLayerWeight(double layerWeight) Default layer position.
void	setMaskingLayers(ILayer layer, ISet maskingLayers) The masks for a layer.
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	setMultidimensionalDefinitionByRef(IMultidimensionalDefinition ppMultidimensionalDefinition) An array of dimensional value objects.
void	setName(java.lang.String name) Layer name.
void	setRelativeBase(java.lang.String basePath) Base path used when storing relative path names.
void	setScale(double rhs1) The current scale of the display.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setStartTimeFieldName(java.lang.String fieldName) Name of the field that has start time for a row.
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	setTimeReferenceByRef(ITimeReference nativeTimeReference) Time reference for the data.
void	setTimeValueFormat(java.lang.String format) Time value format if the field name is of the string format.
void	setTrackIDFieldName(java.lang.String fieldName) Field that contains the rows that uniquely identifies the object whose time is being tracked.
void	setTransparency(short alpha) Layer transparency in percent (0-100).
void	setUseMasking(boolean flag) Indicates whether to use masking.
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	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

MosaicLayer

public MosaicLayer()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a MosaicLayer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MosaicLayer

public MosaicLayer(java.lang.Object obj)
            throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems MosaicLayer theMosaicLayer = (MosaicLayer) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a MosaicLayer.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

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

Layer name.

Description

Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ILayer

Specified by:

getName in interface ILayer2

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

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

Layer name.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ILayer

Specified by:

setName in interface ILayer2

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException

Indicates if the layer is currently valid.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isValid in interface ILayer

Specified by:

isValid in interface ILayer2

Returns:

The valid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException

The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaOfInterest in interface ILayer

Specified by:

getAreaOfInterest in interface ILayer2

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws java.io.IOException,
                              AutomationException

Minimum scale (representative fraction) at which the layer will display.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumScale in interface ILayer

Specified by:

getMinimumScale in interface ILayer2

Returns:

The minScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws java.io.IOException,
                            AutomationException

Minimum scale (representative fraction) at which the layer will display.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumScale in interface ILayer

Specified by:

setMinimumScale in interface ILayer2

Parameters:

minScale - The minScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws java.io.IOException,
                              AutomationException

Maximum scale (representative fraction) at which the layer will display.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaximumScale in interface ILayer

Specified by:

getMaximumScale in interface ILayer2

Returns:

The maxScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws java.io.IOException,
                            AutomationException

Maximum scale (representative fraction) at which the layer will display.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaximumScale in interface ILayer

Specified by:

setMaximumScale in interface ILayer2

Parameters:

maxScale - The maxScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ILayer

Specified by:

isVisible in interface ILayer2

Returns:

The visible

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the layer is currently visible.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface ILayer

Specified by:

setVisible in interface ILayer2

Parameters:

visible - The visible (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowTips

public boolean isShowTips()
                   throws java.io.IOException,
                          AutomationException

Indicates if the layer shows map tips.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowTips in interface ILayer

Specified by:

isShowTips in interface ILayer2

Returns:

The show

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer shows map tips.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowTips in interface ILayer

Specified by:

setShowTips in interface ILayer2

Parameters:

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTipText

public java.lang.String getTipText(double x,
                                   double y,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Map tip text at the specified location.

Product Availability

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

Specified by:

getTipText in interface ILayer

Specified by:

getTipText in interface ILayer2

Parameters:

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer needs its own display cache.

Remarks

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCached in interface ILayer

Specified by:

isCached in interface ILayer2

Returns:

The cached

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws java.io.IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Description

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

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCached in interface ILayer

Specified by:

setCached in interface ILayer2

Parameters:

cached - The cached (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

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

Supported draw phases.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSupportedDrawPhases in interface ILayer

Specified by:

getSupportedDrawPhases in interface ILayer2

Returns:

The drawPhases

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.IOException,
                                     AutomationException

Spatial reference for the layer.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpatialReferenceByRef in interface ILayer

Specified by:

setSpatialReferenceByRef in interface ILayer2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the layer to the specified display for the given draw phase.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ILayer

Specified by:

draw in interface ILayer2

Parameters:

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilePath

public java.lang.String getFilePath()
                             throws java.io.IOException,
                                    AutomationException

Filepath of the data source.

Specified by:

getFilePath in interface IMosaicLayer

Returns:

The filePath

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicDataset

public IMosaicDataset getMosaicDataset()
                                throws java.io.IOException,
                                       AutomationException

The Mosaic Dataset referenced by the Mosaic Layer.

Specified by:

getMosaicDataset in interface IMosaicLayer

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFootprintLayer

public IFeatureLayer getFootprintLayer()
                                throws java.io.IOException,
                                       AutomationException

The footprint layer referenced by the Mosaic Layer.

Specified by:

getFootprintLayer in interface IMosaicLayer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundaryLayer

public IFeatureLayer getBoundaryLayer()
                               throws java.io.IOException,
                                      AutomationException

The Boundary layer referenced by the Mosaic Layer.

Specified by:

getBoundaryLayer in interface IMosaicLayer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreviewLayer

public IImageServerLayer getPreviewLayer()
                                  throws java.io.IOException,
                                         AutomationException

The preview layer referenced by the Mosaic Layer.

Specified by:

getPreviewLayer in interface IMosaicLayer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeamlineLayer

public IFeatureLayer getSeamlineLayer()
                               throws java.io.IOException,
                                      AutomationException

The seamline layer referenced by the Mosaic Layer.

Specified by:

getSeamlineLayer in interface IMosaicLayer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFromMosaicDataset

public void createFromMosaicDataset(IMosaicDataset mosaicDataset)
                             throws java.io.IOException,
                                    AutomationException

Creates the layer from the mosaic dataset

Specified by:

createFromMosaicDataset in interface IMosaicLayer

Parameters:

mosaicDataset - A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFromFilePath

public void createFromFilePath(java.lang.String filePath)
                        throws java.io.IOException,
                               AutomationException

Creates the layer from a file path to the mosaic dataset

Specified by:

createFromFilePath in interface IMosaicLayer

Parameters:

filePath - The filePath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException

Number of layers in the collection.

Specified by:

getCount in interface ICompositeLayer

Specified by:

getCount in interface ICompositeLayer2

Returns:

The layerCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException

Layer in the collection at the specified index.

Specified by:

getLayer in interface ICompositeLayer

Specified by:

getLayer in interface ICompositeLayer2

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpanded

public boolean isExpanded()
                   throws java.io.IOException,
                          AutomationException

Indicates if the layer is expanded in the TOC.

Specified by:

isExpanded in interface ICompositeLayer2

Returns:

The expanded

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpanded

public void setExpanded(boolean expanded)
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer is expanded in the TOC.

Specified by:

setExpanded in interface ICompositeLayer2

Parameters:

expanded - The expanded (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSourceName

public IName getDataSourceName()
                        throws java.io.IOException,
                               AutomationException

Name of the data object for the layer.

Specified by:

getDataSourceName in interface IDataLayer

Specified by:

getDataSourceName in interface IDataLayer2

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws java.io.IOException,
                              AutomationException

Name of the data object for the layer.

Specified by:

setDataSourceName in interface IDataLayer

Specified by:

setDataSourceName in interface IDataLayer2

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:

isDataSourceSupported in interface IDataLayer

Specified by:

isDataSourceSupported in interface IDataLayer2

Parameters:

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

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws java.io.IOException,
                       AutomationException

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

Specified by:

connect in interface IDataLayer

Specified by:

connect in interface IDataLayer2

Parameters:

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

Returns:

The succeeded

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public java.lang.String getRelativeBase()
                                 throws java.io.IOException,
                                        AutomationException

Base path used when storing relative path names.

Specified by:

getRelativeBase in interface IDataLayer

Specified by:

getRelativeBase in interface IDataLayer2

Returns:

The basePath

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(java.lang.String basePath)
                     throws java.io.IOException,
                            AutomationException

Base path used when storing relative path names.

Specified by:

setRelativeBase in interface IDataLayer

Specified by:

setRelativeBase in interface IDataLayer2

Parameters:

basePath - The basePath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

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

Disconnects the data from the layer.

Specified by:

disconnect in interface IDataLayer2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws java.io.IOException,
                           AutomationException

Returns TRUE if the layer is in the specified workspace.

Specified by:

inWorkspace in interface IDataLayer2

Parameters:

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

Returns:

The inWorkspace

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IGeoDataset

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsTime

public boolean isSupportsTime()
                       throws java.io.IOException,
                              AutomationException

Indicates whether the layer has any time data.

Specified by:

isSupportsTime in interface ITimeData

Returns:

The hasTime

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseTime

public boolean isUseTime()
                  throws java.io.IOException,
                         AutomationException

Indicates whether to use the time for animation purposes.

Specified by:

isUseTime in interface ITimeData

Returns:

The useTime

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseTime

public void setUseTime(boolean useTime)
                throws java.io.IOException,
                       AutomationException

Indicates whether to use the time for animation purposes.

Specified by:

setUseTime in interface ITimeData

Parameters:

useTime - The useTime (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException

Time reference for the contents of the layer.

Specified by:

getTimeReference in interface ITimeData

Specified by:

getTimeReference in interface ITimeTableDefinition

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:

getFullTimeExtent in interface ITimeData

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasLiveData

public boolean isHasLiveData()
                      throws java.io.IOException,
                             AutomationException

isHasLiveData

Specified by:

isHasLiveData in interface ITimeData2

Returns:

The useTime

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasLiveData

public void setHasLiveData(boolean useTime)
                    throws java.io.IOException,
                           AutomationException

setHasLiveData

Specified by:

setHasLiveData in interface ITimeData2

Parameters:

useTime - The useTime (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTimeFieldName

public java.lang.String getStartTimeFieldName()
                                       throws java.io.IOException,
                                              AutomationException

Name of the field that has start time for a row.

Specified by:

getStartTimeFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTimeFieldName

public void setStartTimeFieldName(java.lang.String fieldName)
                           throws java.io.IOException,
                                  AutomationException

Name of the field that has start time for a row.

Specified by:

setStartTimeFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

public java.lang.String getEndTimeFieldName()
                                     throws java.io.IOException,
                                            AutomationException

Name of the field that has end time for a row.

Specified by:

getEndTimeFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTimeFieldName

public void setEndTimeFieldName(java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException

Name of the field that has end time for a row.

Specified by:

setEndTimeFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

public java.lang.String getTimeValueFormat()
                                    throws java.io.IOException,
                                           AutomationException

Time value format if the field name is of the string format.

Specified by:

getTimeValueFormat in interface ITimeTableDefinition

Returns:

The format

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValueFormat

public void setTimeValueFormat(java.lang.String format)
                        throws java.io.IOException,
                               AutomationException

Time value format if the field name is of the string format.

Specified by:

setTimeValueFormat in interface ITimeTableDefinition

Parameters:

format - The format (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

public java.lang.String getTrackIDFieldName()
                                     throws java.io.IOException,
                                            AutomationException

Field that contains the rows that uniquely identifies the object whose time is being tracked.

Specified by:

getTrackIDFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackIDFieldName

public void setTrackIDFieldName(java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException

Field that contains the rows that uniquely identifies the object whose time is being tracked.

Specified by:

setTrackIDFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference nativeTimeReference)
                           throws java.io.IOException,
                                  AutomationException

Time reference for the data.

Specified by:

setTimeReferenceByRef in interface ITimeTableDefinition

Parameters:

nativeTimeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomTimeExtent

public ITimeExtent getCustomTimeExtent()
                                throws java.io.IOException,
                                       AutomationException

Custom time extent during which a layer is visible.

Specified by:

getCustomTimeExtent in interface ITimeTableDefinition

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomTimeExtentByRef

public void setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime)
                              throws java.io.IOException,
                                     AutomationException

Custom time extent during which a layer is visible.

Specified by:

setCustomTimeExtentByRef in interface ITimeTableDefinition

Parameters:

layerVisibiltyTime - A reference to a com.esri.arcgis.system.ITimeExtent (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeDataCumulative

public void setTimeDataCumulative(boolean cumilative)
                           throws java.io.IOException,
                                  AutomationException

Indicates that features will be animated cumilatively.

Specified by:

setTimeDataCumulative in interface ITimeDataDisplay

Parameters:

cumilative - The cumilative (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTimeDataCumulative

public boolean isTimeDataCumulative()
                             throws java.io.IOException,
                                    AutomationException

Indicates that features will be animated cumilatively.

Specified by:

isTimeDataCumulative in interface ITimeDataDisplay

Returns:

The cumilative

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeInterval

public void setTimeInterval(double interval)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setTimeInterval in interface ITimeDataDisplay

Parameters:

interval - The interval (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeInterval

public double getTimeInterval()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

getTimeInterval in interface ITimeDataDisplay

Returns:

The interval

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeIntervalUnits

public void setTimeIntervalUnits(int units)
                          throws java.io.IOException,
                                 AutomationException

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

Specified by:

setTimeIntervalUnits in interface ITimeDataDisplay

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

public int getTimeIntervalUnits()
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

getTimeIntervalUnits in interface ITimeDataDisplay

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeOffset

public void setTimeOffset(double timeOffset)
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

setTimeOffset in interface ITimeDataDisplay

Parameters:

timeOffset - The timeOffset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeOffset

public double getTimeOffset()
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

getTimeOffset in interface ITimeDataDisplay

Returns:

The timeOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeOffsetUnits

public void setTimeOffsetUnits(int units)
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

setTimeOffsetUnits in interface ITimeDataDisplay

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeOffsetUnits

public int getTimeOffsetUnits()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

getTimeOffsetUnits in interface ITimeDataDisplay

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws java.io.IOException,
                         AutomationException

Small image that represents the layer.

Specified by:

getSmallImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws java.io.IOException,
                                 AutomationException

Small image that represents the layer when it is selected.

Specified by:

getSmallSelectedImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws java.io.IOException,
                         AutomationException

Large image that represents the layer.

Specified by:

getLargeImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws java.io.IOException,
                                 AutomationException

Large image that represents the layer when it is selected.

Specified by:

getLargeSelectedImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

The associated name object.

Specified by:

getFullName in interface IDataset

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException

The browse name of the dataset.

Specified by:

getBrowseName in interface IDataset

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrowseName

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

The browse name of the dataset.

Specified by:

setBrowseName in interface IDataset

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type of the Dataset.

Specified by:

getType in interface IDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException

The category of the dataset.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException

Datasets contained within this dataset.

Specified by:

getSubsets in interface IDataset

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumDataset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

The workspace containing this dataset.

Specified by:

getWorkspace in interface IDataset

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException

The set of properties for the dataset.

Specified by:

getPropertySet in interface IDataset

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException

True if this dataset can be copied.

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException

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

Specified by:

copy in interface IDataset

Parameters:

copyName - The copyName (in)

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IDataset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException

True if this dataset can be deleted.

Specified by:

canDelete in interface IDataset

Returns:

The canDelete

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

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

Deletes this dataset.

Specified by:

delete in interface IDataset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException

True if this dataset can be renamed.

Specified by:

canRename in interface IDataset

Returns:

The canRename

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rename

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

Renames this Dataset.

Specified by:

rename in interface IDataset

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributeTable

public ITable getAttributeTable()
                         throws java.io.IOException,
                                AutomationException

The attribute table.

Specified by:

getAttributeTable in interface IAttributeTable

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

public java.lang.String getDefinitionExpression()
                                         throws java.io.IOException,
                                                AutomationException

Definition query expression for the existing layer.

Specified by:

getDefinitionExpression in interface ITableDefinition

Returns:

The expression

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

public void setDefinitionExpression(java.lang.String expression)
                             throws java.io.IOException,
                                    AutomationException

Definition query expression for the existing layer.

Specified by:

setDefinitionExpression in interface ITableDefinition

Parameters:

expression - The expression (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionSelectionSet

public ISelectionSet getDefinitionSelectionSet()
                                        throws java.io.IOException,
                                               AutomationException

The selection set that defines the subset of features in a selection layer.

Specified by:

getDefinitionSelectionSet in interface ITableDefinition

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws java.io.IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

identify in interface IIdentify

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identify

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

Identifies objects at the specified location.

Specified by:

identify in interface IIdentify2

Parameters:

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(double rhs1)
              throws java.io.IOException,
                     AutomationException

The current scale of the display.

Specified by:

setScale in interface IIdentify2

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

isScaleRangeReadOnly in interface ILayer2

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException

The default area of interest for the layer.

Specified by:

setAreaOfInterest in interface ILayer2

Parameters:

aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws java.io.IOException,
                                   AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDrawingPropsDirty in interface ILayerDrawingProperties

Returns:

The dirty

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDrawingPropsDirty in interface ILayerDrawingProperties

Parameters:

dirty - The dirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws java.io.IOException,
                                      AutomationException

Indicates if the layer supports transparency.

Specified by:

isSupportsTransparency in interface ILayerEffects

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if the layer supports contrast changes.

Specified by:

isSupportsContrastChange in interface ILayerEffects

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws java.io.IOException,
                                          AutomationException

Indicates if the layer supports brightness changes.

Specified by:

isSupportsBrightnessChange in interface ILayerEffects

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Specified by:

setSupportsInteractive in interface ILayerEffects

Parameters:

supported - The supported (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws java.io.IOException,
                                     AutomationException

Indicates if the layer supports interactive effects changes.

Specified by:

isSupportsInteractive in interface ILayerEffects

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws java.io.IOException,
                             AutomationException

Layer transparency in percent (0-100).

Specified by:

getTransparency in interface ILayerEffects

Returns:

The alpha

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws java.io.IOException,
                            AutomationException

Layer transparency in percent (0-100).

Specified by:

setTransparency in interface ILayerEffects

Parameters:

alpha - The alpha (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws java.io.IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

getContrast in interface ILayerEffects

Returns:

The contrastValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws java.io.IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

setContrast in interface ILayerEffects

Parameters:

contrastValue - The contrastValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws java.io.IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

getBrightness in interface ILayerEffects

Returns:

The brightnessValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws java.io.IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

setBrightness in interface ILayerEffects

Parameters:

brightnessValue - The brightnessValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionCount

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

Number of extensions.

Specified by:

getExtensionCount in interface ILayerExtensions

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtension

public java.lang.Object getExtension(int index)
                              throws java.io.IOException,
                                     AutomationException

The extension at the specified index.

Specified by:

getExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(java.lang.Object ext)
                  throws java.io.IOException,
                         AutomationException

Adds a new extension.

Specified by:

addExtension in interface ILayerExtensions

Parameters:

ext - A reference to another Object (IUnknown) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws java.io.IOException,
                            AutomationException

Removes the specified extension.

Specified by:

removeExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

public double getLastMinimumScale()
                           throws java.io.IOException,
                                  AutomationException

Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMinimumScale in interface ILayerGeneralProperties

Returns:

The minScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws java.io.IOException,
                                  AutomationException

Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMaximumScale in interface ILayerGeneralProperties

Returns:

The maxScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public java.lang.String ILayerGeneralProperties_getLayerDescription()
                                                             throws java.io.IOException,
                                                                    AutomationException

Description for the layer.

Product Availability

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

Specified by:

ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(java.lang.String text)
                         throws java.io.IOException,
                                AutomationException

Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLayerDescription in interface ILayerGeneralProperties

Parameters:

text - The text (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseMasking

public void setUseMasking(boolean flag)
                   throws java.io.IOException,
                          AutomationException

Indicates whether to use masking.

Specified by:

setUseMasking in interface ILayerMasking

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseMasking

public boolean isUseMasking()
                     throws java.io.IOException,
                            AutomationException

Indicates whether to use masking.

Specified by:

isUseMasking in interface ILayerMasking

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaskingLayers

public void setMaskingLayers(ILayer layer,
                             ISet maskingLayers)
                      throws java.io.IOException,
                             AutomationException

The masks for a layer.

Specified by:

setMaskingLayers in interface ILayerMasking

Parameters:

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

maskingLayers - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaskingLayers

public ISet getMaskingLayers(ILayer layer)
                      throws java.io.IOException,
                             AutomationException

The masks for a layer.

Specified by:

getMaskingLayers in interface ILayerMasking

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearMasking

public void clearMasking(ILayer layer)
                  throws java.io.IOException,
                         AutomationException

Clear masking layers on a layer.

Specified by:

clearMasking in interface ILayerMasking

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaskedLayers

public ISet getMaskedLayers()
                     throws java.io.IOException,
                            AutomationException

The set of layers that are being masked.

Specified by:

getMaskedLayers in interface ILayerMasking

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerWeight

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

Default layer position.

Specified by:

getLayerWeight in interface ILayerPosition

Returns:

The layerWeight

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerWeight

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

Default layer position.

Specified by:

setLayerWeight in interface ILayerPosition

Parameters:

layerWeight - The layerWeight (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

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

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

Specified by:

expandRegionForSymbols in interface ILayerSymbologyExtents

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsPublishing

public boolean isSupportsPublishing()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the layer supports the publishing process.

Specified by:

isSupportsPublishing in interface IPublishLayer

Returns:

The bValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPublishingDescription

public java.lang.String getPublishingDescription()
                                          throws java.io.IOException,
                                                 AutomationException

The layer description reported to the publisher.

Specified by:

getPublishingDescription in interface IPublishLayer

Returns:

The bsDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDataValid

public boolean isDataValid()
                    throws java.io.IOException,
                           AutomationException

Indicates if the data for the layer is currently valid.

Specified by:

isDataValid in interface IPublishLayer

Returns:

The bDataValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataDetails

public java.lang.String getDataDetails(java.lang.String bsPadding)
                                throws java.io.IOException,
                                       AutomationException

Details of the layer's data.

Specified by:

getDataDetails in interface IPublishLayer

Parameters:

bsPadding - The bsPadding (in)

Returns:

The bsDataDetails

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepareForPublishing

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

Prepare the layer for the publishing process.

Specified by:

prepareForPublishing in interface IPublishLayer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onEvent

public void onEvent(IRasterDataManagementEventsOnEventEvent theEvent)
             throws java.io.IOException,
                    AutomationException

Performs operation on the raster data management event.

Specified by:

onEvent in interface IRasterDataManagementEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws java.io.IOException,
                            AutomationException

Indicates if the current object draws using a filter.

Specified by:

isUsesFilter in interface IDisplayAdmin

Specified by:

isUsesFilter in interface IDisplayAdmin2

Returns:

The usesFilter

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRequiresBanding

public boolean isRequiresBanding()
                          throws java.io.IOException,
                                 AutomationException

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

Specified by:

isRequiresBanding in interface IDisplayAdmin2

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDoesBlending

public boolean isDoesBlending()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

isDoesBlending in interface IDisplayAdmin2

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayFilter

public void setDisplayFilter(IDisplayFilter displayFilter)
                      throws java.io.IOException,
                             AutomationException

The display filter.

Specified by:

setDisplayFilter in interface IDisplayFilterManager

Parameters:

displayFilter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayFilter

public IDisplayFilter getDisplayFilter()
                                throws java.io.IOException,
                                       AutomationException

The display filter.

Specified by:

getDisplayFilter in interface IDisplayFilterManager

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStartEditing

public void onStartEditing(IWorkspaceEditEventsOnStartEditingEvent theEvent)
                    throws java.io.IOException,
                           AutomationException

This event is fired after editing is started on a workspace.

Specified by:

onStartEditing in interface IWorkspaceEditEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStopEditing

public void onStopEditing(IWorkspaceEditEventsOnStopEditingEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

This event is fired after editing is stopped on a workspace.

Specified by:

onStopEditing in interface IWorkspaceEditEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStartEditOperation

public void onStartEditOperation(IWorkspaceEditEventsOnStartEditOperationEvent theEvent)
                          throws java.io.IOException,
                                 AutomationException

This event is fired after an edit operation is started.

Specified by:

onStartEditOperation in interface IWorkspaceEditEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onAbortEditOperation

public void onAbortEditOperation(IWorkspaceEditEventsOnAbortEditOperationEvent theEvent)
                          throws java.io.IOException,
                                 AutomationException

This event is fired after an edit operation is aborted. Any cached row objects must be discarded / refreshed.

Specified by:

onAbortEditOperation in interface IWorkspaceEditEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStopEditOperation

public void onStopEditOperation(IWorkspaceEditEventsOnStopEditOperationEvent theEvent)
                         throws java.io.IOException,
                                AutomationException

This event is fired after an edit operation is stopped (successfully completed).

Specified by:

onStopEditOperation in interface IWorkspaceEditEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onUndoEditOperation

public void onUndoEditOperation(IWorkspaceEditEventsOnUndoEditOperationEvent theEvent)
                         throws java.io.IOException,
                                AutomationException

This event is fired after a (completed) edit operation is undone. Any cached row objects must be discarded / refreshed.

Specified by:

onUndoEditOperation in interface IWorkspaceEditEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onRedoEditOperation

public void onRedoEditOperation(IWorkspaceEditEventsOnRedoEditOperationEvent theEvent)
                         throws java.io.IOException,
                                AutomationException

This event is fired after an undone edit operation is redone. Any cached row objects must be discarded / refreshed.

Specified by:

onRedoEditOperation in interface IWorkspaceEditEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCLSID

public GUID getCLSID()
              throws java.io.IOException,
                     AutomationException

Identify class ID for an object.

Specified by:

getCLSID in interface IClassID

Returns:

A Structure: com.esri.arcgis.support.ms.stdole.GUID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgID

public java.lang.String getProgID()
                           throws java.io.IOException,
                                  AutomationException

Identify ProgID for an object.

Specified by:

getProgID in interface IClassID

Returns:

The pProgID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

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

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMultidimensionalDefinition

public IMultidimensionalDefinition getMultidimensionalDefinition()
                                                          throws java.io.IOException,
                                                                 AutomationException

An array of dimensional value objects.

Specified by:

getMultidimensionalDefinition in interface IMultidimensionalLayer

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IMultidimensionalDefinition

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMultidimensionalDefinitionByRef

public void setMultidimensionalDefinitionByRef(IMultidimensionalDefinition ppMultidimensionalDefinition)
                                        throws java.io.IOException,
                                               AutomationException

An array of dimensional value objects.

Specified by:

setMultidimensionalDefinitionByRef in interface IMultidimensionalLayer

Parameters:

ppMultidimensionalDefinition - A reference to a com.esri.arcgis.datasourcesraster.IMultidimensionalDefinition (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionDefinitionQuery

public java.lang.String getDimensionDefinitionQuery()
                                             throws java.io.IOException,
                                                    AutomationException

Dimension definition query for multi-dimensional dataset.

Specified by:

getDimensionDefinitionQuery in interface IMultidimensionalLayer

Returns:

The pDefQuery

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDimensionDefinitionQuery

public void setDimensionDefinitionQuery(java.lang.String pDefQuery)
                                 throws java.io.IOException,
                                        AutomationException

Dimension definition query for multi-dimensional dataset.

Specified by:

setDimensionDefinitionQuery in interface IMultidimensionalLayer

Parameters:

pDefQuery - The pDefQuery (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeDimensionDefinitionQuery

public java.lang.String getTimeDimensionDefinitionQuery()
                                                 throws java.io.IOException,
                                                        AutomationException

Time definition query for multi-dimensional dataset.

Specified by:

getTimeDimensionDefinitionQuery in interface IMultidimensionalLayer

Returns:

The pDefQuery

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException