com.esri.arcgis.carto
Class RasterLayer

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

All Implemented Interfaces:

IAttributeTable, IDataLayer, IDataLayer2, IDisplayRelationshipClass, IDisplayTable, IGeoReference, IIdentify, ILayer, ILayer2, ILayerDrawingProperties, ILayerDrawSetup, ILayerEffects, ILayerExtensions, ILayerFields, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILegendInfo, IPublishLayer, IRasterLayer, IRasterSpatialSelection, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ITableSelection, ITemporaryLayer, ITimeData, ITimeData2, ITimeDataDisplay, ITimeDimensionDefinition, IRasterDataManagementEvents, IConnectionPointContainer, IDisplayAdmin, IDisplayAdmin2, IClass, IDataset, IGeoDataset, IObjectClass, IObjectClassSchemaEvents, ITable, ITableFields, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class RasterLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterLayer, IGeoDataset, ILegendInfo, IPersistStream, IIdentify, ILayerInfo, IDataLayer, IDataLayer2, ILayerEffects, IDisplayAdmin, IDisplayAdmin2, IGeoReference, IDisplayTable, ITableSelection, IClass, ITable, IObjectClass, ILayerFields, ITableFields, IDisplayRelationshipClass, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ILayerExtensions, ILayerDrawingProperties, ILayerGeneralProperties, ILayerPosition, IAttributeTable, IConnectionPointContainer, IDataset, IPublishLayer, IRasterSpatialSelection, IRasterDataManagementEvents, ITemporaryLayer, ILayer2, ITimeData, ITimeData2, ITimeDataDisplay, ITimeDimensionDefinition, ILayerDrawSetup, IObjectClassSchemaEvents, java.io.Externalizable

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

Description 'Raster layer source and display options.' 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.IRasterLayer

IID, IIDd02371c7_35f7_11d2_b1f2_00c04f8edeff, 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.ILayerInfo

IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy

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

IID, IID6ca416b1_e160_11d2_9f4e_00c04f6bc78e, xxDummy

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

IID, IIDe9d11f65_6936_4408_b69f_d91552eb9c4a, xxDummy

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

IID, IID09998199_1fb8_11d3_ab4e_000000000000, xxDummy

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

IID, IID12e361f0_1907_11d3_80c7_0080c79f0371, xxDummy

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

IID, IIDd915ec07_7b4f_47fd_b59b_3252f3a3b610, xxDummy

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

IID, IIDe70e1cc1_e5c6_11d3_b9c5_00c0f0567a4a, xxDummy

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

IID, IIDcce71a6d_6135_46cd_bbed_616a74831b30, xxDummy

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

IID, IID2c232271_fbaa_11d3_b9d3_00c0f0567a4a, xxDummy

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

IID, IIDfcb01cb5_9f0b_11d0_bec7_00805f7c4268, xxDummy

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

IID, IID1afcdb31_ac09_11d2_8a1e_006097aff44e, xxDummy

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

IID1afcdb32_ac09_11d2_8a1e_006097aff44e

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

IID, IIDa2baae2b_969b_11d2_ae77_080009ec732a, xxDummy

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

IID, IIDe5966b0a_e3d9_11d3_a096_00c04f6bc626, xxDummy

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

IID, IID55a4e17e_8682_42ba_8866_ab04db883934, xxDummy

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

IID, IID741d6114_fb6b_11d3_adf5_00c04fa33a15, xxDummy

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

IID, IIDb725de95_ff76_11d3_a0b5_00c04f6bc626, 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.ILayerPosition

IID, IIDc0dc8820_e10f_4285_aab1_6c6b685dbb84, xxDummy

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

IID, IID07f3186c_af91_4ad6_bf67_11167d0f8f60, xxDummy

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

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, 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.IPublishLayer

IID, IID7453c805_9d64_44a6_bf2f_73e477dce18f, xxDummy

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

IID, IID9466d4e6_937d_40c6_8709_56eb94c3c9b5, xxDummy

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

IID, IID5901c657_d66f_4c40_8976_05b663cb38e2, xxDummy

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

IID, IIDfceff094_8e6a_4972_9bb4_429c71b07289, 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.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.ITimeDataDisplay

IID, IIDf12874c3_3358_40a5_8e32_c824dd1d75fa, xxDummy

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

IID, IIDf1f9cc71_5f24_4176_9ba4_9d8af7195a3e, xxDummy

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

IID, IIDbe9dc638_bd42_4319_8254_9f23fb866deb, xxDummy

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

IID, IIDf1e8911b_6bc5_11d3_a021_00c04f6bdf0e, xxDummy

Constructor Summary

RasterLayer()
Constructs a RasterLayer using ArcGIS Engine.

RasterLayer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterLayer theRasterLayer = (RasterLayer) obj;

Method Summary

void	addExtension(java.lang.Object ext) Adds a new extension.
void	addField(IField field) Adds a field to this object class.
void	addIGeoReferenceEventsListener(IGeoReferenceEvents theListener) addIGeoReferenceEventsListener.
void	addILayerEventsListener(ILayerEvents theListener) addILayerEventsListener.
void	addIndex(IIndex index) Adds an index to this object class.
void	addRelationshipClass(IRelationshipClass relationshipClass) Adds the specified memory relationship class to a standalone table or layer.
void	addRow(IRow row) Adds a row to the selection set (honoring the current combination method).
void	afterDraw(int viewPhase, IDisplay display, ITrackCancel trackCancel) Executes after the layer drawn to the display for the given draw phase.
void	beforeDraw(int viewPhase, IDisplay display, ITrackCancel trackCancel) Executes before the layer draws to the display for the given draw phase.
boolean	canCopy() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
void	clear() Clears the selection.
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	createFromDataset(IRasterDataset rasterDataset) Creates a layer from a RasterDataset object.
void	createFromFilePath(java.lang.String filePath) Creates a layer from a file path to raster data.
void	createFromRaster(IRaster raster) Creates a layer from a Raster object.
IRow	createRow() Creates a row in the database with a system assigned object ID and null property values.
IRowBuffer	createRowBuffer() Creates a row buffer that can be used with an insert cursor.
void	delete() Deletes this dataset.
void	deleteField(IField field) Deletes a field from this object class.
void	deleteIndex(IIndex index) Deletes an index from this object class.
void	deleteSearchedRows(IQueryFilter queryFilter) Delete the Rows in the database selected by the specified query.
void	disconnect() Disconnects the data from the layer.
void	displayRelationshipClass(IRelationshipClass relClass, int joinType) Sets a join based on the specified relationship class and join type.
void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
void	drawSpatialSelection(IDisplay pDisplay, ITrackCancel pTrackCancel) Draws the current spatial selection.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
int	findField(java.lang.String name) The index of the field with the specified name.
IEnumRelationshipClass	findRelationshipClasses(IObjectClass objectClass, int role) Finds all relationship classes in the collection that reference the given object class in the specified role.
void	flip() Flip operation of layer.
java.lang.String	getAliasName() The alias name of the object class.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
ITable	getAttributeTable() The attribute table.
int	getBandCount() Number of bands in the 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.
IUID	getCLSID() The GUID for the COM Class (CoClass) corresponding to instances of this object class.
int	getColumnCount() Number of columns in the layer.
short	getContrast() Layer contrast in percent (-100 - 100).
java.lang.String	getDataDetails(java.lang.String bsPadding) Details of the layer's data.
IEnvelope	getDataFrameExtent() Extent of the dataframe that contains the layer.
IName	getDataSourceName() Name of the data object for the layer.
int	getDisplayResolutionFactor() Display resolution factor.
ISelectionSet	getDisplaySelectionSet() The selected set of rows from the display table.
ITable	getDisplayTable() The display table.
IUID	getEXTCLSID() The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
java.lang.Object	getExtension() The extension for this object class.
java.lang.Object	getExtension(int index) The extension at the specified index.
int	getExtensionCount() Number of extensions.
IPropertySet	getExtensionProperties() The extension properties for this object class.
IEnvelope	getExtent() The extent of the GeoDataset.
IField	getField(int index) The field at the specified index.
int	getFieldCount() The number of fields.
IFieldInfo	getFieldInfo(int index) Extended field information for the field at the specified index.
IFields	getFields() The fields collection for this object class.
java.lang.String	getFilePath() Filepath of the data source.
IName	getFullName() The associated name object.
ITimeExtent	getFullTimeExtent() Returns the time extent for all the data in the layer.
IIndexes	getIndexes() The indexes collection for this object class.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getJoinType() Join type for the most recent join performed.
int	getLargeImage() Large image that represents the layer.
int	getLargeSelectedImage() Large image that represents the layer when it is selected.
double	getLastMaximumScale() Last maximum scale setting used by layer.
double	getLastMinimumScale() Last minimum scale setting used by layer.
double	getLayerWeight() Default layer position.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
IRasterDataset	getMaskRasterDataset() Reference to the current selection dataset.
double	getMaximumScale() Maximum scale (representative fraction) at which the layer will display.
double	getMinimumScale() Minimum scale (representative fraction) at which the layer will display.
java.lang.String	getName() The name of the Dataset.
int	getObjectClassID() The unique ID for the object class.
java.lang.String	getOIDFieldName() The name of the field corresponding to the OID.
int	getPrimaryField() Layer's primary field.
IPropertySet	getPropertySet() The set of properties for the dataset.
java.lang.String	getPublishingDescription() The layer description reported to the publisher.
IRaster	getRaster() Layer's Raster object.
IRelationshipClass	getRelationshipClass() Relationship class that defines how the tables are joined.
IEnumRelationshipClass	getRelationshipClasses() The memory relationship classes.
IEnumRelationshipClass	getRelationshipClasses(int role) The relationship classes in which this object class participates in for the specified role.
java.lang.String	getRelativeBase() Base path used when storing relative path names.
IRasterRenderer	getRenderer() Layer's renderer.
IRow	getRow(int oID) The row from the database with the specified object ID.
int	getRowCount() Number of rows in the layer.
ICursor	getRows(java.lang.Object oids, boolean recycling) The cursor of rows based on a set of object ids.
ISelectionSet	getSelectionSet() The selected set of rows.
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.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getSupportedDrawPhases() Supported draw phases.
java.lang.String	getTimeDimensionFormat() Returns the format of the dimension that represents time.
java.lang.String	getTimeDimensionName() Returns the name of the dimension that represents time.
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	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
short	getTransparency() Layer transparency in percent (0-100).
int	getType() The type of the Dataset.
IEnvelope	getVisibleExtent() Visible extent of the layer in the data frame.
IWorkspace	getWorkspace() The workspace containing this dataset.
int	hashCode() the hashcode for this object
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
java.lang.String	ILayerGeneralProperties_getLayerDescription() Description for the layer.
void	init(boolean bInit, java.lang.String fileFullName, int fileFormat) Create or remove the selection dataset.
ICursor	insert(boolean useBuffering) Returns a cursor that can be used to insert new Rows.
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	isCanGeoRef() Indicates if layer can be georeferenced.
boolean	isDataSourceSupported(IName name) Indicates if the specified data object name is supported by the layer.
boolean	isDataValid() Indicates if the data for the layer is currently valid.
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	isHasLiveData() isHasLiveData
boolean	isHasOID() Indicates if the class has an object identity (OID) field.
boolean	isMultiDimensional() Indicates whether the data is multi-dimensional.
boolean	isPyramidPresent() Indicates if pyramids are present for the layer.
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	isShowResolution() Indicates if the raster resolution should be displayed in the Table of Contents.
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	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isTemporary() Indicates if the layer is a temporary layer.
boolean	isTimeDataCumulative() Indicates that features will be animated cumilatively.
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.
ICursor	ITable_search(IQueryFilter queryFilter, boolean recycling) An object cursor that can be used to fetch row objects selected by the specified query.
void	load(IStream pstm) load
void	maskDrawPolyRect(ITrackCancel trackCancel, java.lang.Object vRects, int op) Perform the mask operation with the given array of rectangles.
void	maskReadBitmap(ITrackCancel trackCancel, tagRECT pRect, java.lang.Object vBytes, boolean byBits) Read pixels from selection.
void	maskWriteBitmap(ITrackCancel trackCancel, tagRECT pRect, int op, java.lang.Object vBytes, boolean byBits) Perform the mask operation with bitmask.
void	mirror() Mirror operation of layer.
void	onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent) This event is fired when a new field is added to the object class.
void	onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent) This event is fired when the behavior class for the object class changes.
void	onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent) This event is fired when a field is deleted from the object class.
void	onEvent(IRasterDataManagementEventsOnEventEvent theEvent) Performs operation on the raster data management event.
IPointCollection	pointsTransform(IPointCollection inPoints, boolean isForward) Transform operation of Raster.
void	prepareForPublishing() Prepare the layer for the publishing process.
void	readExternal(java.io.ObjectInput in)
void	rectify(java.lang.String fullpath, java.lang.String format) Save transformed result to a new dataset.
void	register() Save transformation parameters and tie-points.
void	release() Release a RasterLayer.
void	removeAllRelationshipClasses() Removes all memory relationship classes from a standalone table or layer.
void	removeExtension(int index) Removes the specified extension.
void	removeIGeoReferenceEventsListener(IGeoReferenceEvents theListener) removeIGeoReferenceEventsListener.
void	removeILayerEventsListener(ILayerEvents theListener) removeILayerEventsListener.
void	removeRelationshipClass(IRelationshipClass relationshipClass) Removes the specified memory relationship class from a standalone table or layer.
void	rename(java.lang.String name) Renames this Dataset.
void	reScale(double xScale, double yScale) ReScale operation of layer.
void	reset() Reset operation of layer.
void	rotate(IPoint ipPivotPoint, double angle) Rotate operation of layer.
int	rowCount(IQueryFilter queryFilter) The number of Rows selected by the specified query.
void	save(IStream pstm, int fClearDirty) save
ICursor	searchDisplayTable(IQueryFilter pQueryFilter, boolean recycling) Creates a cursor from the display table based upon the search criteria.
ISelectionSet	select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer) A selection that contains the object ids selected by the specified query.
ISelectionSet	selectDisplayTable(IQueryFilter pQueryFilter, int selType, int selOption, IWorkspace pSelWorkspace) Creates a selection set from the display table based upon the search criteria.
void	selectionChanged() Fires the layer update event.
void	selectRows(IQueryFilter filter, int method, boolean justOne) Selects rows based upon the specified criteria and combination method.
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	setDataSourceName(IName name) Name of the data object for the layer.
void	setDisplayResolutionFactor(int pnFactor) Display resolution factor.
void	setDrawingPropsDirty(boolean dirty) Indicates if the layer drawing properties are dirty.
void	setHasLiveData(boolean useTime) setHasLiveData
void	setLayerDescription(java.lang.String text) Description for the layer.
void	setLayerWeight(double layerWeight) Default layer position.
void	setMaskRasterDatasetByRef(IRasterDataset ppRasterDataset) Reference to the current selection dataset.
void	setMaximumScale(double maxScale) Maximum scale (representative fraction) at which the layer will display.
void	setMinimumScale(double minScale) Minimum scale (representative fraction) at which the layer will display.
void	setName(java.lang.String name) Layer name.
void	setPrimaryField(int pnField) Layer's primary field.
void	setPyramidPresent(boolean pbPyramidPresent) Indicates if pyramids are present for the layer.
void	setRelativeBase(java.lang.String basePath) Base path used when storing relative path names.
void	setRendererByRef(IRasterRenderer renderer) Layer's renderer.
void	setSelectionSetByRef(ISelectionSet selectionSet) The selected set of rows.
void	setShowResolution(boolean b) Indicates if the raster resolution should be displayed in the Table of Contents.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setSupportsInteractive(boolean supported) Indicates if the layer supports interactive effects changes.
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setTemporary(boolean temporary) Indicates if the layer is a temporary layer.
void	setTimeDataCumulative(boolean cumilative) Indicates that features will be animated cumilatively.
void	setTimeDimensionFormat(java.lang.String format) Returns the format of the dimension that represents time.
void	setTimeDimensionName(java.lang.String fieldName) Returns the name of the dimension that represents time.
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	setTransparency(short alpha) Layer transparency in percent (0-100).
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	setVisibleExtent(IEnvelope ppVisibleExtent) Visible extent of the layer in the data frame.
void	shift(double deltaX, double deltaY) Shift operation of layer.
void	twoPointsAdjust(IPointCollection fromPoints, IPointCollection toPoints) Two points adjust operation of layer.
ICursor	update(IQueryFilter queryFilter, boolean recycling) Returns a cursor that can be used to update Rows selected by the specified query.
void	updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer) Update the Rows in the database selected by the specified query.
void	warp(IPointCollection fromPoints, IPointCollection toPoints, int order) Warp operation of layer.
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

RasterLayer

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

Constructs a RasterLayer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterLayer

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

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

Deprecated. Internal use only.

Specified by:

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

addILayerEventsListener

public void addILayerEventsListener(ILayerEvents theListener)
                             throws java.io.IOException

addILayerEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

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

removeILayerEventsListener

public void removeILayerEventsListener(ILayerEvents theListener)
                                throws java.io.IOException

removeILayerEventsListener. Stop listening to events generated by this class.

Parameters:

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

Throws:

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

addIGeoReferenceEventsListener

public void addIGeoReferenceEventsListener(IGeoReferenceEvents theListener)
                                    throws java.io.IOException

addIGeoReferenceEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

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

removeIGeoReferenceEventsListener

public void removeIGeoReferenceEventsListener(IGeoReferenceEvents theListener)
                                       throws java.io.IOException

removeIGeoReferenceEventsListener. Stop listening to events generated by this class.

Parameters:

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

Throws:

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

release

public void release()

Release a RasterLayer.

Specified by:

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

getFilePath

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

Filepath of the data source.

Specified by:

getFilePath in interface IRasterLayer

Returns:

The filePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRaster

public IRaster getRaster()
                  throws java.io.IOException,
                         AutomationException

Layer's Raster object.

Specified by:

getRaster in interface IRasterLayer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFromRaster

public void createFromRaster(IRaster raster)
                      throws java.io.IOException,
                             AutomationException

Creates a layer from a Raster object.

Specified by:

createFromRaster in interface IRasterLayer

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFromDataset

public void createFromDataset(IRasterDataset rasterDataset)
                       throws java.io.IOException,
                              AutomationException

Creates a layer from a RasterDataset object.

Specified by:

createFromDataset in interface IRasterLayer

Parameters:

rasterDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (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 a layer from a file path to raster data.

Specified by:

createFromFilePath in interface IRasterLayer

Parameters:

filePath - The filePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderer

public IRasterRenderer getRenderer()
                            throws java.io.IOException,
                                   AutomationException

Layer's renderer.

Specified by:

getRenderer in interface IRasterLayer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRendererByRef

public void setRendererByRef(IRasterRenderer renderer)
                      throws java.io.IOException,
                             AutomationException

Layer's renderer.

Specified by:

setRendererByRef in interface IRasterLayer

Parameters:

renderer - A reference to a com.esri.arcgis.carto.IRasterRenderer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandCount

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

Number of bands in the layer.

Specified by:

getBandCount in interface IRasterLayer

Returns:

The bandCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnCount

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

Number of columns in the layer.

Specified by:

getColumnCount in interface IRasterLayer

Returns:

The columnCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRowCount

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

Number of rows in the layer.

Specified by:

getRowCount in interface IRasterLayer

Returns:

The rowCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPyramidPresent

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

Indicates if pyramids are present for the layer.

Specified by:

isPyramidPresent in interface IRasterLayer

Returns:

The pbPyramidPresent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPyramidPresent

public void setPyramidPresent(boolean pbPyramidPresent)
                       throws java.io.IOException,
                              AutomationException

Indicates if pyramids are present for the layer.

Specified by:

setPyramidPresent in interface IRasterLayer

Parameters:

pbPyramidPresent - The pbPyramidPresent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataFrameExtent

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

Extent of the dataframe that contains the layer.

Specified by:

getDataFrameExtent in interface IRasterLayer

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.

setVisibleExtent

public void setVisibleExtent(IEnvelope ppVisibleExtent)
                      throws java.io.IOException,
                             AutomationException

Visible extent of the layer in the data frame.

Specified by:

setVisibleExtent in interface IRasterLayer

Parameters:

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

getVisibleExtent

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

Visible extent of the layer in the data frame.

Specified by:

getVisibleExtent in interface IRasterLayer

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.

setPrimaryField

public void setPrimaryField(int pnField)
                     throws java.io.IOException,
                            AutomationException

Layer's primary field.

Specified by:

setPrimaryField in interface IRasterLayer

Parameters:

pnField - The pnField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrimaryField

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

Layer's primary field.

Specified by:

getPrimaryField in interface IRasterLayer

Returns:

The pnField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowResolution

public void setShowResolution(boolean b)
                       throws java.io.IOException,
                              AutomationException

Indicates if the raster resolution should be displayed in the Table of Contents.

Specified by:

setShowResolution in interface IRasterLayer

Parameters:

b - The b (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowResolution

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

Indicates if the raster resolution should be displayed in the Table of Contents.

Specified by:

isShowResolution in interface IRasterLayer

Returns:

The b

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayResolutionFactor

public void setDisplayResolutionFactor(int pnFactor)
                                throws java.io.IOException,
                                       AutomationException

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Specified by:

setDisplayResolutionFactor in interface IRasterLayer

Parameters:

pnFactor - The pnFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayResolutionFactor

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

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Specified by:

getDisplayResolutionFactor in interface IRasterLayer

Returns:

The pnFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the Dataset.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

getLegendGroupCount

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

Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendGroupCount in interface ILegendInfo

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

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

Specified by:

getLegendGroup in interface ILegendInfo

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.IOException,
                                 AutomationException

Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendItem in interface ILegendInfo

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

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

Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSymbolsAreGraduated in interface ILegendInfo

Returns:

The symbolsAreGraduated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolsAreGraduated in interface ILegendInfo

Parameters:

symbolsAreGraduated - The symbolsAreGraduated (in)

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.

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.

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.

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.

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.

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.

isCanGeoRef

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

Indicates if layer can be georeferenced.

Specified by:

isCanGeoRef in interface IGeoReference

Returns:

The canGeoRef

Throws:

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

AutomationException - If the ArcObject component throws an exception.

shift

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

Shift operation of layer.

Specified by:

shift in interface IGeoReference

Parameters:

deltaX - The deltaX (in)

deltaY - The deltaY (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reScale

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

ReScale operation of layer.

Specified by:

reScale in interface IGeoReference

Parameters:

xScale - The xScale (in)

yScale - The yScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

flip

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

Flip operation of layer.

Specified by:

flip in interface IGeoReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

mirror

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

Mirror operation of layer.

Specified by:

mirror in interface IGeoReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rotate

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

Rotate operation of layer.

Specified by:

rotate in interface IGeoReference

Parameters:

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

angle - The angle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

pointsTransform

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

Transform operation of Raster.

Specified by:

pointsTransform in interface IGeoReference

Parameters:

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

isForward - The isForward (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

twoPointsAdjust

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

Two points adjust operation of layer.

Specified by:

twoPointsAdjust in interface IGeoReference

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

warp

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

Warp operation of layer.

Specified by:

warp in interface IGeoReference

Parameters:

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

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

order - The order (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Reset operation of layer.

Specified by:

reset in interface IGeoReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

register

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

Save transformation parameters and tie-points.

Specified by:

register in interface IGeoReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rectify

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

Save transformed result to a new dataset.

Specified by:

rectify in interface IGeoReference

Parameters:

fullpath - The fullpath (in)

format - The format (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayTable

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

The display table.

Specified by:

getDisplayTable in interface IDisplayTable

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.

searchDisplayTable

public ICursor searchDisplayTable(IQueryFilter pQueryFilter,
                                  boolean recycling)
                           throws java.io.IOException,
                                  AutomationException

Creates a cursor from the display table based upon the search criteria.

Specified by:

searchDisplayTable in interface IDisplayTable

Parameters:

pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectDisplayTable

public ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter,
                                        int selType,
                                        int selOption,
                                        IWorkspace pSelWorkspace)
                                 throws java.io.IOException,
                                        AutomationException

Creates a selection set from the display table based upon the search criteria.

Specified by:

selectDisplayTable in interface IDisplayTable

Parameters:

pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)

selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)

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

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.

getDisplaySelectionSet

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

The selected set of rows from the display table.

Specified by:

getDisplaySelectionSet in interface IDisplayTable

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.

getSelectionSet

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

The selected set of rows.

Specified by:

getSelectionSet in interface ITableSelection

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.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet selectionSet)
                          throws java.io.IOException,
                                 AutomationException

The selected set of rows.

Specified by:

setSelectionSetByRef in interface ITableSelection

Parameters:

selectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addRow

public void addRow(IRow row)
            throws java.io.IOException,
                   AutomationException

Adds a row to the selection set (honoring the current combination method).

Specified by:

addRow in interface ITableSelection

Parameters:

row - A reference to a com.esri.arcgis.geodatabase.IRow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectRows

public void selectRows(IQueryFilter filter,
                       int method,
                       boolean justOne)
                throws java.io.IOException,
                       AutomationException

Selects rows based upon the specified criteria and combination method.

Specified by:

selectRows in interface ITableSelection

Parameters:

filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)

justOne - The justOne (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clear

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

Clears the selection.

Specified by:

clear in interface ITableSelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectionChanged

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

Fires the layer update event. Required when SelectionSet changes.

Specified by:

selectionChanged in interface ITableSelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findField

public int findField(java.lang.String name)
              throws java.io.IOException,
                     AutomationException

The index of the field with the specified name.

Specified by:

findField in interface ILayerFields

Specified by:

findField in interface IClass

Specified by:

findField in interface ITableFields

Parameters:

name - The name (in)

Returns:

The fieldIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException

The fields collection for this object class.

Specified by:

getFields in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIndexes

public IIndexes getIndexes()
                    throws java.io.IOException,
                           AutomationException

The indexes collection for this object class.

Specified by:

getIndexes in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws java.io.IOException,
                     AutomationException

Adds a field to this object class.

Specified by:

addField in interface IClass

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws java.io.IOException,
                        AutomationException

Deletes a field from this object class.

Specified by:

deleteField in interface IClass

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws java.io.IOException,
                     AutomationException

Adds an index to this object class.

Specified by:

addIndex in interface IClass

Parameters:

index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws java.io.IOException,
                        AutomationException

Deletes an index from this object class.

Specified by:

deleteIndex in interface IClass

Parameters:

index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasOID

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

Indicates if the class has an object identity (OID) field.

Specified by:

isHasOID in interface IClass

Returns:

The hasOID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

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

The name of the field corresponding to the OID.

Specified by:

getOIDFieldName in interface IClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCLSID

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

The GUID for the COM Class (CoClass) corresponding to instances of this object class.

Specified by:

getCLSID in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

public IUID getEXTCLSID()
                 throws java.io.IOException,
                        AutomationException

The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.

Specified by:

getEXTCLSID in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtension

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

The extension for this object class.

Specified by:

getExtension in interface IClass

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

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

The extension properties for this object class.

Specified by:

getExtensionProperties in interface IClass

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.

createRow

public IRow createRow()
               throws java.io.IOException,
                      AutomationException

Creates a row in the database with a system assigned object ID and null property values.

Specified by:

createRow in interface ITable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws java.io.IOException,
                   AutomationException

The row from the database with the specified object ID.

Specified by:

getRow in interface ITable

Parameters:

oID - The oID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRows

public ICursor getRows(java.lang.Object oids,
                       boolean recycling)
                throws java.io.IOException,
                       AutomationException

The cursor of rows based on a set of object ids.

Specified by:

getRows in interface ITable

Parameters:

oids - A Variant (in)

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws java.io.IOException,
                                  AutomationException

Creates a row buffer that can be used with an insert cursor.

Specified by:

createRowBuffer in interface ITable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateSearchedRows

public void updateSearchedRows(IQueryFilter queryFilter,
                               IRowBuffer buffer)
                        throws java.io.IOException,
                               AutomationException

Update the Rows in the database selected by the specified query.

Specified by:

updateSearchedRows in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws java.io.IOException,
                               AutomationException

Delete the Rows in the database selected by the specified query.

Specified by:

deleteSearchedRows in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws java.io.IOException,
                    AutomationException

The number of Rows selected by the specified query.

Specified by:

rowCount in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

The numRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

ITable_search

public ICursor ITable_search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException

An object cursor that can be used to fetch row objects selected by the specified query.

Specified by:

ITable_search in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws java.io.IOException,
                      AutomationException

Returns a cursor that can be used to update Rows selected by the specified query.

Specified by:

update in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws java.io.IOException,
                      AutomationException

Returns a cursor that can be used to insert new Rows.

Specified by:

insert in interface ITable

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

select

public ISelectionSet select(IQueryFilter queryFilter,
                            int selType,
                            int selOption,
                            IWorkspace selectionContainer)
                     throws java.io.IOException,
                            AutomationException

A selection that contains the object ids selected by the specified query.

Specified by:

select in interface ITable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)

selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)

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

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.

getObjectClassID

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

The unique ID for the object class.

Specified by:

getObjectClassID in interface IObjectClass

Returns:

The objectClassID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses(int role)
                                              throws java.io.IOException,
                                                     AutomationException

The relationship classes in which this object class participates in for the specified role.

Specified by:

getRelationshipClasses in interface IObjectClass

Parameters:

role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAliasName

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

The alias name of the object class.

Specified by:

getAliasName in interface IObjectClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldCount

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

The number of fields.

Specified by:

getFieldCount in interface ILayerFields

Specified by:

getFieldCount in interface ITableFields

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getField

public IField getField(int index)
                throws java.io.IOException,
                       AutomationException

The field at the specified index.

Specified by:

getField in interface ILayerFields

Specified by:

getField in interface ITableFields

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldInfo

public IFieldInfo getFieldInfo(int index)
                        throws java.io.IOException,
                               AutomationException

Extended field information for the field at the specified index.

Specified by:

getFieldInfo in interface ILayerFields

Specified by:

getFieldInfo in interface ITableFields

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJoinType

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

Join type for the most recent join performed.

Specified by:

getJoinType in interface IDisplayRelationshipClass

Returns:

A com.esri.arcgis.geodatabase.esriJoinType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipClass

public IRelationshipClass getRelationshipClass()
                                        throws java.io.IOException,
                                               AutomationException

Relationship class that defines how the tables are joined.

Specified by:

getRelationshipClass in interface IDisplayRelationshipClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

displayRelationshipClass

public void displayRelationshipClass(IRelationshipClass relClass,
                                     int joinType)
                              throws java.io.IOException,
                                     AutomationException

Sets a join based on the specified relationship class and join type.

Specified by:

displayRelationshipClass in interface IDisplayRelationshipClass

Parameters:

relClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

joinType - A com.esri.arcgis.geodatabase.esriJoinType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses()
                                              throws java.io.IOException,
                                                     AutomationException

The memory relationship classes.

Specified by:

getRelationshipClasses in interface IRelationshipClassCollection

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findRelationshipClasses

public IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass,
                                                      int role)
                                               throws java.io.IOException,
                                                      AutomationException

Finds all relationship classes in the collection that reference the given object class in the specified role.

Specified by:

findRelationshipClasses in interface IRelationshipClassCollection

Parameters:

objectClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)

role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addRelationshipClass

public void addRelationshipClass(IRelationshipClass relationshipClass)
                          throws java.io.IOException,
                                 AutomationException

Adds the specified memory relationship class to a standalone table or layer.

Specified by:

addRelationshipClass in interface IRelationshipClassCollectionEdit

Parameters:

relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeRelationshipClass

public void removeRelationshipClass(IRelationshipClass relationshipClass)
                             throws java.io.IOException,
                                    AutomationException

Removes the specified memory relationship class from a standalone table or layer.

Specified by:

removeRelationshipClass in interface IRelationshipClassCollectionEdit

Parameters:

relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllRelationshipClasses

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

Removes all memory relationship classes from a standalone table or layer.

Specified by:

removeAllRelationshipClasses in interface IRelationshipClassCollectionEdit

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.

isDrawingPropsDirty

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

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDrawingPropsDirty in interface ILayerDrawingProperties

Returns:

The dirty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

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

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDrawingPropsDirty in interface ILayerDrawingProperties

Parameters:

dirty - The dirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

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

Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMinimumScale in interface ILayerGeneralProperties

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

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

Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMaximumScale in interface ILayerGeneralProperties

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

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

Description for the layer.

Product Availability

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

Specified by:

ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerDescription

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

Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLayerDescription in interface ILayerGeneralProperties

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.

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.

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.

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.

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.

init

public void init(boolean bInit,
                 java.lang.String fileFullName,
                 int fileFormat)
          throws java.io.IOException,
                 AutomationException

Create or remove the selection dataset.

Specified by:

init in interface IRasterSpatialSelection

Parameters:

bInit - The bInit (in)

fileFullName - The fileFullName (in, optional, pass 0 if not required)

fileFormat - A com.esri.arcgis.carto.esriRasterSelectionMaskFileFormat constant (in, optional, pass 1 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawSpatialSelection

public void drawSpatialSelection(IDisplay pDisplay,
                                 ITrackCancel pTrackCancel)
                          throws java.io.IOException,
                                 AutomationException

Draws the current spatial selection.

Specified by:

drawSpatialSelection in interface IRasterSpatialSelection

Parameters:

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

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

getMaskRasterDataset

public IRasterDataset getMaskRasterDataset()
                                    throws java.io.IOException,
                                           AutomationException

Reference to the current selection dataset.

Specified by:

getMaskRasterDataset in interface IRasterSpatialSelection

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaskRasterDatasetByRef

public void setMaskRasterDatasetByRef(IRasterDataset ppRasterDataset)
                               throws java.io.IOException,
                                      AutomationException

Reference to the current selection dataset.

Specified by:

setMaskRasterDatasetByRef in interface IRasterSpatialSelection

Parameters:

ppRasterDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

maskWriteBitmap

public void maskWriteBitmap(ITrackCancel trackCancel,
                            tagRECT pRect,
                            int op,
                            java.lang.Object vBytes,
                            boolean byBits)
                     throws java.io.IOException,
                            AutomationException

Perform the mask operation with bitmask.

Specified by:

maskWriteBitmap in interface IRasterSpatialSelection

Parameters:

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

pRect - A Structure: com.esri.arcgis.system.tagRECT (in)

op - A com.esri.arcgis.carto.esriRasterSelectionMaskOp constant (in)

vBytes - A Variant (in)

byBits - The byBits (in, optional, pass false if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

maskReadBitmap

public void maskReadBitmap(ITrackCancel trackCancel,
                           tagRECT pRect,
                           java.lang.Object vBytes,
                           boolean byBits)
                    throws java.io.IOException,
                           AutomationException

Read pixels from selection.

Specified by:

maskReadBitmap in interface IRasterSpatialSelection

Parameters:

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

pRect - A Structure: com.esri.arcgis.system.tagRECT (in)

vBytes - A Variant (in)

byBits - The byBits (in, optional, pass false if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

maskDrawPolyRect

public void maskDrawPolyRect(ITrackCancel trackCancel,
                             java.lang.Object vRects,
                             int op)
                      throws java.io.IOException,
                             AutomationException

Perform the mask operation with the given array of rectangles.

Specified by:

maskDrawPolyRect in interface IRasterSpatialSelection

Parameters:

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

vRects - A Variant (in)

op - A com.esri.arcgis.carto.esriRasterSelectionMaskOp constant (in)

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.

setTemporary

public void setTemporary(boolean temporary)
                  throws java.io.IOException,
                         AutomationException

Indicates if the layer is a temporary layer.

Specified by:

setTemporary in interface ITemporaryLayer

Parameters:

temporary - The temporary (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTemporary

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

Indicates if the layer is a temporary layer.

Specified by:

isTemporary in interface ITemporaryLayer

Returns:

The temporary

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.

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 ITimeDimensionDefinition

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.

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.

isMultiDimensional

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

Indicates whether the data is multi-dimensional.

Specified by:

isMultiDimensional in interface ITimeDimensionDefinition

Returns:

The isMultidimensional

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeDimensionName

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

Returns the name of the dimension that represents time.

Specified by:

getTimeDimensionName in interface ITimeDimensionDefinition

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeDimensionName

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

Returns the name of the dimension that represents time.

Specified by:

setTimeDimensionName in interface ITimeDimensionDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeDimensionFormat

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

Returns the format of the dimension that represents time.

Specified by:

getTimeDimensionFormat in interface ITimeDimensionDefinition

Returns:

The format

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeDimensionFormat

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

Returns the format of the dimension that represents time.

Specified by:

setTimeDimensionFormat in interface ITimeDimensionDefinition

Parameters:

format - The format (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 ITimeDimensionDefinition

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.

beforeDraw

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

Executes before the layer draws to the display for the given draw phase.

Specified by:

beforeDraw in interface ILayerDrawSetup

Parameters:

viewPhase - A com.esri.arcgis.carto.esriViewDrawPhase 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.

afterDraw

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

Executes after the layer drawn to the display for the given draw phase.

Specified by:

afterDraw in interface ILayerDrawSetup

Parameters:

viewPhase - A com.esri.arcgis.carto.esriViewDrawPhase 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.

onAddField

public void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
                throws java.io.IOException,
                       AutomationException

This event is fired when a new field is added to the object class.

Specified by:

onAddField in interface IObjectClassSchemaEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onDeleteField

public void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

This event is fired when a field is deleted from the object class.

Specified by:

onDeleteField in interface IObjectClassSchemaEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onBehaviorChanged

public void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

This event is fired when the behavior class for the object class changes.

Specified by:

onBehaviorChanged in interface IObjectClassSchemaEvents

Parameters:

theEvent - The event

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