com.esri.arcgis.carto
Class FDOGraphicsLayer

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

All Implemented Interfaces:

IAnnotationLayer, IAttributeTable, IBarrierProperties, IBarrierProperties2, ICompositeLayer, ICompositeLayer2, IDataLayer, IDataLayer2, IDisplayRelationshipClass, IDisplayString, IDisplayTable, IDrawAnnotationGeometry, IFDOAttributeConversion, IFDOGraphicsContainer, IFDOGraphicsLayer, IFDOGraphicsLayer2, IFDOGraphicsLayerRead, IFeatureLayer, IFeatureLayer2, IFeatureLayerDefinition, IFeatureLayerDefinition2, IFeatureSelection, IFind, IGraphicsContainer, IGraphicsContainerSelect, IGraphicsLayer, IHotlinkContainer, IHotlinkExpression, IHotlinkMacro, IHTMLPopupIdentify, IHTMLPopupIdentify2, IHTMLPopupInfo, IHTMLPopupInfo2, IHyperlinkContainer, IIdentify, IIdentify2, IIdentifyDisplay, IInteractiveSearch, ILayer, ILayer2, ILayerDrawingPhase, ILayerDrawingProperties, ILayerEffects, ILayerEvents, ILayerExtensions, ILayerFields, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerSymbologyExtents, IOrderedLayerFields, IOverflowGraphicsContainer, IPublishLayer, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ISecureLayer, ISymbolSubstitution, ITableDefinition, ITableSelection, ITemporaryLayer, ITimeData, ITimeData2, ITimeDataDisplay, ITimeDimensionDefinition, ITimeDisplayTable, ITimeDisplayTable2, ITimeTableDefinition, IConnectionPointContainer, IDisplayAdmin, IDisplayFilterManager, IMapLevel, ITransformEvents, IClass, IDataset, IGeoDataset, IObjectClassEvents, IObjectClassSchemaEvents, ITable, ITableCapabilities, ITableFields, IWorkspaceEvents, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IPropertySupport, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class FDOGraphicsLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IFDOGraphicsLayer, IAnnotationLayer, IFDOGraphicsLayerRead, IGraphicsLayer, IGraphicsContainer, IFDOGraphicsContainer, IOverflowGraphicsContainer, IGeoDataset, IBarrierProperties, IBarrierProperties2, IPersistStream, ILayerEvents, ILayerInfo, IFeatureLayer, IFeatureSelection, IFDOAttributeConversion, IDataLayer, IAttributeTable, IConnectionPointContainer, IDataLayer2, IDataset, IDisplayAdmin, IDisplayFilterManager, IDisplayRelationshipClass, IFeatureLayer2, IFeatureLayerDefinition, IFeatureLayerDefinition2, IFind, IGraphicsContainerSelect, IHotlinkContainer, IHotlinkMacro, IHotlinkExpression, IHyperlinkContainer, IIdentify, IIdentify2, ILayer, ILayer2, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerFields, ILayerPosition, ILayerSymbologyExtents, IMapLevel, IObjectClassEvents, IObjectClassSchemaEvents, IPropertySupport, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ITableDefinition, ITableFields, ITableSelection, ITableCapabilities, IPublishLayer, ILayerDrawingPhase, ICompositeLayer2, ISymbolSubstitution, ILayerGeneralProperties, IInteractiveSearch, IDrawAnnotationGeometry, ICompositeLayer, IDisplayTable, IFDOGraphicsLayer2, ISecureLayer, ITemporaryLayer, ITransformEvents, IClass, ITable, IHTMLPopupInfo, IHTMLPopupInfo2, IHTMLPopupIdentify, IHTMLPopupIdentify2, IDisplayString, IIdentifyDisplay, IOrderedLayerFields, ITimeData, ITimeData2, ITimeDataDisplay, ITimeDisplayTable2, ITimeDimensionDefinition, ITimeDisplayTable, ITimeTableDefinition, IWorkspaceEvents, java.io.Externalizable

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

Description 'A collection of properties for an annotation layer (feature data object graphics layer).' 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.IFDOGraphicsLayer

IID, IID48e56b3f_ec3a_11d2_9f5c_00c04f6bc6a5, xxDummy

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

IID, IID4aedc069_b599_424b_a374_49602abad308, xxDummy

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

IID, IID5ceae408_4c0a_437f_9db3_054d83919850, xxDummy

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

IID, IID34b2ef81_f4ac_11d1_a245_080009b6f22b, xxDummy

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

IID, IIDd09411d1_4bb4_11d1_b6cc_080009b996cc, xxDummy

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

IID, IID2f9b6441_ed80_498f_b13f_ea057e7f9832, xxDummy

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

IID, IID9c0520c1_a0d8_11d2_a2fe_080009b6f22b, xxDummy

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

IID, IID01c12b91_a3fb_11d2_a2fe_080009b6f22b, xxDummy

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

IID, IIDe2d07333_5605_4ea6_87bd_7830927452e0, 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.ILayerEvents

IID, IIDbda426b2_a692_11d2_a300_080009b6f22b, xxDummy

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

IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy

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

IID, IID40a9e885_5533_11d0_98be_00805f7ced21, xxDummy

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

IID, IID9336a280_c9a3_11d1_847e_0000f875b9c6, xxDummy

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

IID, IID5a5fe792_9637_49a7_b97a_209931b15c3c, 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.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.carto.IDataLayer2

IID, IIDe9d11f65_6936_4408_b69f_d91552eb9c4a, xxDummy

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

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

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

IID, IIDf0815360_19e1_11d3_80c8_0080c79f0371, xxDummy

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

IID12e361f0_1907_11d3_80c7_0080c79f0371

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

IID, IID55a4e17e_8682_42ba_8866_ab04db883934, xxDummy

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

IID, IID95e82d50_e720_48b5_808d_e45fa9cf1218, xxDummy

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

IID, IID3e1608cf_ff34_11d1_adf1_080009ec732a, xxDummy

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

IID, IIDed242088_b822_4e8a_8260_cdcd1da3044b, xxDummy

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

IID, IID9fe681e6_ba4e_4729_8301_8f15a1544140, xxDummy

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

IID, IIDd09411d2_4bb4_11d1_b6cc_080009b996cc, xxDummy

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

IID, IIDd1a02a0c_2113_11d3_9f98_00c04f6bc78e, xxDummy

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

IID, IIDd7ee3484_004d_11d4_9fe7_00c04f6bc78e, xxDummy

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

IID, IID6fb88442_c7d2_4355_92c0_e96a577636d2, xxDummy

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

IID, IIDd1a02a0b_2113_11d3_9f98_00c04f6bc78e, xxDummy

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

IID, IID0483dc2f_8726_4640_98cd_5888ff1a4fa4, xxDummy

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

IID, IID599dee2e_2182_4e54_8a86_725145c9d989, xxDummy

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

IID, IID09998199_1fb8_11d3_ab4e_000000000000, xxDummy

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

IID, IIDbb6a78ca_9c28_4f75_899f_dff65174082c, xxDummy

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

IID, IIDa2baae2b_969b_11d2_ae77_080009ec732a, xxDummy

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

IID, IIDc0dc8820_e10f_4285_aab1_6c6b685dbb84, xxDummy

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

IID, IID02cbda2f_d2e8_4b28_af9c_71cb096213e1, xxDummy

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

IID, IIDcef72580_c1d9_11d2_9888_0080c7e04196, xxDummy

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

IID, IIDf1e8911b_6bc5_11d3_a021_00c04f6bdf0e, xxDummy

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

IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, 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.ITableDefinition

IID, IID7e078ff6_4b77_414e_90a9_8bb352dd1608, 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.ITableSelection

IID, IID2c232271_fbaa_11d3_b9d3_00c0f0567a4a, xxDummy

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

IID, IID8b0338b9_3b3d_11d4_9fbb_00c04f6bdf0c, 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.ILayerDrawingPhase

IID, IIDeef01b2d_8fe1_4759_8b93_51ee22ded70a, xxDummy

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

IID, IID88130d17_5762_453a_96cf_8e7503fa1aa0, xxDummy

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

IID, IIDb8ddfa29_43f2_40df_8bff_c7a2879c1f90, xxDummy

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

IID, IID928b74f0_a666_4efe_a756_ea1e3dad6075, xxDummy

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

IID, IID4944d2af_6a5e_42d0_a33c_4129285720fc, xxDummy

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

IID, IIDba119bc4_939a_11d2_a2f4_080009b6f22b, xxDummy

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

IID, IIDcce71a6d_6135_46cd_bbed_616a74831b30, xxDummy

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

IID, IID8321c2c6_72f9_48a6_bfcb_67efd7597564, xxDummy

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

IID, IIDd047a6a9_d445_4921_a1e9_72d8b8a2813a, xxDummy

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

IID, IIDfceff094_8e6a_4972_9bb4_429c71b07289, xxDummy

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

IID, IIDe6bdb001_4d35_11d0_98be_00805f7ced21, 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.IClass

IID1afcdb32_ac09_11d2_8a1e_006097aff44e

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

IID, IID742678bc_aff5_41da_a523_36a8bd4e2c8b, xxDummy

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

IID, IID8a038cdb_0430_40d9_b8ce_8b055f11d511, xxDummy

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

IID, IID095cdd1a_fe17_4719_9072_15f303f82e69, xxDummy

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

IID, IID8cc24376_c6e0_4ae0_8561_17fa049aee03, xxDummy

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

IID, IID8d090acb_8c9e_4343_a3cc_f9da9be3c401, xxDummy

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

IID, IID25188498_8a07_49f1_9fae_3aefb14c1778, xxDummy

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

IID, IIDa95f6059_7909_4d31_a66b_2220adc6615f, 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.ITimeDisplayTable2

IID, IID64b8b4af_4f12_4f66_b2dc_79476910ee38, xxDummy

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

IID7a55bbf1_52f0_413b_ac7c_761bd139ae3f

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

IID, IIDf1f9cc71_5f24_4176_9ba4_9d8af7195a3e, xxDummy

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

IID, IID9f45df65_de39_4a88_b174_b2ad3d3020a8, xxDummy

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

IID, IIDda10c1c4_09a3_11d4_9faa_00c04f6bdf0c, xxDummy

Constructor Summary

FDOGraphicsLayer()
Constructs a FDOGraphicsLayer using ArcGIS Engine.

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

Method Summary

void	activate(IScreenDisplay containerScreen) Prepare to display graphic on screen.
void	add(IFeature feature) Adds a feature to the selection set.
void	addElement(IElement element, int zorder) Add a new graphic element to the layer.
void	addElement(IElement element, int zorder, IAnnotationFeature[] newAnnotationFeature) Add a new graphic element to the layer.
void	addElements(IElementCollection elements, int zorder) Add new graphic elements to the layer.
void	addExtension(java.lang.Object ext) Adds a new extension.
void	addField(IField field) Adds a field to this object class.
void	addHyperlink(IHyperlink link) Adds a hyperlink.
void	addIndex(IIndex index) Adds an index to this object class.
void	addISelectionEventsListener(ISelectionEvents theListener) addISelectionEventsListener.
void	addOverflowElement(IElement pElement) Add an element to the collection.
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).
boolean	applies(java.lang.Object pUnk) Indicates if the receiver can apply the given object at any given time.
java.lang.Object	apply(java.lang.Object newObject) Applies the given property to the receiver and returns the old object.
void	beginAddElements() Begins a batch process for adding elements to a graphics layer.
void	boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent) Notifies clients when the bounds is updated.
void	bringForward(IEnumElement elements) Move the specified elements one step closer to the top of the stack of elements.
void	bringToFront(IEnumElement elements) Make the specified elements draw in front of all other elements.
boolean	canApply(java.lang.Object pUnk) Indicates if the receiver can apply the given object at that particular moment.
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.
void	clearPassword(boolean bForceReconnect) Removes the passwords from the layer used to access data, and forces a reconnection to the data.
boolean	connect(IName pOptRepairName) Connects the layer to its data source.
IDataset	copy(java.lang.String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
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.
IFeatureLayer	createSelectionLayer(java.lang.String layerName, boolean useCurrentSelection, java.lang.String joinTableNames, java.lang.String expression) Creates a new feature layer from the existing layer based on the current selection and the specified query expression.
void	deactivate() ActiveView that graphics are displayed on is no longer visible.
void	delete() Deletes this dataset.
void	deleteAllElements() Delete all the elements.
void	deleteAllOverflowElements() Delete all the element in the collection.
void	deleteElement(IElement element) Delete the given element.
void	deleteField(IField field) Deletes a field from this object class.
void	deleteIndex(IIndex index) Deletes an index from this object class.
void	deleteOverflowElement(IElement pElement) Delete an element in the collection.
void	deleteSearchedRows(IQueryFilter queryFilter) Delete the Rows in the database selected by the specified query.
void	deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent) Notifies clients when the device frame is updated.
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	doAddElements(IElementCollection pElements, int zorder) Adds a batch of elements to a graphics layer.
void	doAddFeature(IFeature pFeature, IElement pElement, int zorder) Adds a feature and its corresponding element to a graphics layer.
void	doAddFeature(IFeature pFeature, IElement pElement, int zorder, int annotationClassID, int status) Adds a feature and its corresponding element to a graphics layer.
void	doAddNullElement(int featureId) Adds a feature and its corresponding element to a graphics layer.
void	doAddNullElement(int featureId, int annotationClassID, int status) Adds a feature and its corresponding element to a graphics layer.
void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
boolean	elementSelected(IElement element) Indicates if the element is selected.
void	endAddElements() Ends the batch process for adding elements to a graphics layer.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	executeExpression(IObject pObject) Finds the hyperlink for the given feature based on the current expression properties.
void	expandRegionForSymbols(IDisplay display, IGeometry region) Expands the given geometry by an amount that will include the layer's symbology for the given display.
IArray	find(java.lang.String search, boolean contains, java.lang.Object fields, ITrackCancel trackCancel) Finds the specified search string in the given attribute fields.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
java.lang.String	findDisplayString(IObject pObject) Finds the display string for the given feature based on the current expression properties.
int	findField(java.lang.String fieldName) Returns the index of the field with the specified name.
IFrameElement	findFrame(java.lang.Object frameObject) Find the frame that contains the specified object.
IEnumRelationshipClass	findRelationshipClasses(IObjectClass objectClass, int role) Finds all relationship classes in the collection that reference the given object class in the specified role.
IEnumElement	generateGraphics(IEnvelope box, IDisplay display, ITrackCancel pTrackCancel, boolean useGroupSymbolElement) Generates graphic elements from the annotation features.
void	getAddErrorInfo(java.lang.String[] errors, java.lang.String[] filePath) The errors and the file and path of the GL*.log file which stores error information when Add is called in batch (using BeginAddElements and EndAddElements).
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
ILayer	getAssociatedLayer() Layer that is associated with this graphics layer.
ITable	getAttributeTable() The attribute table.
void	getBarriers(IDisplay display, IGeometryCollection pBarriers, IEnvelope extent) List of barriers within the specified extent, or all barriers if no extent given.
short	getBrightness() Layer brightness in percent (-100 - 100).
java.lang.String	getBrowseName() The browse name of the dataset.
double	getBufferDistance() Buffer distance used for the selection.
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	getCombinationMethod() Combination method for the selection.
short	getContrast() Layer contrast in percent (-100 - 100).
int	getCount() Number of layers in the collection.
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
ITimeExtent	getCustomTimeExtent() Custom time extent during which a layer is visible.
java.lang.String	getDataDetails(java.lang.String bsPadding) Details of the layer's data.
IName	getDataSourceName() Name of the data object for the layer.
java.lang.String	getDataSourceType() Data source type.
java.lang.String	getDefinitionExpression() Definition query expression for the existing layer.
ISelectionSet	getDefinitionSelectionSet() The selection set that defines the subset of features in a selection layer.
java.lang.String	getDisplayField() Primary display field.
IDisplayFilter	getDisplayFilter() The display filter.
ISelectionSet	getDisplaySelectionSet() The selected set of rows from the display table.
ITable	getDisplayTable() The display table.
IElement	getDominantElement() Dominant element.
ILineSymbol	getDrawGeometryLineSymbol() The line symbol for drawing the geometry.
IMarkerSymbol	getDrawGeometryMarkerSymbol() The marker symbol for drawing the geometry.
int	getDrawPhase() Draw phase in which layer is drawn.
java.lang.Object	getElementOrder(IEnumElement elements) Private order object.
int	getElementSelectionCount() The number of selected elements.
java.lang.String	getEndTimeFieldName() Name of the field that has end time for a row.
IDisplayExpressionProperties	getExpressionProperties() Properties that describe the display expression.
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.
IFeatureClass	getFeatureClass() The layer's feature class.
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.
IFieldInfoSet	getFieldInfos() The fields in order.
IFields	getFields() The fields collection for this object class.
java.lang.String	getFindDisplayField() The display field.
java.lang.Object	getFindFields() The attribute fields.
IName	getFullName() The associated name object.
ITimeExtent	getFullTimeExtent() Returns the time extent for all the data in the layer.
java.lang.String	getHotlinkField() Field used for hotlinks.
int	getHotlinkType() Hotlink type.
java.lang.String	getHTMLOutput(IFeature pFeature) The content is the XML text for the input feature.
int	getHTMLPresentationStyle() Indicates the content formating style for the HTML Popup tool.
java.lang.String	getHTMLRedirectField() Indicates the fieldname of the layer that contains the HTML redirect URL values.
java.lang.String	getHTMLRedirectFieldPrefix() Indicates the text to precede the HTMLRedirectField value for the redirect URL.
java.lang.String	getHTMLRedirectFieldSuffix() Indicates the text to follow the HTMLRedirectField value for the redirect URL.
java.lang.String	getHTMLXSLStylesheet() Indicates the content of the XSL stylesheet to parse the feature attributes through.
IHyperlink	getHyperlink(int index) The hyperlink at the specified index.
int	getHyperlinkCount() Number of hyperlinks.
IIndexes	getIndexes() The indexes collection for this object class.
IColor	getInlineColor() The color used for substituting symbols that do not reference the symbol collection.
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.
ILayer	getLayer(int index) Layer in the collection at the specified index.
double	getLayerWeight() Default layer position.
java.lang.String	getMacroName() Name of macro used for the hotlink.
int	getMapLevel() Current map level for drawing multi-level symbols.
IColor	getMassColor() The color used for substituting only the color.
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.
IElement	getNextGraphic() Generates the next graphic element in the graphics generation loop.
java.lang.String	getOIDFieldName() The name of the field corresponding to the OID.
IElementCollection	getOverflowElements() Element collection.
IPropertySet	getPropertySet() The set of properties for the dataset.
java.lang.String	getPublishingDescription() The layer description reported to the publisher.
IRelationshipClass	getRelationshipClass() Relationship class that defines how the tables are joined.
IEnumRelationshipClass	getRelationshipClasses() The memory relationship classes.
java.lang.String	getRelativeBase() Base path used when storing relative path names.
IRow	getRow(int oID) The row from the database with the specified object ID.
ICursor	getRows(java.lang.Object oids, boolean recycling) The cursor of rows based on a set of object ids.
int	getSearchOrder() Flag that specifies the search order used when applying a mixed attribute-spatial query.
IEnumElement	getSelectedElements() The selected elements.
IEnvelope	getSelectionBounds(IDisplay display) The bounds of the selection.
IColor	getSelectionColor() Selection color.
ISelectionSet	getSelectionSet() The selected set of features.
ISymbol	getSelectionSymbol() Selection symbol.
int	getShapeType() The layer's shape type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getSmallImage() Small image that represents the layer.
int	getSmallSelectedImage() Small image that represents the layer when it is selected.
ISpatialReference	getSpatialReference() The spatial reference of the GeoDataset.
java.lang.String	getStartTimeFieldName() Name of the field that has start time for a row.
IEnumDataset	getSubsets() Datasets contained within this dataset.
ISymbolCollection	getSubstituteSymbolCollection() The substitute symbol collection when substituting the entire collection.
int	getSubstituteType() The type of symbol substitution.
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	getTimeValueFormat() Time value format if the field name is of the string format.
java.lang.String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
java.lang.String	getTrackIDFieldName() Field that contains the rows that uniquely identifies the object whose time is being tracked.
short	getTransparency() Layer transparency in percent (0-100).
int	getType() The type of the Dataset.
IColor	getUnplacedAnnotationColor() Indicates the color with which unplaced annotation is drawn.
int	getWeight() Weight of the barriers in this layer.
IWorkspace	getWorkspace() The workspace containing this dataset.
int	hashCode() the hashcode for this object
void	hTMLIdentify(IDisplay pDisplay, IGeometry pGeometry, IPropertySet pOptions, IStringArray[] ppItemNames, IStringArray[] ppItemHTML) The content is the XML text at the specified point.
java.lang.String	hTMLIdentify(IPoint pPoint, double tolerance) The content is the XML text at the specified point.
java.lang.String	hTMLOutput(IFeature pFeature, IPropertySet pOptions) The content is the XML text for the input feature, pOptions is an optional parameter.
java.lang.String	hTMLTipText(IPoint pPoint, double tolerance) The tooltip at the specified point.
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
IArray	identify(IGeometry pGeom, ITrackCancel pTrackCancel) Identifies objects at the specified location.
IArray	identifyEx(IDisplay pDisplay, IGeometry pGeom, ITrackCancel pTrackCancel) Identifies objects at the specified location for the given display.
IHotLinkExpressionProperties	IHotlinkExpression_getExpressionProperties() Properties that describe the hyperlink expression.
java.lang.String	ILayerGeneralProperties_getLayerDescription() Description for the layer.
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	isCanSelect() Indicates if the table supports selection.
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	isDrawGeometry() Indicates if the annotation geometry will draw.
boolean	isDrawingPropsDirty() Indicates if the layer drawing properties are dirty.
boolean	isDrawUnplacedAnnotation() Indicates if unplaced annotation is going to draw.
boolean	isExpanded() Indicates if the layer is expanded in the TOC.
boolean	isHasLiveData() isHasLiveData
boolean	isHasOID() Indicates if the class has an object identity (OID) field.
boolean	isHTMLDownloadAttachmentData() Indicates that all data for attachments will be retrieved.
boolean	isHTMLHideFieldNameColumn() Indicates if Field name column will be output to the HTML Popup tool.
boolean	isHTMLPopupEnabled() Indicates if this layer currently responds to the HTML Popup tool.
boolean	isHTMLUseCodedDomainValues() Indicates whether to use coded values (rather than literal stored values) for feature values.
boolean	isMultiDimensional() Indicates whether the data is multi-dimensional.
boolean	isScaleRangeReadOnly() Indicates if the minimum and maximum scale range values are read-only.
boolean	isScaleSymbols() Indicates if symbols are scaled for the layer.
boolean	isSelectable() Indicates if layer is selectable.
boolean	isSetSelectionSymbol() Indicates if the selected set of features is drawn using the SelectionSymbol.
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	isTemporary() Indicates if the layer is a temporary layer.
boolean	isTimeDataCumulative() Indicates that features will be animated cumilatively.
boolean	isUseAssociatedLayerVisibility() Indicates if the layer that is associated with this graphics layer controls the visibility.
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
IEnumElement	locateElements(IPoint point, double tolerance) Returns the elements at the given coordinate.
IEnumElement	locateElementsByEnvelope(IEnvelope envelope) Returns the elements inside the given envelope.
void	moveElementFromGroup(IGroupElement group, IElement element, int zorder) Move the element from the group to the container.
void	moveElementFromGroup(IGroupElement group, IElement element, int zorder, IAnnotationFeature[] newAnnotationFeature) Move the element from the group to the container.
void	moveElementToGroup(IElement element, IGroupElement group) Move the element from the container to the group.
IElement	next() Returns the next graphic in the container.
void	nextFeatureAndGraphic(IFeature[] feature, IElement[] element) Generates the next feature and graphic element in the graphics generation loop.
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	onChange(IObjectClassEventsOnChangeEvent theEvent) This event is fired when an object's attributes or geometry is updated.
void	onCreate(IObjectClassEventsOnCreateEvent theEvent) This event is fired when a new object is created in the object class.
void	onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent) This event is fired when a dataset is created.
void	onDelete(IObjectClassEventsOnDeleteEvent theEvent) This event is fired when an object is deleted from the object class.
void	onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent) This event is fired when a dataset is deleted.
void	onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent) This event is fired when a field is deleted from the object class.
void	onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent) This event is fired when a dataset is renamed.
void	prepareForPublishing() Prepare the layer for the publishing process.
void	prepareTimeQuery(ITimeValue pTimeValue, IQueryFilter[] pFilter) Prepares an input query filter by appending the time expression into the where clause.
void	prepareTimeQueryEx(ITimeValue pTimeValue, int eTimeRelation, IQueryFilter[] pFilter) Prepares an input query filter by appending the time expression into the where clause.
void	prepareTimeQueryFromDisplay(IDisplay pDisplay, IQueryFilter[] pFilter) Prepares an input query filter by appending the time expression into the where clause.
void	putElementOrder(java.lang.Object order) Private order object.
void	queryBarriers(IDisplay display, IGeometryCollection pBarriers, IEnvelope extent, ITrackCancel trackCancel) List of barriers within the specified extent, or all barriers if no extent given.
void	readExternal(java.io.ObjectInput in)
void	release() Release a FDOGraphicsLayer.
void	removeAllRelationshipClasses() Removes all memory relationship classes from a standalone table or layer.
void	removeExtension(int index) Removes the specified extension.
void	removeHyperlink(int index) Removes the hyperlink at the specified index.
void	removeISelectionEventsListener(ISelectionEvents theListener) removeISelectionEventsListener.
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	reset() Reset internal cursor so that Next returns the first element.
void	resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent) Notifies clients when the resolution is updated.
void	rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent) Notifies clients when the rotation angle is updated.
int	rowCount(IQueryFilter queryFilter) The number of Rows selected by the specified query.
void	save(IStream pstm, int fClearDirty) save
IFeatureCursor	search(IQueryFilter queryFilter, boolean recycling) Creates a cursor based upon the search criteria.
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.
void	selectAllElements() Selects all elements.
ISelectionSet	selectDisplayTable(IQueryFilter pQueryFilter, int selType, int selOption, IWorkspace pSelWorkspace) Creates a selection set from the display table based upon the search criteria.
IElement	selectedElement(int index) Returns the nth selected element.
void	selectElement(IElement element) Selects the specified element.
void	selectElements(IEnumElement elements) Selects the specified elements.
void	selectFeatures(IQueryFilter filter, int method, boolean justOne) Selects features based upon the specifed criteria and combination method.
void	selectionChanged() Fires the features layer update event.
ISelectionTracker	selectionTracker(int index) Returns the tracker for the nth selected element.
void	selectRows(IQueryFilter filter, int method, boolean justOne) Selects rows based upon the specified criteria and combination method.
void	sendBackward(IEnumElement elements) Move the specified elements one step closer to the bottom of the stack of elements.
void	sendToBack(IEnumElement elements) Make the specified elements draw behind all other elements.
void	setAreaOfInterest(IEnvelope aoi) The default area of interest for the layer.
void	setAssociatedLayerByRef(ILayer layer) Layer that is associated with this graphics layer.
void	setBrightness(short brightnessValue) Layer brightness in percent (-100 - 100).
void	setBrowseName(java.lang.String name) The browse name of the dataset.
void	setBufferDistance(double distance) Buffer distance used for the selection.
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setCombinationMethod(int method) Combination method for the selection.
void	setContrast(short contrastValue) Layer contrast in percent (-100 - 100).
void	setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime) Custom time extent during which a layer is visible.
void	setDataSourceName(IName name) Name of the data object for the layer.
void	setDataSourceType(java.lang.String text) Data source type.
void	setDefinitionExpression(java.lang.String expression) Definition query expression for the existing layer.
void	setDisplayField(java.lang.String fieldName) Primary display field.
void	setDisplayFilter(IDisplayFilter displayFilter) The display filter.
void	setDominantElementByRef(IElement dominantItem) Dominant element.
void	setDrawGeometry(boolean pUseScale) Indicates if the annotation geometry will draw.
void	setDrawGeometryLineSymbolByRef(ILineSymbol symbol) The line symbol for drawing the geometry.
void	setDrawGeometryMarkerSymbolByRef(IMarkerSymbol symbol) The marker symbol for drawing the geometry.
void	setDrawingPropsDirty(boolean dirty) Indicates if the layer drawing properties are dirty.
void	setDrawPhase(int pDrawPhase) Draw phase in which layer is drawn.
void	setDrawUnplacedAnnotation(boolean flag) Indicates if unplaced annotation is going to draw.
void	setEndTimeFieldName(java.lang.String fieldName) Name of the field that has end time for a row.
void	setExpanded(boolean expanded) Indicates if the layer is expanded in the TOC.
void	setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties) Properties that describe the display expression.
void	setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties) Properties that describe the hyperlink expression.
void	setFeatureClassByRef(IFeatureClass fclass) The layer's feature class.
void	setFieldOrder(IFieldInfoSet fieldInfoSet) A new order for the fields.
void	setHasLiveData(boolean useTime) setHasLiveData
void	setHotlinkField(java.lang.String fieldName) Field used for hotlinks.
void	setHotlinkType(int linkType) Hotlink type.
void	setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData) Indicates that all data for attachments will be retrieved.
void	setHTMLHideFieldNameColumn(boolean pHide) Indicates if Field name column will be output to the HTML Popup tool.
void	setHTMLPopupEnabled(boolean pEnabled) Indicates if this layer currently responds to the HTML Popup tool.
void	setHTMLPresentationStyle(int pStyle) Indicates the content formating style for the HTML Popup tool.
void	setHTMLRedirectField(java.lang.String pField) Indicates the fieldname of the layer that contains the HTML redirect URL values.
void	setHTMLRedirectFieldPrefix(java.lang.String pPrefix) Indicates the text to precede the HTMLRedirectField value for the redirect URL.
void	setHTMLRedirectFieldSuffix(java.lang.String pSufix) Indicates the text to follow the HTMLRedirectField value for the redirect URL.
void	setHTMLUseCodedDomainValues(boolean pCodedValues) Indicates whether to use coded values (rather than literal stored values) for feature values.
void	setHTMLXSLStylesheet(java.lang.String pStyleSheet) Indicates the content of the XSL stylesheet to parse the feature attributes through.
void	setHyperlinkByRef(int index, IHyperlink link) The hyperlink at the specified index.
void	setInlineColorByRef(IColor color) The color used for substituting symbols that do not reference the symbol collection.
void	setLayerDescription(java.lang.String text) Description for the layer.
void	setLayerWeight(double layerWeight) Default layer position.
void	setMacroName(java.lang.String name) Name of macro used for the hotlink.
void	setMapLevel(int mapLevel) Current map level for drawing multi-level symbols.
void	setMassColorByRef(IColor color) The color used for substituting only the color.
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	setOverflowElementsByRef(IElementCollection elements) Element collection.
void	setRelationshipClassByRef(IRelationshipClass relClass) The current relationship class used to display related fields.
void	setRelativeBase(java.lang.String basePath) Base path used when storing relative path names.
void	setScale(double rhs1) The current scale of the display.
void	setScaleSymbols(boolean scale) Indicates if symbols are scaled for the layer.
void	setSearchOrder(int order) Flag that specifies the search order used when applying a mixed attribute-spatial query.
void	setSelectable(boolean value) Indicates if layer is selectable.
void	setSelectionColorByRef(IColor color) Selection color.
void	setSelectionSetByRef(ISelectionSet selectionSet) The selected set of features.
void	setSelectionSymbolByRef(ISymbol symbol) Selection symbol.
void	setSetSelectionSymbol(boolean setSymbol) Indicates if the selected set of features is drawn using the SelectionSymbol.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setStartTimeFieldName(java.lang.String fieldName) Name of the field that has start time for a row.
void	setSubstituteSymbolCollectionByRef(ISymbolCollection symbolCollection) The substitute symbol collection when substituting the entire collection.
void	setSubstituteType(int substituteType) The type of symbol substitution.
void	setSupportsInteractive(boolean supported) Indicates if the layer supports interactive effects changes.
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	setTimeValueFormat(java.lang.String format) Time value format if the field name is of the string format.
void	setTrackIDFieldName(java.lang.String fieldName) Field that contains the rows that uniquely identifies the object whose time is being tracked.
void	setTransparency(short alpha) Layer transparency in percent (0-100).
void	setUnplacedAnnotationColorByRef(IColor color) Indicates the color with which unplaced annotation is drawn.
void	setupAttributeConversion(int numAttributes, int[] inputCols, int[] outputCols) Sets up attribute conversion parameters for batch conversion.
void	setupAttributeConversion2(int numAttributes, java.lang.Object inputCols, java.lang.Object outputCols) Sets up attribute conversion parameters for batch conversion.
void	setUseAssociatedLayerVisibility(boolean useLayer) Indicates if the layer that is associated with this graphics layer controls the visibility.
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	setWeight(int weight) Weight of the barriers in this layer.
void	startGeneratingGraphics(IEnvelope box, IDisplay display, boolean withAttributes, boolean useGroupSymbolElement, boolean selectedRecordsOnly) Starts a graphics generation process from the annotation features.
void	unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent) Notifies clients when the units are updated.
void	unselectAllElements() Unselects all elements.
void	unselectElement(IElement element) Unselects the specified element.
void	unselectElements(IEnumElement elements) Unselects the specified elements.
ICursor	update(IQueryFilter queryFilter, boolean recycling) Returns a cursor that can be used to update Rows selected by the specified query.
void	updateElement(IElement element) The graphic element's properties have changed.
void	updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer) Update the Rows in the database selected by the specified query.
void	visibilityChanged(ILayerEventsVisibilityChangedEvent theEvent) Occurs when layer visibility changes.
void	visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent) Notifies clients when the visible bounds is updated.
void	visibleFeatures(IQueryFilter filter) Updates query to include only visible features.
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

FDOGraphicsLayer

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

Constructs a FDOGraphicsLayer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FDOGraphicsLayer

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

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

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

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

addISelectionEventsListener

public void addISelectionEventsListener(ISelectionEvents theListener)
                                 throws java.io.IOException

addISelectionEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

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

removeISelectionEventsListener

public void removeISelectionEventsListener(ISelectionEvents theListener)
                                    throws java.io.IOException

removeISelectionEventsListener. Stop listening to events generated by this class.

Parameters:

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

Throws:

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

release

public void release()

Release a FDOGraphicsLayer.

Specified by:

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

beginAddElements

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

Begins a batch process for adding elements to a graphics layer.

Specified by:

beginAddElements in interface IAnnotationLayer

Specified by:

beginAddElements in interface IFDOGraphicsLayer

Specified by:

beginAddElements in interface IFDOGraphicsLayer2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setupAttributeConversion

public void setupAttributeConversion(int numAttributes,
                                     int[] inputCols,
                                     int[] outputCols)
                              throws java.io.IOException,
                                     AutomationException

Sets up attribute conversion parameters for batch conversion.

Specified by:

setupAttributeConversion in interface IAnnotationLayer

Specified by:

setupAttributeConversion in interface IFDOGraphicsLayer

Specified by:

setupAttributeConversion in interface IFDOGraphicsLayer2

Parameters:

numAttributes - The numAttributes (in)

inputCols - The inputCols (in)

outputCols - The outputCols (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doAddFeature

public void doAddFeature(IFeature pFeature,
                         IElement pElement,
                         int zorder)
                  throws java.io.IOException,
                         AutomationException

Adds a feature and its corresponding element to a graphics layer.

Specified by:

doAddFeature in interface IFDOGraphicsLayer

Specified by:

doAddFeature in interface IFDOGraphicsLayer2

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doAddElements

public void doAddElements(IElementCollection pElements,
                          int zorder)
                   throws java.io.IOException,
                          AutomationException

Adds a batch of elements to a graphics layer.

Specified by:

doAddElements in interface IAnnotationLayer

Specified by:

doAddElements in interface IFDOGraphicsLayer

Specified by:

doAddElements in interface IFDOGraphicsLayer2

Parameters:

pElements - A reference to a com.esri.arcgis.carto.IElementCollection (in)

zorder - The zorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

endAddElements

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

Ends the batch process for adding elements to a graphics layer.

Specified by:

endAddElements in interface IAnnotationLayer

Specified by:

endAddElements in interface IFDOGraphicsLayer

Specified by:

endAddElements in interface IFDOGraphicsLayer2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doAddFeature

public void doAddFeature(IFeature pFeature,
                         IElement pElement,
                         int zorder,
                         int annotationClassID,
                         int status)
                  throws java.io.IOException,
                         AutomationException

Adds a feature and its corresponding element to a graphics layer.

Specified by:

doAddFeature in interface IAnnotationLayer

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

annotationClassID - The annotationClassID (in)

status - A com.esri.arcgis.carto.esriAnnotationStatus constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doAddNullElement

public void doAddNullElement(int featureId,
                             int annotationClassID,
                             int status)
                      throws java.io.IOException,
                             AutomationException

Adds a feature and its corresponding element to a graphics layer.

Specified by:

doAddNullElement in interface IAnnotationLayer

Parameters:

featureId - The featureId (in)

annotationClassID - The annotationClassID (in)

status - A com.esri.arcgis.carto.esriAnnotationStatus constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDrawUnplacedAnnotation

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

Indicates if unplaced annotation is going to draw.

Specified by:

isDrawUnplacedAnnotation in interface IAnnotationLayer

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawUnplacedAnnotation

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

Indicates if unplaced annotation is going to draw.

Specified by:

setDrawUnplacedAnnotation in interface IAnnotationLayer

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnplacedAnnotationColor

public IColor getUnplacedAnnotationColor()
                                  throws java.io.IOException,
                                         AutomationException

Indicates the color with which unplaced annotation is drawn.

Specified by:

getUnplacedAnnotationColor in interface IAnnotationLayer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnplacedAnnotationColorByRef

public void setUnplacedAnnotationColorByRef(IColor color)
                                     throws java.io.IOException,
                                            AutomationException

Indicates the color with which unplaced annotation is drawn.

Specified by:

setUnplacedAnnotationColorByRef in interface IAnnotationLayer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAddErrorInfo

public void getAddErrorInfo(java.lang.String[] errors,
                            java.lang.String[] filePath)
                     throws java.io.IOException,
                            AutomationException

The errors and the file and path of the GL*.log file which stores error information when Add is called in batch (using BeginAddElements and EndAddElements).

Specified by:

getAddErrorInfo in interface IAnnotationLayer

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

generateGraphics

public IEnumElement generateGraphics(IEnvelope box,
                                     IDisplay display,
                                     ITrackCancel pTrackCancel,
                                     boolean useGroupSymbolElement)
                              throws java.io.IOException,
                                     AutomationException

Generates graphic elements from the annotation features. The optional envelope specifies a bounding box. The display is used for converting from map units.

Specified by:

generateGraphics in interface IFDOGraphicsLayerRead

Parameters:

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

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

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

useGroupSymbolElement - The useGroupSymbolElement (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startGeneratingGraphics

public void startGeneratingGraphics(IEnvelope box,
                                    IDisplay display,
                                    boolean withAttributes,
                                    boolean useGroupSymbolElement,
                                    boolean selectedRecordsOnly)
                             throws java.io.IOException,
                                    AutomationException

Starts a graphics generation process from the annotation features. The optional envelope specifies a bounding box. The display is used for converting from map units.

Specified by:

startGeneratingGraphics in interface IFDOGraphicsLayerRead

Parameters:

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

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

withAttributes - The withAttributes (in)

useGroupSymbolElement - The useGroupSymbolElement (in)

selectedRecordsOnly - The selectedRecordsOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNextGraphic

public IElement getNextGraphic()
                        throws java.io.IOException,
                               AutomationException

Generates the next graphic element in the graphics generation loop. Returns a NULL element after the last annotation feature has been read. Call only after StartGeneratingGraphics.

Specified by:

getNextGraphic in interface IFDOGraphicsLayerRead

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

nextFeatureAndGraphic

public void nextFeatureAndGraphic(IFeature[] feature,
                                  IElement[] element)
                           throws java.io.IOException,
                                  AutomationException

Generates the next feature and graphic element in the graphics generation loop. Returns a NULL feature and element after the last annotation feature has been read. Call only after StartGeneratingGraphics.

Specified by:

nextFeatureAndGraphic in interface IFDOGraphicsLayerRead

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (out: use single element array)

element - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IScreenDisplay containerScreen)
              throws java.io.IOException,
                     AutomationException

Prepare to display graphic on screen.

Specified by:

activate in interface IGraphicsLayer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deactivate

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

ActiveView that graphics are displayed on is no longer visible.

Specified by:

deactivate in interface IGraphicsLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseAssociatedLayerVisibility

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

Indicates if the layer that is associated with this graphics layer controls the visibility.

Specified by:

isUseAssociatedLayerVisibility in interface IGraphicsLayer

Returns:

The useLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseAssociatedLayerVisibility

public void setUseAssociatedLayerVisibility(boolean useLayer)
                                     throws java.io.IOException,
                                            AutomationException

Indicates if the layer that is associated with this graphics layer controls the visibility.

Specified by:

setUseAssociatedLayerVisibility in interface IGraphicsLayer

Parameters:

useLayer - The useLayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAssociatedLayer

public ILayer getAssociatedLayer()
                          throws java.io.IOException,
                                 AutomationException

Layer that is associated with this graphics layer.

Specified by:

getAssociatedLayer in interface IGraphicsLayer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAssociatedLayerByRef

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

Layer that is associated with this graphics layer.

Specified by:

setAssociatedLayerByRef in interface IGraphicsLayer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

next

public IElement next()
              throws java.io.IOException,
                     AutomationException

Returns the next graphic in the container.

Specified by:

next in interface IGraphicsContainer

Returns:

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

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 internal cursor so that Next returns the first element.

Specified by:

reset in interface IGraphicsContainer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addElement

public void addElement(IElement element,
                       int zorder)
                throws java.io.IOException,
                       AutomationException

Add a new graphic element to the layer.

Specified by:

addElement in interface IGraphicsContainer

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addElements

public void addElements(IElementCollection elements,
                        int zorder)
                 throws java.io.IOException,
                        AutomationException

Add new graphic elements to the layer.

Specified by:

addElements in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IElementCollection (in)

zorder - The zorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteElement

public void deleteElement(IElement element)
                   throws java.io.IOException,
                          AutomationException

Delete the given element.

Specified by:

deleteElement in interface IGraphicsContainer

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteAllElements

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

Delete all the elements.

Specified by:

deleteAllElements in interface IGraphicsContainer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveElementToGroup

public void moveElementToGroup(IElement element,
                               IGroupElement group)
                        throws java.io.IOException,
                               AutomationException

Move the element from the container to the group.

Specified by:

moveElementToGroup in interface IGraphicsContainer

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

group - A reference to a com.esri.arcgis.carto.IGroupElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveElementFromGroup

public void moveElementFromGroup(IGroupElement group,
                                 IElement element,
                                 int zorder)
                          throws java.io.IOException,
                                 AutomationException

Move the element from the group to the container.

Specified by:

moveElementFromGroup in interface IGraphicsContainer

Parameters:

group - A reference to a com.esri.arcgis.carto.IGroupElement (in)

element - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

locateElements

public IEnumElement locateElements(IPoint point,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Returns the elements at the given coordinate.

Specified by:

locateElements in interface IGraphicsContainer

Parameters:

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

tolerance - The tolerance (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

locateElementsByEnvelope

public IEnumElement locateElementsByEnvelope(IEnvelope envelope)
                                      throws java.io.IOException,
                                             AutomationException

Returns the elements inside the given envelope.

Specified by:

locateElementsByEnvelope in interface IGraphicsContainer

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findFrame

public IFrameElement findFrame(java.lang.Object frameObject)
                        throws java.io.IOException,
                               AutomationException

Find the frame that contains the specified object.

Specified by:

findFrame in interface IGraphicsContainer

Parameters:

frameObject - A Variant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateElement

public void updateElement(IElement element)
                   throws java.io.IOException,
                          AutomationException

The graphic element's properties have changed.

Specified by:

updateElement in interface IGraphicsContainer

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementOrder

public java.lang.Object getElementOrder(IEnumElement elements)
                                 throws java.io.IOException,
                                        AutomationException

Private order object. Used to undo ordering operations.

Specified by:

getElementOrder in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putElementOrder

public void putElementOrder(java.lang.Object order)
                     throws java.io.IOException,
                            AutomationException

Private order object. Used to undo ordering operations.

Specified by:

putElementOrder in interface IGraphicsContainer

Parameters:

order - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

bringToFront

public void bringToFront(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException

Make the specified elements draw in front of all other elements.

Specified by:

bringToFront in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sendToBack

public void sendToBack(IEnumElement elements)
                throws java.io.IOException,
                       AutomationException

Make the specified elements draw behind all other elements.

Specified by:

sendToBack in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sendBackward

public void sendBackward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException

Move the specified elements one step closer to the bottom of the stack of elements.

Specified by:

sendBackward in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

bringForward

public void bringForward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException

Move the specified elements one step closer to the top of the stack of elements.

Specified by:

bringForward in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addElement

public void addElement(IElement element,
                       int zorder,
                       IAnnotationFeature[] newAnnotationFeature)
                throws java.io.IOException,
                       AutomationException

Add a new graphic element to the layer.

Specified by:

addElement in interface IFDOGraphicsContainer

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

newAnnotationFeature - A reference to a com.esri.arcgis.carto.IAnnotationFeature (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveElementFromGroup

public void moveElementFromGroup(IGroupElement group,
                                 IElement element,
                                 int zorder,
                                 IAnnotationFeature[] newAnnotationFeature)
                          throws java.io.IOException,
                                 AutomationException

Move the element from the group to the container.

Specified by:

moveElementFromGroup in interface IFDOGraphicsContainer

Parameters:

group - A reference to a com.esri.arcgis.carto.IGroupElement (in)

element - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

newAnnotationFeature - A reference to a com.esri.arcgis.carto.IAnnotationFeature (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOverflowElements

public IElementCollection getOverflowElements()
                                       throws java.io.IOException,
                                              AutomationException

Element collection.

Specified by:

getOverflowElements in interface IOverflowGraphicsContainer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverflowElementsByRef

public void setOverflowElementsByRef(IElementCollection elements)
                              throws java.io.IOException,
                                     AutomationException

Element collection.

Specified by:

setOverflowElementsByRef in interface IOverflowGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IElementCollection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteAllOverflowElements

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

Delete all the element in the collection.

Specified by:

deleteAllOverflowElements in interface IOverflowGraphicsContainer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteOverflowElement

public void deleteOverflowElement(IElement pElement)
                           throws java.io.IOException,
                                  AutomationException

Delete an element in the collection.

Specified by:

deleteOverflowElement in interface IOverflowGraphicsContainer

Parameters:

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addOverflowElement

public void addOverflowElement(IElement pElement)
                        throws java.io.IOException,
                               AutomationException

Add an element to the collection.

Specified by:

addOverflowElement in interface IOverflowGraphicsContainer

Parameters:

pElement - A reference to a com.esri.arcgis.carto.IElement (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.

getWeight

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

Weight of the barriers in this layer.

Specified by:

getWeight in interface IBarrierProperties

Specified by:

getWeight in interface IBarrierProperties2

Returns:

The weight

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWeight

public void setWeight(int weight)
               throws java.io.IOException,
                      AutomationException

Weight of the barriers in this layer.

Specified by:

setWeight in interface IBarrierProperties

Specified by:

setWeight in interface IBarrierProperties2

Parameters:

weight - The weight (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBarriers

public void getBarriers(IDisplay display,
                        IGeometryCollection pBarriers,
                        IEnvelope extent)
                 throws java.io.IOException,
                        AutomationException

List of barriers within the specified extent, or all barriers if no extent given.

Specified by:

getBarriers in interface IBarrierProperties

Parameters:

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

pBarriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in, optional, pass 0 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBarriers

public void queryBarriers(IDisplay display,
                          IGeometryCollection pBarriers,
                          IEnvelope extent,
                          ITrackCancel trackCancel)
                   throws java.io.IOException,
                          AutomationException

List of barriers within the specified extent, or all barriers if no extent given.

Specified by:

queryBarriers in interface IBarrierProperties2

Parameters:

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

pBarriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (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.

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.

visibilityChanged

public void visibilityChanged(ILayerEventsVisibilityChangedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Occurs when layer visibility changes.

Specified by:

visibilityChanged in interface ILayerEvents

Parameters:

theEvent - The event

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.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws java.io.IOException,
                                     AutomationException

The layer's feature class.

Specified by:

getFeatureClass in interface IFeatureLayer

Specified by:

getFeatureClass in interface IFeatureLayer2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass fclass)
                          throws java.io.IOException,
                                 AutomationException

The layer's feature class.

Specified by:

setFeatureClassByRef in interface IFeatureLayer

Specified by:

setFeatureClassByRef in interface IFeatureLayer2

Parameters:

fclass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSourceType

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

Data source type.

Specified by:

getDataSourceType in interface IFeatureLayer

Specified by:

getDataSourceType in interface IFeatureLayer2

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataSourceType

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

Data source type.

Specified by:

setDataSourceType in interface IFeatureLayer

Specified by:

setDataSourceType in interface IFeatureLayer2

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayField

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

Primary display field.

Specified by:

getDisplayField in interface IFeatureLayer

Specified by:

getDisplayField in interface IFeatureLayer2

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayField

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

Primary display field.

Specified by:

setDisplayField in interface IFeatureLayer

Specified by:

setDisplayField in interface IFeatureLayer2

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSelectable

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

Indicates if layer is selectable.

Specified by:

isSelectable in interface IFeatureLayer

Specified by:

isSelectable in interface IFeatureLayer2

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectable

public void setSelectable(boolean value)
                   throws java.io.IOException,
                          AutomationException

Indicates if layer is selectable.

Specified by:

setSelectable in interface IFeatureLayer

Specified by:

setSelectable in interface IFeatureLayer2

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

search

public IFeatureCursor search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException

Creates a cursor based upon the search criteria.

Specified by:

search in interface IFeatureLayer

Specified by:

search in interface IFeatureLayer2

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

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

Indicates if symbols are scaled for the layer.

Specified by:

isScaleSymbols in interface IFeatureLayer

Specified by:

isScaleSymbols in interface IFeatureLayer2

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws java.io.IOException,
                            AutomationException

Indicates if symbols are scaled for the layer.

Specified by:

setScaleSymbols in interface IFeatureLayer

Specified by:

setScaleSymbols in interface IFeatureLayer2

Parameters:

scale - The scale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

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.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ILayer

Specified by:

setName in interface ILayer2

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

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

Indicates if the layer is currently valid.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isValid in interface ILayer

Specified by:

isValid in interface ILayer2

Returns:

The valid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

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

The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaOfInterest in interface ILayer

Specified by:

getAreaOfInterest in interface ILayer2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

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

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumScale in interface ILayer

Specified by:

getMinimumScale in interface ILayer2

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

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

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumScale in interface ILayer

Specified by:

setMinimumScale in interface ILayer2

Parameters:

minScale - The minScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

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

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaximumScale in interface ILayer

Specified by:

getMaximumScale in interface ILayer2

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

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

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaximumScale in interface ILayer

Specified by:

setMaximumScale in interface ILayer2

Parameters:

maxScale - The maxScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

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

Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ILayer

Specified by:

isVisible in interface ILayer2

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

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

Indicates if the layer is currently visible.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface ILayer

Specified by:

setVisible in interface ILayer2

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowTips

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

Indicates if the layer shows map tips.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowTips in interface ILayer

Specified by:

isShowTips in interface ILayer2

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowTips

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

Indicates if the layer shows map tips.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowTips in interface ILayer

Specified by:

setShowTips in interface ILayer2

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTipText

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

Map tip text at the specified location.

Product Availability

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

Specified by:

getTipText in interface ILayer

Specified by:

getTipText in interface ILayer2

Parameters:

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCached

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

Indicates if the layer needs its own display cache.

Remarks

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCached in interface ILayer

Specified by:

isCached in interface ILayer2

Returns:

The cached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCached

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

Indicates if the layer needs its own display cache.

Description

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

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCached in interface ILayer

Specified by:

setCached in interface ILayer2

Parameters:

cached - The cached (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

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

Supported draw phases.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSupportedDrawPhases in interface ILayer

Specified by:

getSupportedDrawPhases in interface ILayer2

Returns:

The drawPhases

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

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

Spatial reference for the layer.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpatialReferenceByRef in interface ILayer

Specified by:

setSpatialReferenceByRef in interface ILayer2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

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

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ILayer

Specified by:

draw in interface ILayer2

Parameters:

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

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

The selected set of features.

Specified by:

getSelectionSet in interface IFeatureSelection

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

Specified by:

setSelectionSetByRef in interface IFeatureSelection

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.

getCombinationMethod

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

Combination method for the selection.

Specified by:

getCombinationMethod in interface IFeatureSelection

Returns:

A com.esri.arcgis.carto.esriSelectionResultEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCombinationMethod

public void setCombinationMethod(int method)
                          throws java.io.IOException,
                                 AutomationException

Combination method for the selection.

Specified by:

setCombinationMethod in interface IFeatureSelection

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBufferDistance

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

Buffer distance used for the selection.

Specified by:

getBufferDistance in interface IFeatureSelection

Returns:

The distance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBufferDistance

public void setBufferDistance(double distance)
                       throws java.io.IOException,
                              AutomationException

Buffer distance used for the selection.

Specified by:

setBufferDistance in interface IFeatureSelection

Parameters:

distance - The distance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSetSelectionSymbol

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

Indicates if the selected set of features is drawn using the SelectionSymbol.

Specified by:

isSetSelectionSymbol in interface IFeatureSelection

Returns:

The setSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSetSelectionSymbol

public void setSetSelectionSymbol(boolean setSymbol)
                           throws java.io.IOException,
                                  AutomationException

Indicates if the selected set of features is drawn using the SelectionSymbol.

Specified by:

setSetSelectionSymbol in interface IFeatureSelection

Parameters:

setSymbol - The setSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionColor

public IColor getSelectionColor()
                         throws java.io.IOException,
                                AutomationException

Selection color. (used when SetSelectionSymbol = FALSE).

Specified by:

getSelectionColor in interface IFeatureSelection

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionColorByRef

public void setSelectionColorByRef(IColor color)
                            throws java.io.IOException,
                                   AutomationException

Selection color. (used when SetSelectionSymbol = FALSE).

Specified by:

setSelectionColorByRef in interface IFeatureSelection

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionSymbol

public ISymbol getSelectionSymbol()
                           throws java.io.IOException,
                                  AutomationException

Selection symbol.

Specified by:

getSelectionSymbol in interface IFeatureSelection

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionSymbolByRef

public void setSelectionSymbolByRef(ISymbol symbol)
                             throws java.io.IOException,
                                    AutomationException

Selection symbol.

Specified by:

setSelectionSymbolByRef in interface IFeatureSelection

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(IFeature feature)
         throws java.io.IOException,
                AutomationException

Adds a feature to the selection set.

Specified by:

add in interface IFeatureSelection

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectFeatures

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

Selects features based upon the specifed criteria and combination method.

Specified by:

selectFeatures in interface IFeatureSelection

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 IFeatureSelection

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 features layer update event. Required when SelectionSet changes.

Specified by:

selectionChanged in interface IFeatureSelection

Specified by:

selectionChanged in interface ITableSelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setupAttributeConversion2

public void setupAttributeConversion2(int numAttributes,
                                      java.lang.Object inputCols,
                                      java.lang.Object outputCols)
                               throws java.io.IOException,
                                      AutomationException

Sets up attribute conversion parameters for batch conversion.

Specified by:

setupAttributeConversion2 in interface IFDOAttributeConversion

Parameters:

numAttributes - The numAttributes (in)

inputCols - A Variant (in)

outputCols - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSourceName

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

Name of the data object for the layer.

Specified by:

getDataSourceName in interface IDataLayer

Specified by:

getDataSourceName in interface IDataLayer2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataSourceName

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

Name of the data object for the layer.

Specified by:

setDataSourceName in interface IDataLayer

Specified by:

setDataSourceName in interface IDataLayer2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

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

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

Specified by:

isDataSourceSupported in interface IDataLayer

Specified by:

isDataSourceSupported in interface IDataLayer2

Parameters:

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

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

connect

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

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

Specified by:

connect in interface IDataLayer

Specified by:

connect in interface IDataLayer2

Parameters:

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

Returns:

The succeeded

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelativeBase

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

Base path used when storing relative path names.

Specified by:

getRelativeBase in interface IDataLayer

Specified by:

getRelativeBase in interface IDataLayer2

Returns:

The basePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativeBase

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

Base path used when storing relative path names.

Specified by:

setRelativeBase in interface IDataLayer

Specified by:

setRelativeBase in interface IDataLayer2

Parameters:

basePath - The basePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.

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.

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.

isUsesFilter

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

Indicates if the current object draws using a filter.

Specified by:

isUsesFilter in interface IDisplayAdmin

Returns:

The usesFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayFilter

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

The display filter.

Specified by:

setDisplayFilter in interface IDisplayFilterManager

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayFilter

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

The display filter.

Specified by:

getDisplayFilter in interface IDisplayFilterManager

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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

Specified by:

getRelationshipClass in interface IFeatureLayerDefinition

Specified by:

getRelationshipClass in interface IFeatureLayerDefinition2

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.

getShapeType

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

The layer's shape type.

Specified by:

getShapeType in interface IFeatureLayer2

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay display,
                                   IGeometry region)
                            throws java.io.IOException,
                                   AutomationException

Expands the given geometry by an amount that will include the layer's symbology for the given display.

Specified by:

expandRegionForSymbols in interface IFeatureLayer2

Specified by:

expandRegionForSymbols in interface ILayerSymbologyExtents

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

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

Definition query expression for the existing layer.

Specified by:

getDefinitionExpression in interface IFeatureLayerDefinition

Specified by:

getDefinitionExpression in interface IFeatureLayerDefinition2

Specified by:

getDefinitionExpression in interface ITableDefinition

Returns:

The expression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

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

Definition query expression for the existing layer.

Specified by:

setDefinitionExpression in interface IFeatureLayerDefinition

Specified by:

setDefinitionExpression in interface IFeatureLayerDefinition2

Specified by:

setDefinitionExpression in interface ITableDefinition

Parameters:

expression - The expression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefinitionSelectionSet

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

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

Specified by:

getDefinitionSelectionSet in interface IFeatureLayerDefinition

Specified by:

getDefinitionSelectionSet in interface IFeatureLayerDefinition2

Specified by:

getDefinitionSelectionSet in interface ITableDefinition

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createSelectionLayer

public IFeatureLayer createSelectionLayer(java.lang.String layerName,
                                          boolean useCurrentSelection,
                                          java.lang.String joinTableNames,
                                          java.lang.String expression)
                                   throws java.io.IOException,
                                          AutomationException

Creates a new feature layer from the existing layer based on the current selection and the specified query expression.

Specified by:

createSelectionLayer in interface IFeatureLayerDefinition

Specified by:

createSelectionLayer in interface IFeatureLayerDefinition2

Parameters:

layerName - The layerName (in)

useCurrentSelection - The useCurrentSelection (in)

joinTableNames - The joinTableNames (in)

expression - The expression (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelationshipClassByRef

public void setRelationshipClassByRef(IRelationshipClass relClass)
                               throws java.io.IOException,
                                      AutomationException

The current relationship class used to display related fields.

Specified by:

setRelationshipClassByRef in interface IFeatureLayerDefinition

Specified by:

setRelationshipClassByRef in interface IFeatureLayerDefinition2

Parameters:

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

getSearchOrder

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

Flag that specifies the search order used when applying a mixed attribute-spatial query.

Specified by:

getSearchOrder in interface IFeatureLayerDefinition2

Returns:

A com.esri.arcgis.geodatabase.esriSearchOrder constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchOrder

public void setSearchOrder(int order)
                    throws java.io.IOException,
                           AutomationException

Flag that specifies the search order used when applying a mixed attribute-spatial query.

Specified by:

setSearchOrder in interface IFeatureLayerDefinition2

Parameters:

order - A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

find

public IArray find(java.lang.String search,
                   boolean contains,
                   java.lang.Object fields,
                   ITrackCancel trackCancel)
            throws java.io.IOException,
                   AutomationException

Finds the specified search string in the given attribute fields.

Specified by:

find in interface IFind

Parameters:

search - The search (in)

contains - The contains (in)

fields - A Variant (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFindFields

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

The attribute fields.

Specified by:

getFindFields in interface IFind

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFindDisplayField

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

The display field.

Specified by:

getFindDisplayField in interface IFind

Returns:

The field

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectElement

public void selectElement(IElement element)
                   throws java.io.IOException,
                          AutomationException

Selects the specified element.

Specified by:

selectElement in interface IGraphicsContainerSelect

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectElements

public void selectElements(IEnumElement elements)
                    throws java.io.IOException,
                           AutomationException

Selects the specified elements.

Specified by:

selectElements in interface IGraphicsContainerSelect

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectAllElements

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

Selects all elements.

Specified by:

selectAllElements in interface IGraphicsContainerSelect

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unselectElement

public void unselectElement(IElement element)
                     throws java.io.IOException,
                            AutomationException

Unselects the specified element.

Specified by:

unselectElement in interface IGraphicsContainerSelect

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unselectElements

public void unselectElements(IEnumElement elements)
                      throws java.io.IOException,
                             AutomationException

Unselects the specified elements.

Specified by:

unselectElements in interface IGraphicsContainerSelect

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unselectAllElements

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

Unselects all elements.

Specified by:

unselectAllElements in interface IGraphicsContainerSelect

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedElements

public IEnumElement getSelectedElements()
                                 throws java.io.IOException,
                                        AutomationException

The selected elements.

Specified by:

getSelectedElements in interface IGraphicsContainerSelect

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementSelectionCount

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

The number of selected elements.

Specified by:

getElementSelectionCount in interface IGraphicsContainerSelect

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectedElement

public IElement selectedElement(int index)
                         throws java.io.IOException,
                                AutomationException

Returns the nth selected element. Use Selection count to get the number of selected elements.

Specified by:

selectedElement in interface IGraphicsContainerSelect

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectionTracker

public ISelectionTracker selectionTracker(int index)
                                   throws java.io.IOException,
                                          AutomationException

Returns the tracker for the nth selected element. Use Selection count to get the number of selected elements.

Specified by:

selectionTracker in interface IGraphicsContainerSelect

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

elementSelected

public boolean elementSelected(IElement element)
                        throws java.io.IOException,
                               AutomationException

Indicates if the element is selected.

Specified by:

elementSelected in interface IGraphicsContainerSelect

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Returns:

The elementSelected

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDominantElement

public IElement getDominantElement()
                            throws java.io.IOException,
                                   AutomationException

Dominant element.

Specified by:

getDominantElement in interface IGraphicsContainerSelect

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDominantElementByRef

public void setDominantElementByRef(IElement dominantItem)
                             throws java.io.IOException,
                                    AutomationException

Dominant element.

Specified by:

setDominantElementByRef in interface IGraphicsContainerSelect

Parameters:

dominantItem - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionBounds

public IEnvelope getSelectionBounds(IDisplay display)
                             throws java.io.IOException,
                                    AutomationException

The bounds of the selection.

Specified by:

getSelectionBounds in interface IGraphicsContainerSelect

Parameters:

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

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.

getHotlinkField

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

Field used for hotlinks.

Specified by:

getHotlinkField in interface IHotlinkContainer

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHotlinkField

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

Field used for hotlinks.

Specified by:

setHotlinkField in interface IHotlinkContainer

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHotlinkType

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

Hotlink type.

Specified by:

getHotlinkType in interface IHotlinkContainer

Returns:

A com.esri.arcgis.carto.esriHyperlinkType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHotlinkType

public void setHotlinkType(int linkType)
                    throws java.io.IOException,
                           AutomationException

Hotlink type.

Specified by:

setHotlinkType in interface IHotlinkContainer

Parameters:

linkType - A com.esri.arcgis.carto.esriHyperlinkType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMacroName

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

Name of macro used for the hotlink.

Specified by:

getMacroName in interface IHotlinkMacro

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMacroName

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

Name of macro used for the hotlink.

Specified by:

setMacroName in interface IHotlinkMacro

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IHotlinkExpression_getExpressionProperties

public IHotLinkExpressionProperties IHotlinkExpression_getExpressionProperties()
                                                                        throws java.io.IOException,
                                                                               AutomationException

Properties that describe the hyperlink expression.

Specified by:

IHotlinkExpression_getExpressionProperties in interface IHotlinkExpression

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpressionPropertiesByRef

public void setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties)
                                  throws java.io.IOException,
                                         AutomationException

Properties that describe the hyperlink expression.

Specified by:

setExpressionPropertiesByRef in interface IHotlinkExpression

Parameters:

ppHotLinkExpressionProperties - A reference to a com.esri.arcgis.carto.IHotLinkExpressionProperties (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

executeExpression

public java.lang.String executeExpression(IObject pObject)
                                   throws java.io.IOException,
                                          AutomationException

Finds the hyperlink for the given feature based on the current expression properties.

Specified by:

executeExpression in interface IHotlinkExpression

Parameters:

pObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHyperlinkCount

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

Number of hyperlinks.

Specified by:

getHyperlinkCount in interface IHyperlinkContainer

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHyperlink

public IHyperlink getHyperlink(int index)
                        throws java.io.IOException,
                               AutomationException

The hyperlink at the specified index.

Specified by:

getHyperlink in interface IHyperlinkContainer

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHyperlinkByRef

public void setHyperlinkByRef(int index,
                              IHyperlink link)
                       throws java.io.IOException,
                              AutomationException

The hyperlink at the specified index.

Specified by:

setHyperlinkByRef in interface IHyperlinkContainer

Parameters:

index - The index (in)

link - A reference to a com.esri.arcgis.carto.IHyperlink (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addHyperlink

public void addHyperlink(IHyperlink link)
                  throws java.io.IOException,
                         AutomationException

Adds a hyperlink.

Specified by:

addHyperlink in interface IHyperlinkContainer

Parameters:

link - A reference to a com.esri.arcgis.carto.IHyperlink (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeHyperlink

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

Removes the hyperlink at the specified index.

Specified by:

removeHyperlink in interface IHyperlinkContainer

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

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

Identifies objects at the specified location.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

identify in interface IIdentify

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

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

Identifies objects at the specified location.

Specified by:

identify in interface IIdentify2

Parameters:

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

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScale

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

The current scale of the display.

Specified by:

setScale in interface IIdentify2

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

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

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

Specified by:

isScaleRangeReadOnly in interface ILayer2

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

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

The default area of interest for the layer.

Specified by:

setAreaOfInterest in interface ILayer2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDrawingPropsDirty

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

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDrawingPropsDirty in interface ILayerDrawingProperties

Returns:

The dirty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

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

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDrawingPropsDirty in interface ILayerDrawingProperties

Parameters:

dirty - The dirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

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

Indicates if the layer supports transparency.

Specified by:

isSupportsTransparency in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

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

Indicates if the layer supports contrast changes.

Specified by:

isSupportsContrastChange in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

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

Indicates if the layer supports brightness changes.

Specified by:

isSupportsBrightnessChange in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

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

Indicates if the layer supports interactive effects changes.

Specified by:

setSupportsInteractive in interface ILayerEffects

Parameters:

supported - The supported (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

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

Indicates if the layer supports interactive effects changes.

Specified by:

isSupportsInteractive in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparency

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

Layer transparency in percent (0-100).

Specified by:

getTransparency in interface ILayerEffects

Returns:

The alpha

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparency

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

Layer transparency in percent (0-100).

Specified by:

setTransparency in interface ILayerEffects

Parameters:

alpha - The alpha (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContrast

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

Layer contrast in percent (-100 - 100).

Specified by:

getContrast in interface ILayerEffects

Returns:

The contrastValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContrast

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

Layer contrast in percent (-100 - 100).

Specified by:

setContrast in interface ILayerEffects

Parameters:

contrastValue - The contrastValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrightness

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

Layer brightness in percent (-100 - 100).

Specified by:

getBrightness in interface ILayerEffects

Returns:

The brightnessValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrightness

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

Layer brightness in percent (-100 - 100).

Specified by:

setBrightness in interface ILayerEffects

Parameters:

brightnessValue - The brightnessValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionCount

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

Number of extensions.

Specified by:

getExtensionCount in interface ILayerExtensions

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtension

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

The extension at the specified index.

Specified by:

getExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addExtension

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

Adds a new extension.

Specified by:

addExtension in interface ILayerExtensions

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeExtension

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

Removes the specified extension.

Specified by:

removeExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.

findField

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

Returns 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:

fieldName - The fieldName (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerWeight

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

Default layer position.

Specified by:

getLayerWeight in interface ILayerPosition

Returns:

The layerWeight

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerWeight

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

Default layer position.

Specified by:

setLayerWeight in interface ILayerPosition

Parameters:

layerWeight - The layerWeight (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapLevel

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

Current map level for drawing multi-level symbols.

Specified by:

getMapLevel in interface IMapLevel

Returns:

The mapLevel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException

Current map level for drawing multi-level symbols.

Specified by:

setMapLevel in interface IMapLevel

Parameters:

mapLevel - The mapLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onCreate

public void onCreate(IObjectClassEventsOnCreateEvent theEvent)
              throws java.io.IOException,
                     AutomationException

This event is fired when a new object is created in the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onCreate in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onDelete

public void onDelete(IObjectClassEventsOnDeleteEvent theEvent)
              throws java.io.IOException,
                     AutomationException

This event is fired when an object is deleted from the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onDelete in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onChange

public void onChange(IObjectClassEventsOnChangeEvent theEvent)
              throws java.io.IOException,
                     AutomationException

This event is fired when an object's attributes or geometry is updated.

Remarks

In the event that a feature should be deleted due to an OnChange event, it is not recommended that the event handler delete the feature itself. Instead, an exception should be thrown to the application, where it can be made responsible for deleting the feature.

The OnChange event is not fired during a Topology Validation for performance reasons as a large number of features may be changed during a Validate. In addition, features may be changed many times.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onChange in interface IObjectClassEvents

Parameters:

theEvent - The event

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.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Specified by:

applies in interface IPropertySupport

Parameters:

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

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Specified by:

canApply in interface IPropertySupport

Parameters:

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

Returns:

The canApply

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrent

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

The object currently being used.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (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.

apply

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

Applies the given property to the receiver and returns the old object.

Specified by:

apply in interface IPropertySupport

Parameters:

newObject - A reference to another Object (IUnknown) (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.

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.

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.

isCanSelect

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

Indicates if the table supports selection.

Specified by:

isCanSelect in interface ITableCapabilities

Returns:

The canSelect

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.

getDrawPhase

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

Draw phase in which layer is drawn.

Specified by:

getDrawPhase in interface ILayerDrawingPhase

Returns:

A com.esri.arcgis.system.esriDrawPhase constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawPhase

public void setDrawPhase(int pDrawPhase)
                  throws java.io.IOException,
                         AutomationException

Draw phase in which layer is drawn.

Specified by:

setDrawPhase in interface ILayerDrawingPhase

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

Number of layers in the collection.

Specified by:

getCount in interface ICompositeLayer

Specified by:

getCount in interface ICompositeLayer2

Returns:

The layerCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

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

Layer in the collection at the specified index.

Specified by:

getLayer in interface ICompositeLayer

Specified by:

getLayer in interface ICompositeLayer2

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isExpanded

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

Indicates if the layer is expanded in the TOC.

Specified by:

isExpanded in interface ICompositeLayer2

Returns:

The expanded

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpanded

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

Indicates if the layer is expanded in the TOC.

Specified by:

setExpanded in interface ICompositeLayer2

Parameters:

expanded - The expanded (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMassColor

public IColor getMassColor()
                    throws java.io.IOException,
                           AutomationException

The color used for substituting only the color.

Specified by:

getMassColor in interface ISymbolSubstitution

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMassColorByRef

public void setMassColorByRef(IColor color)
                       throws java.io.IOException,
                              AutomationException

The color used for substituting only the color.

Specified by:

setMassColorByRef in interface ISymbolSubstitution

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInlineColor

public IColor getInlineColor()
                      throws java.io.IOException,
                             AutomationException

The color used for substituting symbols that do not reference the symbol collection.

Specified by:

getInlineColor in interface ISymbolSubstitution

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInlineColorByRef

public void setInlineColorByRef(IColor color)
                         throws java.io.IOException,
                                AutomationException

The color used for substituting symbols that do not reference the symbol collection.

Specified by:

setInlineColorByRef in interface ISymbolSubstitution

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubstituteSymbolCollection

public ISymbolCollection getSubstituteSymbolCollection()
                                                throws java.io.IOException,
                                                       AutomationException

The substitute symbol collection when substituting the entire collection.

Specified by:

getSubstituteSymbolCollection in interface ISymbolSubstitution

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubstituteSymbolCollectionByRef

public void setSubstituteSymbolCollectionByRef(ISymbolCollection symbolCollection)
                                        throws java.io.IOException,
                                               AutomationException

The substitute symbol collection when substituting the entire collection.

Specified by:

setSubstituteSymbolCollectionByRef in interface ISymbolSubstitution

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubstituteType

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

The type of symbol substitution.

Specified by:

getSubstituteType in interface ISymbolSubstitution

Returns:

A com.esri.arcgis.carto.esriSymbolSubstituteType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubstituteType

public void setSubstituteType(int substituteType)
                       throws java.io.IOException,
                              AutomationException

The type of symbol substitution.

Specified by:

setSubstituteType in interface ISymbolSubstitution

Parameters:

substituteType - A com.esri.arcgis.carto.esriSymbolSubstituteType constant (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.

visibleFeatures

public void visibleFeatures(IQueryFilter filter)
                     throws java.io.IOException,
                            AutomationException

Updates query to include only visible features.

Specified by:

visibleFeatures in interface IInteractiveSearch

Parameters:

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

isDrawGeometry

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

Indicates if the annotation geometry will draw.

Specified by:

isDrawGeometry in interface IDrawAnnotationGeometry

Returns:

The pUseScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawGeometry

public void setDrawGeometry(boolean pUseScale)
                     throws java.io.IOException,
                            AutomationException

Indicates if the annotation geometry will draw.

Specified by:

setDrawGeometry in interface IDrawAnnotationGeometry

Parameters:

pUseScale - The pUseScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDrawGeometryLineSymbol

public ILineSymbol getDrawGeometryLineSymbol()
                                      throws java.io.IOException,
                                             AutomationException

The line symbol for drawing the geometry.

Specified by:

getDrawGeometryLineSymbol in interface IDrawAnnotationGeometry

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawGeometryLineSymbolByRef

public void setDrawGeometryLineSymbolByRef(ILineSymbol symbol)
                                    throws java.io.IOException,
                                           AutomationException

The line symbol for drawing the geometry.

Specified by:

setDrawGeometryLineSymbolByRef in interface IDrawAnnotationGeometry

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDrawGeometryMarkerSymbol

public IMarkerSymbol getDrawGeometryMarkerSymbol()
                                          throws java.io.IOException,
                                                 AutomationException

The marker symbol for drawing the geometry.

Specified by:

getDrawGeometryMarkerSymbol in interface IDrawAnnotationGeometry

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawGeometryMarkerSymbolByRef

public void setDrawGeometryMarkerSymbolByRef(IMarkerSymbol symbol)
                                      throws java.io.IOException,
                                             AutomationException

The marker symbol for drawing the geometry.

Specified by:

setDrawGeometryMarkerSymbolByRef in interface IDrawAnnotationGeometry

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (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.

doAddNullElement

public void doAddNullElement(int featureId)
                      throws java.io.IOException,
                             AutomationException

Adds a feature and its corresponding element to a graphics layer.

Specified by:

doAddNullElement in interface IFDOGraphicsLayer2

Parameters:

featureId - The featureId (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearPassword

public void clearPassword(boolean bForceReconnect)
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

clearPassword in interface ISecureLayer

Parameters:

bForceReconnect - The bForceReconnect (in)

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.

boundsUpdated

public void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Notifies clients when the bounds is updated.

Specified by:

boundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

visibleBoundsUpdated

public void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
                          throws java.io.IOException,
                                 AutomationException

Notifies clients when the visible bounds is updated.

Specified by:

visibleBoundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deviceFrameUpdated

public void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Notifies clients when the device frame is updated.

Specified by:

deviceFrameUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resolutionUpdated

public void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Notifies clients when the resolution is updated.

Specified by:

resolutionUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rotationUpdated

public void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Notifies clients when the rotation angle is updated.

Specified by:

rotationUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unitsUpdated

public void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Notifies clients when the units are updated.

Specified by:

unitsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

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.

isHTMLPopupEnabled

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

Indicates if this layer currently responds to the HTML Popup tool.

Specified by:

isHTMLPopupEnabled in interface IHTMLPopupIdentify

Specified by:

isHTMLPopupEnabled in interface IHTMLPopupInfo

Returns:

The pEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLPopupEnabled

public void setHTMLPopupEnabled(boolean pEnabled)
                         throws java.io.IOException,
                                AutomationException

Indicates if this layer currently responds to the HTML Popup tool.

Specified by:

setHTMLPopupEnabled in interface IHTMLPopupInfo

Parameters:

pEnabled - The pEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLPresentationStyle

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

Indicates the content formating style for the HTML Popup tool.

Specified by:

getHTMLPresentationStyle in interface IHTMLPopupIdentify

Specified by:

getHTMLPresentationStyle in interface IHTMLPopupInfo

Returns:

A com.esri.arcgis.carto.esriHTMLPopupStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLPresentationStyle

public void setHTMLPresentationStyle(int pStyle)
                              throws java.io.IOException,
                                     AutomationException

Indicates the content formating style for the HTML Popup tool.

Specified by:

setHTMLPresentationStyle in interface IHTMLPopupInfo

Parameters:

pStyle - A com.esri.arcgis.carto.esriHTMLPopupStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLHideFieldNameColumn

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

Indicates if Field name column will be output to the HTML Popup tool.

Specified by:

isHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Returns:

The pHide

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLHideFieldNameColumn

public void setHTMLHideFieldNameColumn(boolean pHide)
                                throws java.io.IOException,
                                       AutomationException

Indicates if Field name column will be output to the HTML Popup tool.

Specified by:

setHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Parameters:

pHide - The pHide (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectField

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

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Specified by:

getHTMLRedirectField in interface IHTMLPopupInfo

Returns:

The pField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectField

public void setHTMLRedirectField(java.lang.String pField)
                          throws java.io.IOException,
                                 AutomationException

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Specified by:

setHTMLRedirectField in interface IHTMLPopupInfo

Parameters:

pField - The pField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldPrefix

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

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Specified by:

getHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Returns:

The pPrefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldPrefix

public void setHTMLRedirectFieldPrefix(java.lang.String pPrefix)
                                throws java.io.IOException,
                                       AutomationException

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Specified by:

setHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Parameters:

pPrefix - The pPrefix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldSuffix

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

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Specified by:

getHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Returns:

The pSufix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldSuffix

public void setHTMLRedirectFieldSuffix(java.lang.String pSufix)
                                throws java.io.IOException,
                                       AutomationException

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Specified by:

setHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Parameters:

pSufix - The pSufix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLXSLStylesheet

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

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Specified by:

getHTMLXSLStylesheet in interface IHTMLPopupInfo

Returns:

The pStyleSheet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLXSLStylesheet

public void setHTMLXSLStylesheet(java.lang.String pStyleSheet)
                          throws java.io.IOException,
                                 AutomationException

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Specified by:

setHTMLXSLStylesheet in interface IHTMLPopupInfo

Parameters:

pStyleSheet - The pStyleSheet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLUseCodedDomainValues

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

Indicates whether to use coded values (rather than literal stored values) for feature values.

Specified by:

isHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Returns:

The pCodedValues

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLUseCodedDomainValues

public void setHTMLUseCodedDomainValues(boolean pCodedValues)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether to use coded values (rather than literal stored values) for feature values.

Specified by:

setHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Parameters:

pCodedValues - The pCodedValues (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLOutput

public java.lang.String getHTMLOutput(IFeature pFeature)
                               throws java.io.IOException,
                                      AutomationException

The content is the XML text for the input feature.

Specified by:

getHTMLOutput in interface IHTMLPopupInfo

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLDownloadAttachmentData

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

Indicates that all data for attachments will be retrieved.

Specified by:

isHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Returns:

The pDownloadAttachmentData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLDownloadAttachmentData

public void setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData)
                                   throws java.io.IOException,
                                          AutomationException

Indicates that all data for attachments will be retrieved.

Specified by:

setHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Parameters:

pDownloadAttachmentData - The pDownloadAttachmentData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLOutput

public java.lang.String hTMLOutput(IFeature pFeature,
                                   IPropertySet pOptions)
                            throws java.io.IOException,
                                   AutomationException

The content is the XML text for the input feature, pOptions is an optional parameter.

Specified by:

hTMLOutput in interface IHTMLPopupInfo2

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

pOptions - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLIdentify

public java.lang.String hTMLIdentify(IPoint pPoint,
                                     double tolerance)
                              throws java.io.IOException,
                                     AutomationException

The content is the XML text at the specified point.

Specified by:

hTMLIdentify in interface IHTMLPopupIdentify

Parameters:

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

tolerance - The tolerance (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLTipText

public java.lang.String hTMLTipText(IPoint pPoint,
                                    double tolerance)
                             throws java.io.IOException,
                                    AutomationException

The tooltip at the specified point.

Specified by:

hTMLTipText in interface IHTMLPopupIdentify

Parameters:

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

tolerance - The tolerance (in)

Returns:

The pTipText

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLIdentify

public void hTMLIdentify(IDisplay pDisplay,
                         IGeometry pGeometry,
                         IPropertySet pOptions,
                         IStringArray[] ppItemNames,
                         IStringArray[] ppItemHTML)
                  throws java.io.IOException,
                         AutomationException

The content is the XML text at the specified point. tempPath and refPath are optional parameters.

Specified by:

hTMLIdentify in interface IHTMLPopupIdentify2

Parameters:

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

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

pOptions - A reference to a com.esri.arcgis.system.IPropertySet (in)

ppItemNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppItemHTML - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExpressionProperties

public IDisplayExpressionProperties getExpressionProperties()
                                                     throws java.io.IOException,
                                                            AutomationException

Properties that describe the display expression.

Specified by:

getExpressionProperties in interface IDisplayString

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpressionPropertiesByRef

public void setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)
                                  throws java.io.IOException,
                                         AutomationException

Properties that describe the display expression.

Specified by:

setExpressionPropertiesByRef in interface IDisplayString

Parameters:

displayExpressionProperties - A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findDisplayString

public java.lang.String findDisplayString(IObject pObject)
                                   throws java.io.IOException,
                                          AutomationException

Finds the display string for the given feature based on the current expression properties.

Specified by:

findDisplayString in interface IDisplayString

Parameters:

pObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identifyEx

public IArray identifyEx(IDisplay pDisplay,
                         IGeometry pGeom,
                         ITrackCancel pTrackCancel)
                  throws java.io.IOException,
                         AutomationException

Identifies objects at the specified location for the given display.

Specified by:

identifyEx in interface IIdentifyDisplay

Parameters:

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

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

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldInfos

public IFieldInfoSet getFieldInfos()
                            throws java.io.IOException,
                                   AutomationException

The fields in order.

Specified by:

getFieldInfos in interface IOrderedLayerFields

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldOrder

public void setFieldOrder(IFieldInfoSet fieldInfoSet)
                   throws java.io.IOException,
                          AutomationException

A new order for the fields.

Specified by:

setFieldOrder in interface IOrderedLayerFields

Parameters:

fieldInfoSet - A reference to a com.esri.arcgis.carto.IFieldInfoSet (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

Specified by:

getTimeReference in interface ITimeTableDefinition

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

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

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

Specified by:

getFullTimeExtent in interface ITimeData

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasLiveData

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

isHasLiveData

Specified by:

isHasLiveData in interface ITimeData2

Returns:

The useTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHasLiveData

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

setHasLiveData

Specified by:

setHasLiveData in interface ITimeData2

Parameters:

useTime - The useTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.

prepareTimeQueryEx

public void prepareTimeQueryEx(ITimeValue pTimeValue,
                               int eTimeRelation,
                               IQueryFilter[] pFilter)
                        throws java.io.IOException,
                               AutomationException

Prepares an input query filter by appending the time expression into the where clause.

Specified by:

prepareTimeQueryEx in interface ITimeDisplayTable2

Parameters:

pTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

eTimeRelation - A com.esri.arcgis.system.esriTimeRelation constant (in)

pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareTimeQueryFromDisplay

public void prepareTimeQueryFromDisplay(IDisplay pDisplay,
                                        IQueryFilter[] pFilter)
                                 throws java.io.IOException,
                                        AutomationException

Prepares an input query filter by appending the time expression into the where clause.

Specified by:

prepareTimeQueryFromDisplay in interface ITimeDisplayTable2

Parameters:

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

pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareTimeQuery

public void prepareTimeQuery(ITimeValue pTimeValue,
                             IQueryFilter[] pFilter)
                      throws java.io.IOException,
                             AutomationException

Prepares an input query filter by appending the time expression into the where clause.

Specified by:

prepareTimeQuery in interface ITimeDisplayTable

Parameters:

pTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in/out: use single element array)

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

Specified by:

setTimeReferenceByRef in interface ITimeTableDefinition

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStartTimeFieldName

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

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

Specified by:

getStartTimeFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartTimeFieldName

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

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

Specified by:

setStartTimeFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

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

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

Specified by:

getEndTimeFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEndTimeFieldName

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

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

Specified by:

setEndTimeFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

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

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

Specified by:

getTimeValueFormat in interface ITimeTableDefinition

Returns:

The format

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeValueFormat

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

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

Specified by:

setTimeValueFormat in interface ITimeTableDefinition

Parameters:

format - The format (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

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

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

Specified by:

getTrackIDFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackIDFieldName

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

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

Specified by:

setTrackIDFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomTimeExtent

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

Custom time extent during which a layer is visible.

Specified by:

getCustomTimeExtent in interface ITimeTableDefinition

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomTimeExtentByRef

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

Custom time extent during which a layer is visible.

Specified by:

setCustomTimeExtentByRef in interface ITimeTableDefinition

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onCreateDataset

public void onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

This event is fired when a dataset is created.

Specified by:

onCreateDataset in interface IWorkspaceEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onRenameDataset

public void onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

This event is fired when a dataset is renamed.

Specified by:

onRenameDataset in interface IWorkspaceEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onDeleteDataset

public void onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

This event is fired when a dataset is deleted.

Specified by:

onDeleteDataset in interface IWorkspaceEvents

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