FeatureLayer (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class FeatureLayer

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

All Implemented Interfaces:: IAttributeTable, IDataLayer, IDataLayer2, IDisplayRelationshipClass, IDisplayString, IDisplayTable, IFeatureLayer, IFeatureLayer2, IFeatureLayerDefinition, IFeatureLayerDefinition2, IFeatureSelection, IFind, IGeoFeatureLayer, IHotlinkContainer, IHotlinkExpression, IHotlinkMacro, IHTMLPopupIdentify, IHTMLPopupIdentify2, IHTMLPopupInfo, IHTMLPopupInfo2, IHyperlinkContainer, IIdentify, IIdentify2, IIdentifyDisplay, ILayer, ILayer2, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerFields, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerSymbologyExtents, ILegendInfo, IOrderedLayerFields, IPublishLayer, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ISymbolLevels, ITableDefinition, ITableSelection, ITemporaryLayer, ITimeData, ITimeData2, ITimeDataDisplay, ITimeDimensionDefinition, ITimeDisplayTable, ITimeDisplayTable2, ITimeTableDefinition, IConnectionPointContainer, IDisplayAdmin, IDisplayFilterManager, IMapLevel, IClass, IDataset, IGeoDataset, IObjectClassSchemaEvents, ITable, ITableCapabilities, ITableFields, IWorkspaceEvents, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IPropertySupport, Externalizable, Serializable, EventListener

public class FeatureLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureLayer, IFeatureLayer2, IGeoFeatureLayer, ILayer, ILayer2, IFeatureSelection, IFeatureLayerDefinition, IFeatureLayerDefinition2, ITableDefinition, IGeoDataset, IPropertySupport, ILegendInfo, ILayerFields, IOrderedLayerFields, IDisplayString, ITableFields, IIdentify, IIdentify2, IDataLayer, IDataLayer2, ILayerDrawingProperties, ILayerInfo, IDisplayAdmin, IDisplayFilterManager, IHyperlinkContainer, IHotlinkContainer, IHotlinkMacro, IHotlinkExpression, ILayerEffects, ITable, IDataset, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ILayerExtensions, IDisplayTable, IObjectClassSchemaEvents, IDisplayRelationshipClass, IMapLevel, ISymbolLevels, IAttributeTable, IConnectionPointContainer, IFind, ILayerPosition, IPersistStream, ITableCapabilities, ITableSelection, IPublishLayer, ITemporaryLayer, ILayerGeneralProperties, ILayerSymbologyExtents, IHTMLPopupInfo, IHTMLPopupInfo2, IHTMLPopupIdentify, IHTMLPopupIdentify2, ITimeData, ITimeData2, ITimeTableDefinition, ITimeDataDisplay, ITimeDimensionDefinition, ITimeDisplayTable, ITimeDisplayTable2, IIdentifyDisplay, IWorkspaceEvents, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureLayer, IFeatureLayer2, IGeoFeatureLayer, ILayer, ILayer2, IFeatureSelection, IFeatureLayerDefinition, IFeatureLayerDefinition2, ITableDefinition, IGeoDataset, IPropertySupport, ILegendInfo, ILayerFields, IOrderedLayerFields, IDisplayString, ITableFields, IIdentify, IIdentify2, IDataLayer, IDataLayer2, ILayerDrawingProperties, ILayerInfo, IDisplayAdmin, IDisplayFilterManager, IHyperlinkContainer, IHotlinkContainer, IHotlinkMacro, IHotlinkExpression, ILayerEffects, ITable, IDataset, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ILayerExtensions, IDisplayTable, IObjectClassSchemaEvents, IDisplayRelationshipClass, IMapLevel, ISymbolLevels, IAttributeTable, IConnectionPointContainer, IFind, ILayerPosition, IPersistStream, ITableCapabilities, ITableSelection, IPublishLayer, ITemporaryLayer, ILayerGeneralProperties, ILayerSymbologyExtents, IHTMLPopupInfo, IHTMLPopupInfo2, IHTMLPopupIdentify, IHTMLPopupIdentify2, ITimeData, ITimeData2, ITimeTableDefinition, ITimeDataDisplay, ITimeDimensionDefinition, ITimeDisplayTable, ITimeDisplayTable2, IIdentifyDisplay, IWorkspaceEvents, Externalizable

A collection of features and their visual representation.

Remarks

A FeatureLayer is a layer based on vector geographic data which is typically a geodatabase, coverage, or shapefile feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:: Serialized Form

Constructor Summary
`FeatureLayer()` Constructs a FeatureLayer using ArcGIS Engine.
`FeatureLayer(Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `FeatureLayer theFeatureLayer = (FeatureLayer) obj;`

Method Summary
`void`	`add(IFeature feature)` Adds a feature to the selection set.
`void`	`addExtension(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`	`addIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)` addIDefinitionExpressionEventsListener.
`void`	`addIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)` addIFeatureLayerSelectionEventsListener.
`void`	`addILayerEventsListener(ILayerEvents theListener)` addILayerEventsListener.
`void`	`addIndex(IIndex index)` Adds an index to this object class.
`void`	`addRelationshipClass(IRelationshipClass relationshipClass)` Adds the specified memory relationship class to a standalone table or layer.
`void`	`addRow(IRow row)` Adds a row to the selection set (honoring the current combination method).
`boolean`	`applies(Object pUnk)` Indicates if the receiver can apply the given object at any given time.
`Object`	`apply(Object newObject)` Applies the given property to the receiver and returns the old object.
`boolean`	`canApply(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.
`boolean`	`connect(IName pOptRepairName)` Connects the layer to its data source.
`IDataset`	`copy(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(String layerName, boolean useCurrentSelection, String joinTableNames, String expression)` Creates a new feature layer from the existing layer based on the current selection and the specified query expression.
`void`	`delete()` Deletes this dataset.
`void`	`deleteField(IField field)` Deletes a field from this object class.
`void`	`deleteIndex(IIndex index)` Deletes an index from this object class.
`void`	`deleteSearchedRows(IQueryFilter queryFilter)` Delete the Rows in the database selected by the specified query.
`void`	`disconnect()` Disconnects the data from the layer.
`void`	`displayRelationshipClass(IRelationshipClass relClass, int joinType)` Sets a join based on the specified relationship class and join type.
`void`	`draw(int drawPhase, IDisplay display, ITrackCancel trackCancel)` Draws the layer to the specified display for the given draw phase.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` enumConnectionPoints
`boolean`	`equals(Object o)` Compare this object with another
`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(String search, boolean contains, Object fields, ITrackCancel trackCancel)` Finds the specified search string in the given attribute fields.
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`String`	`findDisplayString(IObject pObject)` Finds the display string for the given feature based on the current expression properties.
`int`	`findField(String fieldName)` Returns the index of the field with the specified name.
`IEnumRelationshipClass`	`findRelationshipClasses(IObjectClass objectClass, int role)` Finds all relationship classes in the collection that reference the given object class in the specified role.
`IAnnotateLayerPropertiesCollection`	`getAnnotationProperties()` Annotation properties.
`IUID`	`getAnnotationPropertiesID()` The UID used for annotation properties.
`IEnvelope`	`getAreaOfInterest()` The default area of interest for the layer.
`ITable`	`getAttributeTable()` The attribute table.
`short`	`getBrightness()` Layer brightness in percent (-100 - 100).
`String`	`getBrowseName()` The browse name of the dataset.
`double`	`getBufferDistance()` Buffer distance used for the selection.
`String`	`getCategory()` The category of the dataset.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static 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).
`Object`	`getCurrent(Object pUnk)` The object currently being used.
`ITimeExtent`	`getCustomTimeExtent()` Custom time extent during which a layer is visible.
`String`	`getDataDetails(String bsPadding)` Details of the layer's data.
`IName`	`getDataSourceName()` Name of the data object for the layer.
`String`	`getDataSourceType()` Data source type.
`String`	`getDefinitionExpression()` Definition query expression for the existing layer.
`ISelectionSet`	`getDefinitionSelectionSet()` The selection set that defines the subset of features in a selection layer.
`IFeatureClass`	`getDisplayFeatureClass()` Feature class used for display operations (may include joined fields).
`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.
`String`	`getEndTimeFieldName()` Name of the field that has end time for a row.
`IFeatureIDSet`	`getExclusionSet()` The set of features that are excluded from drawing.
`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.
`Object`	`getExtension()` The extension for this object class.
`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.
`String`	`getFindDisplayField()` The display field.
`Object`	`getFindFields()` The attribute fields.
`IName`	`getFullName()` The associated name object.
`ITimeExtent`	`getFullTimeExtent()` Returns the time extent for all the data in the layer.
`String`	`getHotlinkField()` Field used for hotlinks.
`int`	`getHotlinkType()` Hotlink type.
`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.
`String`	`getHTMLRedirectField()` Indicates the fieldname of the layer that contains the HTML redirect URL values.
`String`	`getHTMLRedirectFieldPrefix()` Indicates the text to precede the HTMLRedirectField value for the redirect URL.
`String`	`getHTMLRedirectFieldSuffix()` Indicates the text to follow the HTMLRedirectField value for the redirect URL.
`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.
`int`	`getJoinType()` Join type for the most recent join performed.
`int`	`getLargeImage()` Large image that represents the layer.
`int`	`getLargeSelectedImage()` Large image that represents the layer when it is selected.
`double`	`getLastMaximumScale()` Last maximum scale setting used by layer.
`double`	`getLastMinimumScale()` Last minimum scale setting used by layer.
`double`	`getLayerWeight()` Default layer position.
`ILegendGroup`	`getLegendGroup(int index)` Legend group at the specified index.
`int`	`getLegendGroupCount()` Number of legend groups contained by the object.
`ILegendItem`	`getLegendItem()` Optional.
`String`	`getMacroName()` Name of macro used for the hotlink.
`int`	`getMapLevel()` Current map level for drawing multi-level symbols.
`double`	`getMaximumScale()` Maximum scale (representative fraction) at which the layer will display.
`double`	`getMinimumScale()` Minimum scale (representative fraction) at which the layer will display.
`String`	`getName()` Layer name.
`String`	`getOIDFieldName()` The name of the field corresponding to the OID.
`IPropertySet`	`getPropertySet()` The set of properties for the dataset.
`String`	`getPublishingDescription()` The layer description reported to the publisher.
`IRelationshipClass`	`getRelationshipClass()` The current relationship class used to display related fields.
`IEnumRelationshipClass`	`getRelationshipClasses()` The memory relationship classes.
`String`	`getRelativeBase()` Base path used when storing relative path names.
`IFeatureRenderer`	`getRenderer()` Renderer used to draw the layer.
`IUID`	`getRendererPropertyPageClassID()` Class id of the property page for the renderer.
`IRow`	`getRow(int oID)` The row from the database with the specified object ID.
`ICursor`	`getRows(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.
`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.
`String`	`getStartTimeFieldName()` Name of the field that has start time for a row.
`IEnumDataset`	`getSubsets()` Datasets contained within this dataset.
`int`	`getSupportedDrawPhases()` Supported draw phases.
`String`	`getTimeDimensionFormat()` Returns the format of the dimension that represents time.
`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.
`String`	`getTimeValueFormat()` Time value format if the field name is of the string format.
`String`	`getTipText(double x, double y, double tolerance)` Map tip text at the specified location.
`String`	`getTrackIDFieldName()` Field that contains the rows that uniquely identifies the object whose time is being tracked.
`short`	`getTransparency()` Layer transparency in percent (0-100).
`int`	`getType()` The type of the Dataset.
`IWorkspace`	`getWorkspace()` The workspace containing this dataset.
`int`	`hashCode()` the hashcode for this object
`void`	`hTMLIdentify(IDisplay pDisplay, IGeometry pGeometry, IPropertySet pOptions, IStringArray[] ppItemNames, IStringArray[] ppItemHTML)` The content is the XML text at the specified point.
`String`	`hTMLIdentify(IPoint pPoint, double tolerance)` The content is the XML text at the specified point.
`String`	`hTMLOutput(IFeature pFeature, IPropertySet pOptions)` The content is the XML text for the input feature, pOptions is an optional parameter.
`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.
`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`	`isDisplayAnnotation()` Indicates if the layer displays annotation.
`boolean`	`isDrawingPropsDirty()` Indicates if the layer drawing properties are dirty.
`boolean`	`isHasLiveData()` isHasLiveData
`boolean`	`isHasOID()` Indicates if the class has an object identity (OID) field.
`boolean`	`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`	`isSymbolsAreGraduated()` Indicates if symbols are graduated.
`boolean`	`isTemporary()` Indicates if the layer is a temporary layer.
`boolean`	`isTimeDataCumulative()` Indicates that features will be animated cumilatively.
`boolean`	`isUsesFilter()` Indicates if the current object draws using a filter.
`boolean`	`isUseSymbolLevels()` Indicates if symbol levels are used for drawing.
`boolean`	`isUseTime()` Indicates whether to use the time for animation purposes.
`boolean`	`isValid()` Indicates if the layer is currently valid.
`boolean`	`isVisible()` Indicates if the layer is currently visible.
`ICursor`	`ITable_search(IQueryFilter queryFilter, boolean recycling)` An object cursor that can be used to fetch row objects selected by the specified query.
`void`	`load(IStream pstm)` load
`void`	`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`	`onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent)` This event is fired when a dataset is created.
`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`	`readExternal(ObjectInput in)`
`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`	`removeIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)` removeIDefinitionExpressionEventsListener.
`void`	`removeIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)` removeIFeatureLayerSelectionEventsListener.
`void`	`removeILayerEventsListener(ILayerEvents theListener)` removeILayerEventsListener.
`void`	`removeRelationshipClass(IRelationshipClass relationshipClass)` Removes the specified memory relationship class from a standalone table or layer.
`void`	`rename(String name)` Renames this Dataset.
`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.
`IFeatureCursor`	`searchDisplayFeatures(IQueryFilter queryFilter, boolean recycling)` Creates a cursor from the display feature class 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.
`ISelectionSet`	`selectDisplayTable(IQueryFilter pQueryFilter, int selType, int selOption, IWorkspace pSelWorkspace)` Creates a selection set from the display table based upon the search criteria.
`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.
`void`	`selectRows(IQueryFilter filter, int method, boolean justOne)` Selects rows based upon the specified criteria and combination method.
`void`	`setAnnotationProperties(IAnnotateLayerPropertiesCollection props)` Annotation properties.
`void`	`setAnnotationPropertiesIDByRef(IUID uid)` The UID used for annotation properties.
`void`	`setAreaOfInterest(IEnvelope aoi)` The default area of interest for the layer.
`void`	`setBrightness(short brightnessValue)` Layer brightness in percent (-100 - 100).
`void`	`setBrowseName(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`	`setCurrentMapLevel(int rhs1)` Current map level for drawing symbols.
`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(String text)` Data source type.
`void`	`setDefinitionExpression(String expression)` Definition query expression for the existing layer.
`void`	`setDisplayAnnotation(boolean value)` Indicates if the layer displays annotation.
`void`	`setDisplayField(String fieldName)` Primary display field.
`void`	`setDisplayFilter(IDisplayFilter displayFilter)` The display filter.
`void`	`setDrawingPropsDirty(boolean dirty)` Indicates if the layer drawing properties are dirty.
`void`	`setEndTimeFieldName(String fieldName)` Name of the field that has end time for a row.
`void`	`setExclusionSetByRef(IFeatureIDSet fIDs)` The set of features that are excluded from drawing.
`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(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(String pField)` Indicates the fieldname of the layer that contains the HTML redirect URL values.
`void`	`setHTMLRedirectFieldPrefix(String pPrefix)` Indicates the text to precede the HTMLRedirectField value for the redirect URL.
`void`	`setHTMLRedirectFieldSuffix(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(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`	`setLayerDescription(String text)` Description for the layer.
`void`	`setLayerWeight(double layerWeight)` Default layer position.
`void`	`setMacroName(String name)` Name of macro used for the hotlink.
`void`	`setMapLevel(int mapLevel)` Current map level for drawing multi-level symbols.
`void`	`setMaximumScale(double maxScale)` Maximum scale (representative fraction) at which the layer will display.
`void`	`setMinimumScale(double minScale)` Minimum scale (representative fraction) at which the layer will display.
`void`	`setName(String name)` Layer name.
`void`	`setRelationshipClassByRef(IRelationshipClass relClass)` The current relationship class used to display related fields.
`void`	`setRelativeBase(String basePath)` Base path used when storing relative path names.
`void`	`setRendererByRef(IFeatureRenderer renderer)` Renderer used to draw the layer.
`void`	`setRendererPropertyPageClassID(IUID clsid)` Class id of the property page for the renderer.
`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(String fieldName)` Name of the field that has start time for a row.
`void`	`setSupportsInteractive(boolean supported)` Indicates if the layer supports interactive effects changes.
`void`	`setSymbolsAreGraduated(boolean symbolsAreGraduated)` Indicates if symbols are graduated.
`void`	`setTemporary(boolean temporary)` Indicates if the layer is a temporary layer.
`void`	`setTimeDataCumulative(boolean cumilative)` Indicates that features will be animated cumilatively.
`void`	`setTimeDimensionFormat(String format)` Returns the format of the dimension that represents time.
`void`	`setTimeDimensionName(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(String format)` Time value format if the field name is of the string format.
`void`	`setTrackIDFieldName(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`	`setUseSymbolLevels(boolean useSymbolLevels)` Indicates if symbol levels are used for drawing.
`void`	`setUseTime(boolean useTime)` Indicates whether to use the time for animation purposes.
`void`	`setVisible(boolean visible)` Indicates if the layer is currently visible.
`ICursor`	`update(IQueryFilter queryFilter, boolean recycling)` Returns a cursor that can be used to update Rows selected by the specified query.
`void`	`updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer)` Update the Rows in the database selected by the specified query.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

FeatureLayer

public FeatureLayer()
             throws IOException,
                    UnknownHostException

Constructs a FeatureLayer using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

FeatureLayer

public FeatureLayer(Object obj)
             throws IOException

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

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

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

addILayerEventsListener

public void addILayerEventsListener(ILayerEvents theListener)
                             throws IOException

addILayerEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
Throws:: IOException - If there are communications problems.

removeILayerEventsListener

public void removeILayerEventsListener(ILayerEvents theListener)
                                throws IOException

removeILayerEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
Throws:: IOException - If there are communications problems.

addIFeatureLayerSelectionEventsListener

public void addIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
                                             throws IOException

addIFeatureLayerSelectionEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IFeatureLayerSelectionEvents interface.
Throws:: IOException - If there are communications problems.

removeIFeatureLayerSelectionEventsListener

public void removeIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
                                                throws IOException

removeIFeatureLayerSelectionEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IFeatureLayerSelectionEvents interface.
Throws:: IOException - If there are communications problems.

addIDefinitionExpressionEventsListener

public void addIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)
                                            throws IOException

addIDefinitionExpressionEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IDefinitionExpressionEvents interface.
Throws:: IOException - If there are communications problems.

removeIDefinitionExpressionEventsListener

public void removeIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)
                                               throws IOException

removeIDefinitionExpressionEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IDefinitionExpressionEvents interface.
Throws:: IOException - If there are communications problems.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException

The layer's feature class.

Description

The FeatureClass data source for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFeatureClass in interface IFeatureLayer
Specified by:: getFeatureClass in interface IFeatureLayer2

Returns:: A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass fclass)
                          throws IOException,
                                 AutomationException

The layer's feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDataSourceType

public String getDataSourceType()
                         throws IOException,
                                AutomationException

Data source type.

Description

Describes the type of data referenced by the feature layer. In ArcMap and ArcCatalog, this description appears on the layer's properties dialog on the Source tab after "Data Type:"

Remarks

By default, the DataSourceType for a layer matches the value returned by IDataset::Category when you access the layer's feature class through IDataset. You can set a layer's DataSourceType to any string.

Here is a list of default values for DataSourceType for common feature layer types:

Layer Type	Value
Personal Geodatabase	"Personal Geodatabase Feature Class"
SDE	"SDE Feature Class"
Shapefile	"Shapefile Feature Class"
ArcGIS for Desktop Advanced or PC ArcInfo Coverage (annotation)	"Annotation Feature Class"
ArcGIS for Desktop Advanced or PC ArcInfo Coverage (point)	"Point Feature Class"
ArcGIS for Desktop Advanced or PC ArcInfo Coverage (line)	"Arc Feature Class"
ArcGIS for Desktop Advanced or PC ArcInfo Coverage (polygon)	"Polygon Feature Class"
Edge	"StreetMap Feature Class"
CAD (annotation)	"CAD Annotation Feature Class"
CAD (point)	"CAD Point Feature Class"
CAD (line)	"CAD Polyline Feature Class"
CAD (polygon)	"CAD Polygon Feature Class"

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDataSourceType in interface IFeatureLayer
Specified by:: getDataSourceType in interface IFeatureLayer2

Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDataSourceType

public void setDataSourceType(String text)
                       throws IOException,
                              AutomationException

Data source type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDataSourceType in interface IFeatureLayer
Specified by:: setDataSourceType in interface IFeatureLayer2

Parameters:: text - The text (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplayField

public String getDisplayField()
                       throws IOException,
                              AutomationException

Primary display field.

Description

The name of the layer's primary display field.

Remarks

Usually this field name contains the string "name", or is the first string field found in the layer's attributes. This field is used to show map tips for the layer. The value of this property must match the name of one of the fields in the layer's FeatureClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplayField in interface IFeatureLayer
Specified by:: getDisplayField in interface IFeatureLayer2

Returns:: The fieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDisplayField

public void setDisplayField(String fieldName)
                     throws IOException,
                            AutomationException

Primary display field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDisplayField in interface IFeatureLayer
Specified by:: setDisplayField in interface IFeatureLayer2

Parameters:: fieldName - The fieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSelectable

public boolean isSelectable()
                     throws IOException,
                            AutomationException

Indicates if layer is selectable.

Description

Indicates whether the layer's features are selectable.

Remarks

The default value for Selectable is False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSelectable in interface IFeatureLayer
Specified by:: isSelectable in interface IFeatureLayer2

Returns:: The value
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSelectable

public void setSelectable(boolean value)
                   throws IOException,
                          AutomationException

Indicates if layer is selectable.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSelectable in interface IFeatureLayer
Specified by:: setSelectable in interface IFeatureLayer2

Parameters:: value - The value (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

search

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

Creates a cursor based upon the search criteria.

Description

Use this method to return a read-only cursor of the layer's features.

Remarks

If there is a definition query set on the layer, the Search method will automatically work on the subset of features in the layer that meet the definition criteria. You specify an additional query that will be applied after the layer's definition query by passing valid IQueryFilter object for the QueryFilter parameter.

This Search method will not work on joined fields. If the FeatureLayer has any joins, you should use the IGeoFeatureLayer::SearchDisplayFeatures method instead.

You cannot use the cursor returned by IFeatureLayer::Search to update features, instead use IFeatureClass::Update.

Recycling specifies whether the resulting feature cursor will be recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor. See the topic for IFeatureClass::Search for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

public boolean isScaleSymbols()
                       throws IOException,
                              AutomationException

Indicates if symbols are scaled for the layer.

Description

Indicates whether the symbols for this layer will respect the reference scale of the map containing the layer. Set this property to True for your layer and set a map reference scale to have your layer symbology scale as you zoom in and out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isScaleSymbols in interface IFeatureLayer
Specified by:: isScaleSymbols in interface IFeatureLayer2

Returns:: The scale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws IOException,
                            AutomationException

Indicates if symbols are scaled for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScaleSymbols in interface IFeatureLayer
Specified by:: setScaleSymbols in interface IFeatureLayer2

Parameters:: scale - The scale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Layer name.

Description

Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getName in interface ILayer
Specified by:: getName in interface ILayer2
Specified by:: getName in interface IDataset

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Layer name.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setName in interface ILayer
Specified by:: setName in interface ILayer2

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the layer is currently valid.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isValid in interface ILayer
Specified by:: isValid in interface ILayer2

Returns:: The valid
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAreaOfInterest in interface ILayer
Specified by:: getAreaOfInterest in interface ILayer2

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMinimumScale in interface ILayer
Specified by:: getMinimumScale in interface ILayer2

Returns:: The minScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws IOException,
                            AutomationException

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMinimumScale in interface ILayer
Specified by:: setMinimumScale in interface ILayer2

Parameters:: minScale - The minScale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMaximumScale in interface ILayer
Specified by:: getMaximumScale in interface ILayer2

Returns:: The maxScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws IOException,
                            AutomationException

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMaximumScale in interface ILayer
Specified by:: setMaximumScale in interface ILayer2

Parameters:: maxScale - The maxScale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isVisible in interface ILayer
Specified by:: isVisible in interface ILayer2

Returns:: The visible
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the layer is currently visible.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setVisible in interface ILayer
Specified by:: setVisible in interface ILayer2

Parameters:: visible - The visible (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowTips

public boolean isShowTips()
                   throws IOException,
                          AutomationException

Indicates if the layer shows map tips.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowTips in interface ILayer
Specified by:: isShowTips in interface ILayer2

Returns:: The show
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws IOException,
                        AutomationException

Indicates if the layer shows map tips.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowTips in interface ILayer
Specified by:: setShowTips in interface ILayer2

Parameters:: show - The show (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTipText

public String getTipText(double x,
                         double y,
                         double tolerance)
                  throws IOException,
                         AutomationException

Map tip text at the specified location.

Product Availability

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

Specified by:: getTipText in interface ILayer
Specified by:: getTipText in interface ILayer2

Parameters:: x - The x (in); y - The y (in); tolerance - The tolerance (in)
Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws IOException,
                        AutomationException

Indicates if the layer needs its own display cache.

Remarks

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCached in interface ILayer
Specified by:: isCached in interface ILayer2

Returns:: The cached
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Description

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

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCached in interface ILayer
Specified by:: setCached in interface ILayer2

Parameters:: cached - The cached (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws IOException,
                                  AutomationException

Supported draw phases.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSupportedDrawPhases in interface ILayer
Specified by:: getSupportedDrawPhases in interface ILayer2

Returns:: The drawPhases
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException

Spatial reference for the layer.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSpatialReferenceByRef in interface ILayer
Specified by:: setSpatialReferenceByRef in interface ILayer2

Parameters:: rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

draw

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

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: draw in interface ILayer
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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getShapeType

public int getShapeType()
                 throws IOException,
                        AutomationException

The layer's shape type.

Remarks

Returns the basic geometry type of the layer's underlying feature class. See IFeatureClass::ShapeType for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getShapeType in interface IFeatureLayer2

Returns:: A com.esri.arcgis.geometry.esriGeometryType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRenderer

public IFeatureRenderer getRenderer()
                             throws IOException,
                                    AutomationException

Renderer used to draw the layer.

Description

Specifies the layer's feature renderer object which determines how a layer draws.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRenderer in interface IGeoFeatureLayer

Returns:: A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRendererByRef

public void setRendererByRef(IFeatureRenderer renderer)
                      throws IOException,
                             AutomationException

Renderer used to draw the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setRendererByRef in interface IGeoFeatureLayer

Parameters:: renderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRendererPropertyPageClassID

public IUID getRendererPropertyPageClassID()
                                    throws IOException,
                                           AutomationException

Class id of the property page for the renderer.

Description

The classID of the renderer property page that is used to edit the renderer of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRendererPropertyPageClassID in interface IGeoFeatureLayer

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRendererPropertyPageClassID

public void setRendererPropertyPageClassID(IUID clsid)
                                    throws IOException,
                                           AutomationException

Class id of the property page for the renderer.

Description

RendererPropertyPageClassID is the classID of the render property page that is associated with the render of a IGeoFeatureLayer

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setRendererPropertyPageClassID in interface IGeoFeatureLayer

Parameters:: clsid - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDisplayAnnotation

public boolean isDisplayAnnotation()
                            throws IOException,
                                   AutomationException

Indicates if the layer displays annotation.

Description

Indicates whether dynamic labeling is on for the layer. Use this property to see if labeling is on for a layer, or to toggle labeling on or off.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDisplayAnnotation in interface IGeoFeatureLayer

Returns:: The value
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDisplayAnnotation

public void setDisplayAnnotation(boolean value)
                          throws IOException,
                                 AutomationException

Indicates if the layer displays annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDisplayAnnotation in interface IGeoFeatureLayer

Parameters:: value - The value (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAnnotationPropertiesID

public IUID getAnnotationPropertiesID()
                               throws IOException,
                                      AutomationException

The UID used for annotation properties.

Description

Indicates the CLSID of the labeling properties used to label the layer.

Remarks

ArcGIS provides two engines that can be used for labeling, the ESRI Standard Labeling Engine and the ESRI Maplex Labeling Engine.

You can use AnnotationPropertiesID determine which engine is being used by the layer to label features.

ESRI Standard Labeling Engine: GUID for LabelEngineLayerProperties = "{01004145-0D1C-11D2-A26F-080009B6F22B}"
ESRI Maplex Labeling Engine: GUID for MaplexLabelEngineLayerProperties = "{20664808-0D1C-11D2-A26F-080009B6F22B}"

You should not set this property. The labeling engine set for the map controls how each layer in the map will be labeled. To set this use IMap::AnnotationEngine. When the label engine is changed, the label properties of the all layers in the map will automatically be changed to properties of the new label engine.

If have a standalone layer that is not in a map, you can translate the properties to the other label engine by using IAnnotationPropertiesConverter on the coclass MaplexAnnotationPropertiesConverter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAnnotationPropertiesID in interface IGeoFeatureLayer

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAnnotationPropertiesIDByRef

public void setAnnotationPropertiesIDByRef(IUID uid)
                                    throws IOException,
                                           AutomationException

The UID used for annotation properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAnnotationPropertiesIDByRef in interface IGeoFeatureLayer

Parameters:: uid - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAnnotationProperties

public IAnnotateLayerPropertiesCollection getAnnotationProperties()
                                                           throws IOException,
                                                                  AutomationException

Annotation properties.

Description

Provides access to the labeling properites for the layer.

Remarks

A feature layer's labeling properties are accessed via this property which returns a collection. Each item in the collection is an IAnnotateLayerProperties object that represents a label class. To learn more, see IAnnotateLayerProperties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAnnotationProperties in interface IGeoFeatureLayer

Returns:: A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAnnotationProperties

public void setAnnotationProperties(IAnnotateLayerPropertiesCollection props)
                             throws IOException,
                                    AutomationException

Annotation properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAnnotationProperties in interface IGeoFeatureLayer

Parameters:: props - A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCurrentMapLevel

public void setCurrentMapLevel(int rhs1)
                        throws IOException,
                               AutomationException

Current map level for drawing symbols.

Remarks

When symbol level drawing is used, this property is used by the framework to communicate to a layer what the current symbol level being drawn is. Priori to ArcGIS 9.0 this was the only method by which this could be communicated to a layer. At ArcGIS 9.0 and later versions, IMapLevel::MapLevel can be used for this. IMapLevel is implemented by more layers than IGeoFeatureLayer, so a layer that does not participate in symbol level drawing, for example a RasterLayer, can still know the current symbol level.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCurrentMapLevel in interface IGeoFeatureLayer

Parameters:: rhs1 - The rhs1 (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExclusionSet

public IFeatureIDSet getExclusionSet()
                              throws IOException,
                                     AutomationException

The set of features that are excluded from drawing.

Description

Provides access to the set of features that are exluded from drawing for a layer. In ArcMap, features are added to this set when you convert features to graphics, and you can resume drawing these features, thereby removing them from the ExclusionSet, by using the Layer Properties dialog's Display tab.

When you use IDataExclusion to exclude features from drawing for a feature renderer, the excluded features will not show up in the layer's ExclusionSet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExclusionSet in interface IGeoFeatureLayer

Returns:: A reference to a com.esri.arcgis.carto.IFeatureIDSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setExclusionSetByRef

public void setExclusionSetByRef(IFeatureIDSet fIDs)
                          throws IOException,
                                 AutomationException

The set of features that are excluded from drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setExclusionSetByRef in interface IGeoFeatureLayer

Parameters:: fIDs - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplayFeatureClass

public IFeatureClass getDisplayFeatureClass()
                                     throws IOException,
                                            AutomationException

Feature class used for display operations (may include joined fields).

Description

Provides access to an IFeatureClass object that contains joined fields if present on the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplayFeatureClass in interface IGeoFeatureLayer

Returns:: A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

searchDisplayFeatures

public IFeatureCursor searchDisplayFeatures(IQueryFilter queryFilter,
                                            boolean recycling)
                                     throws IOException,
                                            AutomationException

Creates a cursor from the display feature class based upon the search criteria.

Remarks

SearchDisplayFeatures works like IFeatureLayer::Search with the added behavior that it will work on joined fields if you qualify field names. For example, if you want to search a field called "Pop1990" from a joined table called "Demog", you should used "Demog.Pop1990" for the field name in the query filter used in the search method.

The IDisplayTable::SearchDisplayTable method is a similar search method which will work on feature layers as well as other types of layers and standalone tables. If you want your code to be generic enough to work on different types of layers, you should use IDisplayTable::SearchDisplayTable.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: searchDisplayFeatures in interface IGeoFeatureLayer

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws IOException,
                                    AutomationException

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

Remarks

Some layer types do not support a writeable MinimumScale or MaximumScale. Use this property to determine whether or not a layer supports this.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isScaleRangeReadOnly in interface ILayer2

Returns:: The flag
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws IOException,
                              AutomationException

The default area of interest for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAreaOfInterest in interface ILayer2

Parameters:: aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException

The selected set of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectionSet in interface IFeatureSelection
Specified by:: getSelectionSet in interface ITableSelection

Returns:: A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet selectionSet)
                          throws IOException,
                                 AutomationException

The selected set of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCombinationMethod

public int getCombinationMethod()
                         throws IOException,
                                AutomationException

Combination method for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCombinationMethod in interface IFeatureSelection

Returns:: A com.esri.arcgis.carto.esriSelectionResultEnum constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCombinationMethod

public void setCombinationMethod(int method)
                          throws IOException,
                                 AutomationException

Combination method for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCombinationMethod in interface IFeatureSelection

Parameters:: method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBufferDistance

public double getBufferDistance()
                         throws IOException,
                                AutomationException

Buffer distance used for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBufferDistance in interface IFeatureSelection

Returns:: The distance
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBufferDistance

public void setBufferDistance(double distance)
                       throws IOException,
                              AutomationException

Buffer distance used for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBufferDistance in interface IFeatureSelection

Parameters:: distance - The distance (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSetSelectionSymbol

public boolean isSetSelectionSymbol()
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSetSelectionSymbol in interface IFeatureSelection

Returns:: The setSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSetSelectionSymbol

public void setSetSelectionSymbol(boolean setSymbol)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSetSelectionSymbol in interface IFeatureSelection

Parameters:: setSymbol - The setSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectionColor

public IColor getSelectionColor()
                         throws IOException,
                                AutomationException

Selection color. (used when SetSelectionSymbol = FALSE).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectionColor in interface IFeatureSelection

Returns:: A reference to a com.esri.arcgis.display.IColor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSelectionColorByRef

public void setSelectionColorByRef(IColor color)
                            throws IOException,
                                   AutomationException

Selection color. (used when SetSelectionSymbol = FALSE).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSelectionColorByRef in interface IFeatureSelection

Parameters:: color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectionSymbol

public ISymbol getSelectionSymbol()
                           throws IOException,
                                  AutomationException

Selection symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectionSymbol in interface IFeatureSelection

Returns:: A reference to a com.esri.arcgis.display.ISymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSelectionSymbolByRef

public void setSelectionSymbolByRef(ISymbol symbol)
                             throws IOException,
                                    AutomationException

Selection symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSelectionSymbolByRef in interface IFeatureSelection

Parameters:: symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

add

public void add(IFeature feature)
         throws IOException,
                AutomationException

Adds a feature to the selection set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: add in interface IFeatureSelection

Parameters:: feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Throws:: 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 IOException,
                           AutomationException

Selects features based upon the specifed criteria and combination method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Clears the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clear in interface IFeatureSelection
Specified by:: clear in interface ITableSelection

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged()
                      throws IOException,
                             AutomationException

Fires the features layer update event. Required when SelectionSet changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectionChanged in interface IFeatureSelection
Specified by:: selectionChanged in interface ITableSelection

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

public String getDefinitionExpression()
                               throws IOException,
                                      AutomationException

Definition query expression for the existing layer.

Description

Use the DefinitionExpression property to read or set the definition query for an existing layer just like you would in the Definition Query tab of the layer's properties dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDefinitionExpression in interface IFeatureLayerDefinition
Specified by:: getDefinitionExpression in interface IFeatureLayerDefinition2
Specified by:: getDefinitionExpression in interface ITableDefinition

Returns:: The expression
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

public void setDefinitionExpression(String expression)
                             throws IOException,
                                    AutomationException

Definition query expression for the existing layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefinitionExpression in interface IFeatureLayerDefinition
Specified by:: setDefinitionExpression in interface IFeatureLayerDefinition2
Specified by:: setDefinitionExpression in interface ITableDefinition

Parameters:: expression - The expression (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDefinitionSelectionSet

public ISelectionSet getDefinitionSelectionSet()
                                        throws IOException,
                                               AutomationException

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

Remarks

You can use the DefintionSelectionSet property to get the selection set that was used to define the new layer created by the IFeatureLayerDefintion::CreateSelectionLayer method. Note, before calling CreateSelectionLayer, the selection set returned by DefintionSelectionSet will be Nothing. Therefore, you can only use this property after you have called the CreateSelectionLayer method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createSelectionLayer

public IFeatureLayer createSelectionLayer(String layerName,
                                          boolean useCurrentSelection,
                                          String joinTableNames,
                                          String expression)
                                   throws IOException,
                                          AutomationException

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

Description

CreateSelectionLayer creates a new FeatureLayer from an existing FeatureLayer.

LayerName defines the new layer's name.

Set useCurrentSelection = TRUE here if you want to use the currently selected features on the existing layer.

joinTableNames may contain the name of related table(s) separated by commas. The existing join(s) will then be passed on to the new layer.

The DefinitionExpression parameter can be used to set a definition expression on the newly created layer but currently this will be defined at the feature class rather than at the layer level and will not show up in the UI. If you want to set a definition query on the newly created layer, it is best to use IFeatureLayerDefinition again to set the definition query after the layer has been created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRelationshipClass

public IRelationshipClass getRelationshipClass()
                                        throws IOException,
                                               AutomationException

The current relationship class used to display related fields.

Remarks

RelClass must be a defined relationship class on the base feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRelationshipClassByRef

public void setRelationshipClassByRef(IRelationshipClass relClass)
                               throws IOException,
                                      AutomationException

The current relationship class used to display related fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSearchOrder

public int getSearchOrder()
                   throws IOException,
                          AutomationException

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

Product Availability

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

Specified by:: getSearchOrder in interface IFeatureLayerDefinition2

Returns:: A com.esri.arcgis.geodatabase.esriSearchOrder constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSearchOrder

public void setSearchOrder(int order)
                    throws IOException,
                           AutomationException

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

Product Availability

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

Specified by:: setSearchOrder in interface IFeatureLayerDefinition2

Parameters:: order - A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpatialReference in interface IGeoDataset

Returns:: A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

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

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

The red box represents the IGeoDataset extent

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.

The red box represents the IGeoDataset extent after some of the features have been deleted

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.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtent in interface IGeoDataset

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

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

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: applies in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The applies
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

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

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canApply in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The canApply
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

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

Specified by:: getCurrent in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

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

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: apply in interface IPropertySupport

Parameters:: newObject - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws IOException,
                               AutomationException

Number of legend groups contained by the object.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLegendGroupCount in interface ILegendInfo

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

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

Specified by:: getLegendGroup in interface ILegendInfo

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.ILegendGroup
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws IOException,
                                 AutomationException

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLegendItem in interface ILegendInfo

Returns:: A reference to a com.esri.arcgis.carto.ILegendItem
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws IOException,
                                     AutomationException

Indicates if symbols are graduated.

Description

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

Remarks

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSymbolsAreGraduated in interface ILegendInfo

Returns:: The symbolsAreGraduated
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSymbolsAreGraduated in interface ILegendInfo

Parameters:: symbolsAreGraduated - The symbolsAreGraduated (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFieldCount

public int getFieldCount()
                  throws IOException,
                         AutomationException

The number of fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFieldCount in interface ILayerFields
Specified by:: getFieldCount in interface ITableFields

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getField

public IField getField(int index)
                throws IOException,
                       AutomationException

The field at the specified index.

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFieldInfo

public IFieldInfo getFieldInfo(int index)
                        throws IOException,
                               AutomationException

Extended field information for the field at the specified index.

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findField

public int findField(String fieldName)
              throws IOException,
                     AutomationException

Returns the index of the field with the specified name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFieldInfos

public IFieldInfoSet getFieldInfos()
                            throws IOException,
                                   AutomationException

The fields in order.

Product Availability

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

Specified by:: getFieldInfos in interface IOrderedLayerFields

Returns:: A reference to a com.esri.arcgis.carto.IFieldInfoSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setFieldOrder

public void setFieldOrder(IFieldInfoSet fieldInfoSet)
                   throws IOException,
                          AutomationException

A new order for the fields.

Product Availability

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

Specified by:: setFieldOrder in interface IOrderedLayerFields

Parameters:: fieldInfoSet - A reference to a com.esri.arcgis.carto.IFieldInfoSet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExpressionProperties

public IDisplayExpressionProperties getExpressionProperties()
                                                     throws IOException,
                                                            AutomationException

Properties that describe the display expression.

Product Availability

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

Specified by:: getExpressionProperties in interface IDisplayString

Returns:: A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setExpressionPropertiesByRef

public void setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)
                                  throws IOException,
                                         AutomationException

Properties that describe the display expression.

Product Availability

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

Specified by:: setExpressionPropertiesByRef in interface IDisplayString

Parameters:: displayExpressionProperties - A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findDisplayString

public String findDisplayString(IObject pObject)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Specified by:: findDisplayString in interface IDisplayString

Parameters:: pObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)
Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: identify in interface IIdentify

Parameters:: pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

identify

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

Identifies objects at the specified location.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: identify in interface IIdentify2

Parameters:: pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in); pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(double rhs1)
              throws IOException,
                     AutomationException

The current scale of the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScale in interface IIdentify2

Parameters:: rhs1 - The rhs1 (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDataSourceName

public IName getDataSourceName()
                        throws IOException,
                               AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDataSourceName in interface IDataLayer
Specified by:: getDataSourceName in interface IDataLayer2

Returns:: A reference to a com.esri.arcgis.system.IName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws IOException,
                              AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDataSourceName in interface IDataLayer
Specified by:: setDataSourceName in interface IDataLayer2

Parameters:: name - A reference to a com.esri.arcgis.system.IName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Specified by:: isDataSourceSupported in interface IDataLayer
Specified by:: isDataSourceSupported in interface IDataLayer2

Parameters:: name - A reference to a com.esri.arcgis.system.IName (in)
Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws IOException,
                       AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: connect in interface IDataLayer
Specified by:: connect in interface IDataLayer2

Parameters:: pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)
Returns:: The succeeded
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public String getRelativeBase()
                       throws IOException,
                              AutomationException

Base path used when storing relative path names.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRelativeBase in interface IDataLayer
Specified by:: getRelativeBase in interface IDataLayer2

Returns:: The basePath
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(String basePath)
                     throws IOException,
                            AutomationException

Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setRelativeBase in interface IDataLayer
Specified by:: setRelativeBase in interface IDataLayer2

Parameters:: basePath - The basePath (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException

Disconnects the data from the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: disconnect in interface IDataLayer2

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws IOException,
                           AutomationException

Returns TRUE if the layer is in the specified workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: inWorkspace in interface IDataLayer2

Parameters:: workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: The inWorkspace
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws IOException,
                                   AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDrawingPropsDirty in interface ILayerDrawingProperties

Returns:: The dirty
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws IOException,
                                 AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDrawingPropsDirty in interface ILayerDrawingProperties

Parameters:: dirty - The dirty (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException

Small image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSmallImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws IOException,
                                 AutomationException

Small image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSmallSelectedImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException

Large image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLargeImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws IOException,
                                 AutomationException

Large image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLargeSelectedImage in interface ILayerInfo

Returns:: The hBitmap (A COM typedef)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException

Indicates if the current object draws using a filter.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUsesFilter in interface IDisplayAdmin

Returns:: The usesFilter
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDisplayFilter

public void setDisplayFilter(IDisplayFilter displayFilter)
                      throws IOException,
                             AutomationException

The display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDisplayFilter in interface IDisplayFilterManager

Parameters:: displayFilter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplayFilter

public IDisplayFilter getDisplayFilter()
                                throws IOException,
                                       AutomationException

The display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplayFilter in interface IDisplayFilterManager

Returns:: A reference to a com.esri.arcgis.display.IDisplayFilter
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHyperlinkCount

public int getHyperlinkCount()
                      throws IOException,
                             AutomationException

Number of hyperlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHyperlinkCount in interface IHyperlinkContainer

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHyperlink

public IHyperlink getHyperlink(int index)
                        throws IOException,
                               AutomationException

The hyperlink at the specified index.

Product Availability

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

Specified by:: getHyperlink in interface IHyperlinkContainer

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.IHyperlink
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHyperlinkByRef

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

The hyperlink at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHyperlinkByRef in interface IHyperlinkContainer

Parameters:: index - The index (in); link - A reference to a com.esri.arcgis.carto.IHyperlink (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addHyperlink

public void addHyperlink(IHyperlink link)
                  throws IOException,
                         AutomationException

Adds a hyperlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addHyperlink in interface IHyperlinkContainer

Parameters:: link - A reference to a com.esri.arcgis.carto.IHyperlink (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeHyperlink

public void removeHyperlink(int index)
                     throws IOException,
                            AutomationException

Removes the hyperlink at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeHyperlink in interface IHyperlinkContainer

Parameters:: index - The index (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHotlinkField

public String getHotlinkField()
                       throws IOException,
                              AutomationException

Field used for hotlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHotlinkField in interface IHotlinkContainer

Returns:: The fieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHotlinkField

public void setHotlinkField(String fieldName)
                     throws IOException,
                            AutomationException

Field used for hotlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHotlinkField in interface IHotlinkContainer

Parameters:: fieldName - The fieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHotlinkType

public int getHotlinkType()
                   throws IOException,
                          AutomationException

Hotlink type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHotlinkType in interface IHotlinkContainer

Returns:: A com.esri.arcgis.carto.esriHyperlinkType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHotlinkType

public void setHotlinkType(int linkType)
                    throws IOException,
                           AutomationException

Hotlink type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHotlinkType in interface IHotlinkContainer

Parameters:: linkType - A com.esri.arcgis.carto.esriHyperlinkType constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMacroName

public String getMacroName()
                    throws IOException,
                           AutomationException

Name of macro used for the hotlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMacroName in interface IHotlinkMacro

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMacroName

public void setMacroName(String name)
                  throws IOException,
                         AutomationException

Name of macro used for the hotlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMacroName in interface IHotlinkMacro

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

IHotlinkExpression_getExpressionProperties

public IHotLinkExpressionProperties IHotlinkExpression_getExpressionProperties()
                                                                        throws IOException,
                                                                               AutomationException

Properties that describe the hyperlink expression.

Product Availability

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

Specified by:: IHotlinkExpression_getExpressionProperties in interface IHotlinkExpression

Returns:: A reference to a com.esri.arcgis.carto.IHotLinkExpressionProperties
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setExpressionPropertiesByRef

public void setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties)
                                  throws IOException,
                                         AutomationException

Properties that describe the hyperlink expression.

Product Availability

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

Specified by:: setExpressionPropertiesByRef in interface IHotlinkExpression

Parameters:: ppHotLinkExpressionProperties - A reference to a com.esri.arcgis.carto.IHotLinkExpressionProperties (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

executeExpression

public String executeExpression(IObject pObject)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Specified by:: executeExpression in interface IHotlinkExpression

Parameters:: pObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)
Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws IOException,
                                      AutomationException

Indicates if the layer supports transparency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsTransparency in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws IOException,
                                        AutomationException

Indicates if the layer supports contrast changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsContrastChange in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws IOException,
                                          AutomationException

Indicates if the layer supports brightness changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsBrightnessChange in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSupportsInteractive in interface ILayerEffects

Parameters:: supported - The supported (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws IOException,
                                     AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsInteractive in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws IOException,
                             AutomationException

Layer transparency in percent (0-100).

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTransparency in interface ILayerEffects

Returns:: The alpha
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws IOException,
                            AutomationException

Layer transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setTransparency in interface ILayerEffects

Parameters:: alpha - The alpha (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getContrast in interface ILayerEffects

Returns:: The contrastValue
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setContrast in interface ILayerEffects

Parameters:: contrastValue - The contrastValue (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBrightness in interface ILayerEffects

Returns:: The brightnessValue
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBrightness in interface ILayerEffects

Parameters:: brightnessValue - The brightnessValue (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createRow

public IRow createRow()
               throws IOException,
                      AutomationException

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

Remarks

The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.

The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller�s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createRow in interface ITable

Returns:: A reference to a com.esri.arcgis.geodatabase.IRow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws IOException,
                   AutomationException

The row from the database with the specified object ID.

Remarks

The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRow in interface ITable

Parameters:: oID - The oID (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IRow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRows

public ICursor getRows(Object oids,
                       boolean recycling)
                throws IOException,
                       AutomationException

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

Remarks

The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.

The oids parameter should be passed an integer array. For example:

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

// Get a recycling cursor for the OID array.

int[] oids = new int[] { 10844, 10853, 10871 };

ICursor cursor = table.getRows(oids, true);

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws IOException,
                                  AutomationException

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

Remarks

The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createRowBuffer in interface ITable

Returns:: A reference to a com.esri.arcgis.geodatabase.IRowBuffer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

updateSearchedRows

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

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

Description

This method will edit the rows matching the query filter's constraints. The values in each row will be replaced with the corresponding field's value in the provided row buffer. The fields being edited should be specified in the query filter's SubFields property. If the row buffer contains null values, and the SubFields property is not properly set, the row's values will be overwritten with the row buffer's null values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteSearchedRows in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws IOException,
                    AutomationException

The number of Rows selected by the specified query.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rowCount in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:: The numRows
Throws:: 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 IOException,
                             AutomationException

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

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

update

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

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

Remarks

The Update method returns an update cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for complex objects and features.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws IOException,
                      AutomationException

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

Remarks

The Insert method returns an insert cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).

Insert cursors on tables containing complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insert in interface ITable

Parameters:: useBuffering - The useBuffering (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: 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 IOException,
                            AutomationException

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

Remarks

The Select method returns a selection set that holds either row IDs or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).

The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.

When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

The fields collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFields in interface IClass

Returns:: A reference to a com.esri.arcgis.geodatabase.IFields
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getIndexes

public IIndexes getIndexes()
                    throws IOException,
                           AutomationException

The indexes collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getIndexes in interface IClass

Returns:: A reference to a com.esri.arcgis.geodatabase.IIndexes
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws IOException,
                     AutomationException

Adds a field to this object class.

Remarks

Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addField in interface IClass

Parameters:: field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws IOException,
                        AutomationException

Deletes a field from this object class.

Remarks

DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:

OBJECTID field
SHAPE and shape dependent fields such as SHAPE_Length
Enabled, AncillaryRole and Weight field for network feature classes
Subtype fields. In order to delete a subtype field, it must first be removed as the subtype field, see the help on ISubtypes::SubtypeFieldName

Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Example:

// Assume we have a reference to a FeatureClass (pFC)

      IFields pFields;

      IField pField;



      pFields = pFC.getFields();

      pField = pFields.getField(pFields.findField("MyField"));



      pFC.deleteField(pField);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteField in interface IClass

Parameters:: field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws IOException,
                     AutomationException

Adds an index to this object class.

Remarks

Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addIndex in interface IClass

Parameters:: index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws IOException,
                        AutomationException

Deletes an index from this object class.

Remarks

Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteIndex in interface IClass

Parameters:: index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws IOException,
                        AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isHasOID in interface IClass

Returns:: The hasOID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public String getOIDFieldName()
                       throws IOException,
                              AutomationException

The name of the field corresponding to the OID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getOIDFieldName in interface IClass

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCLSID in interface IClass

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

public IUID getEXTCLSID()
                 throws IOException,
                        AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getEXTCLSID in interface IClass

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtension

public Object getExtension()
                    throws IOException,
                           AutomationException

The extension for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtension in interface IClass

Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public IPropertySet getExtensionProperties()
                                    throws IOException,
                                           AutomationException

The extension properties for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtensionProperties in interface IClass

Returns:: A reference to a com.esri.arcgis.system.IPropertySet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The associated name object.

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFullName in interface IDataset

Returns:: A reference to a com.esri.arcgis.system.IName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException

The browse name of the dataset.

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBrowseName in interface IDataset

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(String name)
                   throws IOException,
                          AutomationException

The browse name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBrowseName in interface IDataset

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the Dataset.

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

Example:


// Assume we have a reference to an IfeatureClass (pFeatureClass)

      IDataset pDataset = null;


      pDataset = new IDatasetProxy(pFeatureClass);


      System.out.println(pDataset.getName() + " " + pDataset.getType());


      if(pFeatureClass != null){


        pDataset = pFeatureClass.getFeatureDataset();


        System.out.println(pDataset.getName() + " " + pDataset.getType());


      }


      pDataset = new IDatasetProxy(pDataset.getWorkspace());


     System.out.println(pDataset.getName() + " " + 
pDataset.getType());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getType in interface IDataset

Returns:: A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the dataset.

Remarks

IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCategory in interface IDataset

Returns:: The category
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws IOException,
                               AutomationException

Datasets contained within this dataset.

Description

The Subsets property returns other Dataset objects contained in this dataset.

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubsets in interface IDataset

Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The workspace containing this dataset.

Description

The Workspace property returns the containing workspace for this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWorkspace in interface IDataset

Returns:: A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

The set of properties for the dataset.

Description

The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.

Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPropertySet in interface IDataset

Returns:: A reference to a com.esri.arcgis.system.IPropertySet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException

True if this dataset can be copied.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

CAD Drawings
Coverages
DBase Tables
Info Tables
Raster Datasets
SDC datasets
SDC Network Datasets
Shapefiles
Shapefile Network Datasets

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canCopy in interface IDataset

Returns:: The canCopy
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(String copyName,
                     IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException

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

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException

True if this dataset can be deleted.

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canDelete in interface IDataset

Returns:: The canDelete
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes this dataset.

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: delete in interface IDataset

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException

True if this dataset can be renamed.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canRename in interface IDataset

Returns:: The canRename
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rename

public void rename(String name)
            throws IOException,
                   AutomationException

Renames this Dataset.

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rename in interface IDataset

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses()
                                              throws IOException,
                                                     AutomationException

The memory relationship classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRelationshipClasses in interface IRelationshipClassCollection

Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findRelationshipClasses

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addRelationshipClass

public void addRelationshipClass(IRelationshipClass relationshipClass)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addRelationshipClass in interface IRelationshipClassCollectionEdit

Parameters:: relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeRelationshipClass

public void removeRelationshipClass(IRelationshipClass relationshipClass)
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeRelationshipClass in interface IRelationshipClassCollectionEdit

Parameters:: relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeAllRelationshipClasses

public void removeAllRelationshipClasses()
                                  throws IOException,
                                         AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllRelationshipClasses in interface IRelationshipClassCollectionEdit

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws IOException,
                             AutomationException

Number of extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtensionCount in interface ILayerExtensions

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtension

public Object getExtension(int index)
                    throws IOException,
                           AutomationException

The extension at the specified index.

Product Availability

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

Specified by:: getExtension in interface ILayerExtensions

Parameters:: index - The index (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(Object ext)
                  throws IOException,
                         AutomationException

Adds a new extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addExtension in interface ILayerExtensions

Parameters:: ext - A reference to another Object (IUnknown) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws IOException,
                            AutomationException

Removes the specified extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeExtension in interface ILayerExtensions

Parameters:: index - The index (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplayTable

public ITable getDisplayTable()
                       throws IOException,
                              AutomationException

The display table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplayTable in interface IDisplayTable

Returns:: A reference to a com.esri.arcgis.geodatabase.ITable
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

searchDisplayTable

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

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

Description

QueryFilter specifies an IQueryFilterObject to be used for the search.

Recycling specifies whether the resulting cursor is recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor.

Remarks

If there is a definition query set on the layer or table, the SearchDisplayTable method will work on the subset of rows that meet the definition criteria. Otherwise, it will search the whole table.

SearchDisplayTable will return an ICursor with all of the rows that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the cursor will have all of the rows from the table.

This SearchDisplayTable method will also work on joined fields if you qualify the field names. For example, if you want to search a field called "Pop1990" from a joined table called "Demog", you should used "Demog.Pop1990" for the field name in the query filter used in the search method.

The Recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single row object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a row object returned by a recycling cursor across multiple calls to NextRow on the cursor. Row objects returned by a recycling cursor should not be modified.

Non-recycling cursors return a separate row object on each fetch. The objects returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The geodatabase guarantees 'unique instance semantics' on non-recycling feature objects fetched during an edit session.

Recycling cursors should be used only for drawing and read-only access to object state. Use non-recycling search cursors to fetch objects that are to be updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: 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 IOException,
                                        AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplaySelectionSet

public ISelectionSet getDisplaySelectionSet()
                                     throws IOException,
                                            AutomationException

The selected set of rows from the display table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplaySelectionSet in interface IDisplayTable

Returns:: A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onAddField

public void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
                throws IOException,
                       AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onAddField in interface IObjectClassSchemaEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onDeleteField

public void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onDeleteField in interface IObjectClassSchemaEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onBehaviorChanged

public void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
                       throws IOException,
                              AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onBehaviorChanged in interface IObjectClassSchemaEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getJoinType

public int getJoinType()
                throws IOException,
                       AutomationException

Join type for the most recent join performed.

Description

Indicates the type of the most recent join.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getJoinType in interface IDisplayRelationshipClass

Returns:: A com.esri.arcgis.geodatabase.esriJoinType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

displayRelationshipClass

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

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

Description

RelClass can be either a file or memory based relationship class, but must be defined on the base feature class.

Remarks

This method internally initializes a RelQueryTable to perform a join. relClass can be can be either a predefined relationship class in a geodatabase or an in memory relationship class. For more information on relationship clases, see IRelationshipClass

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMapLevel

public int getMapLevel()
                throws IOException,
                       AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMapLevel in interface IMapLevel

Returns:: The mapLevel
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws IOException,
                        AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMapLevel in interface IMapLevel

Parameters:: mapLevel - The mapLevel (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUseSymbolLevels

public boolean isUseSymbolLevels()
                          throws IOException,
                                 AutomationException

Indicates if symbol levels are used for drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUseSymbolLevels in interface ISymbolLevels

Returns:: The useSymbolLevels
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setUseSymbolLevels

public void setUseSymbolLevels(boolean useSymbolLevels)
                        throws IOException,
                               AutomationException

Indicates if symbol levels are used for drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUseSymbolLevels in interface ISymbolLevels

Parameters:: useSymbolLevels - The useSymbolLevels (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAttributeTable

public ITable getAttributeTable()
                         throws IOException,
                                AutomationException

The attribute table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAttributeTable in interface IAttributeTable

Returns:: A reference to a com.esri.arcgis.geodatabase.ITable
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

enumConnectionPoints

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: enumConnectionPoints in interface IConnectionPointContainer

Parameters:: ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findConnectionPoint in interface IConnectionPointContainer

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in); ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

find

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

Finds the specified search string in the given attribute fields.

Remarks

This method returns an reference to an Array of FeatureFindData objects. To search, pass in a reference to an Fields object along with the search string and a boolean option to return features that have attributes that contain the string. If Contains = False, only objects with an attribute that consists of the entire search string will be returned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFindFields

public Object getFindFields()
                     throws IOException,
                            AutomationException

The attribute fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFindFields in interface IFind

Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFindDisplayField

public String getFindDisplayField()
                           throws IOException,
                                  AutomationException

The display field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFindDisplayField in interface IFind

Returns:: The field
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLayerWeight

public double getLayerWeight()
                      throws IOException,
                             AutomationException

Default layer position.

Description

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLayerWeight in interface ILayerPosition

Returns:: The layerWeight
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws IOException,
                           AutomationException

Default layer position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLayerWeight in interface ILayerPosition

Parameters:: layerWeight - The layerWeight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDirty in interface IPersistStream

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCanSelect

public boolean isCanSelect()
                    throws IOException,
                           AutomationException

Indicates if the table supports selection.

Remarks

Use CanSelect to determine if you can open a selection set on the table. A situation where CanSelect will be False is a standalone database table without an OID column.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanSelect in interface ITableCapabilities

Returns:: The canSelect
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addRow

public void addRow(IRow row)
            throws IOException,
                   AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addRow in interface ITableSelection

Parameters:: row - A reference to a com.esri.arcgis.geodatabase.IRow (in)
Throws:: 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 IOException,
                       AutomationException

Selects rows based upon the specified criteria and combination method.

Description

The justOne parameter tells the search to stop once it has found one feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsPublishing

public boolean isSupportsPublishing()
                             throws IOException,
                                    AutomationException

Indicates if the layer supports the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsPublishing in interface IPublishLayer

Returns:: The bValid
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPublishingDescription

public String getPublishingDescription()
                                throws IOException,
                                       AutomationException

The layer description reported to the publisher.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPublishingDescription in interface IPublishLayer

Returns:: The bsDescription
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDataValid

public boolean isDataValid()
                    throws IOException,
                           AutomationException

Indicates if the data for the layer is currently valid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDataValid in interface IPublishLayer

Returns:: The bDataValid
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDataDetails

public String getDataDetails(String bsPadding)
                      throws IOException,
                             AutomationException

Details of the layer's data.

Product Availability

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

Specified by:: getDataDetails in interface IPublishLayer

Parameters:: bsPadding - The bsPadding (in)
Returns:: The bsDataDetails
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

prepareForPublishing

public void prepareForPublishing()
                          throws IOException,
                                 AutomationException

Prepare the layer for the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: prepareForPublishing in interface IPublishLayer

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTemporary

public void setTemporary(boolean temporary)
                  throws IOException,
                         AutomationException

Indicates if the layer is a temporary layer.

Product Availability

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

Specified by:: setTemporary in interface ITemporaryLayer

Parameters:: temporary - The temporary (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isTemporary

public boolean isTemporary()
                    throws IOException,
                           AutomationException

Indicates if the layer is a temporary layer.

Product Availability

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

Specified by:: isTemporary in interface ITemporaryLayer

Returns:: The temporary
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

public double getLastMinimumScale()
                           throws IOException,
                                  AutomationException

Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLastMinimumScale in interface ILayerGeneralProperties

Returns:: The minScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws IOException,
                                  AutomationException

Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLastMaximumScale in interface ILayerGeneralProperties

Returns:: The maxScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public String ILayerGeneralProperties_getLayerDescription()
                                                   throws IOException,
                                                          AutomationException

Description for the layer.

Product Availability

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

Specified by:: ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties

Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(String text)
                         throws IOException,
                                AutomationException

Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLayerDescription in interface ILayerGeneralProperties

Parameters:: text - The text (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHTMLPopupEnabled

public boolean isHTMLPopupEnabled()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Specified by:: isHTMLPopupEnabled in interface IHTMLPopupIdentify
Specified by:: isHTMLPopupEnabled in interface IHTMLPopupInfo

Returns:: The pEnabled
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLPopupEnabled

public void setHTMLPopupEnabled(boolean pEnabled)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Specified by:: setHTMLPopupEnabled in interface IHTMLPopupInfo

Parameters:: pEnabled - The pEnabled (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLPresentationStyle

public int getHTMLPresentationStyle()
                             throws IOException,
                                    AutomationException

Indicates the content formating style for the HTML Popup tool.

Product Availability

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

Specified by:: getHTMLPresentationStyle in interface IHTMLPopupIdentify
Specified by:: getHTMLPresentationStyle in interface IHTMLPopupInfo

Returns:: A com.esri.arcgis.carto.esriHTMLPopupStyle constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLPresentationStyle

public void setHTMLPresentationStyle(int pStyle)
                              throws IOException,
                                     AutomationException

Indicates the content formating style for the HTML Popup tool.

Product Availability

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

Specified by:: setHTMLPresentationStyle in interface IHTMLPopupInfo

Parameters:: pStyle - A com.esri.arcgis.carto.esriHTMLPopupStyle constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHTMLHideFieldNameColumn

public boolean isHTMLHideFieldNameColumn()
                                  throws IOException,
                                         AutomationException

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

Product Availability

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

Specified by:: isHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Returns:: The pHide
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLHideFieldNameColumn

public void setHTMLHideFieldNameColumn(boolean pHide)
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Specified by:: setHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Parameters:: pHide - The pHide (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectField

public String getHTMLRedirectField()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:: getHTMLRedirectField in interface IHTMLPopupInfo

Returns:: The pField
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectField

public void setHTMLRedirectField(String pField)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:: setHTMLRedirectField in interface IHTMLPopupInfo

Parameters:: pField - The pField (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldPrefix

public String getHTMLRedirectFieldPrefix()
                                  throws IOException,
                                         AutomationException

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

Product Availability

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

Specified by:: getHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Returns:: The pPrefix
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldPrefix

public void setHTMLRedirectFieldPrefix(String pPrefix)
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Specified by:: setHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Parameters:: pPrefix - The pPrefix (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldSuffix

public String getHTMLRedirectFieldSuffix()
                                  throws IOException,
                                         AutomationException

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

Product Availability

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

Specified by:: getHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Returns:: The pSufix
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldSuffix

public void setHTMLRedirectFieldSuffix(String pSufix)
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Specified by:: setHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Parameters:: pSufix - The pSufix (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLXSLStylesheet

public String getHTMLXSLStylesheet()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:: getHTMLXSLStylesheet in interface IHTMLPopupInfo

Returns:: The pStyleSheet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLXSLStylesheet

public void setHTMLXSLStylesheet(String pStyleSheet)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:: setHTMLXSLStylesheet in interface IHTMLPopupInfo

Parameters:: pStyleSheet - The pStyleSheet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHTMLUseCodedDomainValues

public boolean isHTMLUseCodedDomainValues()
                                   throws IOException,
                                          AutomationException

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

Product Availability

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

Specified by:: isHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Returns:: The pCodedValues
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLUseCodedDomainValues

public void setHTMLUseCodedDomainValues(boolean pCodedValues)
                                 throws IOException,
                                        AutomationException

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

Product Availability

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

Specified by:: setHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Parameters:: pCodedValues - The pCodedValues (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLOutput

public String getHTMLOutput(IFeature pFeature)
                     throws IOException,
                            AutomationException

The content is the XML text for the input feature.

Product Availability

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

Specified by:: getHTMLOutput in interface IHTMLPopupInfo

Parameters:: pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Returns:: The pHtml
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHTMLDownloadAttachmentData

public boolean isHTMLDownloadAttachmentData()
                                     throws IOException,
                                            AutomationException

Indicates that all data for attachments will be retrieved.

Product Availability

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

Specified by:: isHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Returns:: The pDownloadAttachmentData
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLDownloadAttachmentData

public void setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData)
                                   throws IOException,
                                          AutomationException

Indicates that all data for attachments will be retrieved.

Product Availability

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

Specified by:: setHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Parameters:: pDownloadAttachmentData - The pDownloadAttachmentData (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hTMLOutput

public String hTMLOutput(IFeature pFeature,
                         IPropertySet pOptions)
                  throws IOException,
                         AutomationException

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

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hTMLIdentify

public String hTMLIdentify(IPoint pPoint,
                           double tolerance)
                    throws IOException,
                           AutomationException

The content is the XML text at the specified point.

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hTMLTipText

public String hTMLTipText(IPoint pPoint,
                          double tolerance)
                   throws IOException,
                          AutomationException

The tooltip at the specified point.

Product Availability

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

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:: 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 IOException,
                         AutomationException

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

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsTime

public boolean isSupportsTime()
                       throws IOException,
                              AutomationException

Indicates whether the layer has any time data.

Description

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

Product Availability

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

Specified by:: isSupportsTime in interface ITimeData

Returns:: The hasTime
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUseTime

public boolean isUseTime()
                  throws IOException,
                         AutomationException

Indicates whether to use the time for animation purposes.

Description

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

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

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

Product Availability

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

Specified by:: isUseTime in interface ITimeData

Returns:: The useTime
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setUseTime

public void setUseTime(boolean useTime)
                throws IOException,
                       AutomationException

Indicates whether to use the time for animation purposes.

Product Availability

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

Specified by:: setUseTime in interface ITimeData

Parameters:: useTime - The useTime (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

Time reference for the contents of the layer.

Description

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

Product Availability

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

Specified by:: getTimeReference in interface ITimeData
Specified by:: getTimeReference in interface ITimeDimensionDefinition
Specified by:: getTimeReference in interface ITimeTableDefinition

Returns:: A reference to a com.esri.arcgis.system.ITimeReference
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws IOException,
                                     AutomationException

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

Description

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

Product Availability

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

Specified by:: getFullTimeExtent in interface ITimeData

Returns:: A reference to a com.esri.arcgis.system.ITimeExtent
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasLiveData

public boolean isHasLiveData()
                      throws IOException,
                             AutomationException

isHasLiveData

Product Availability

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

Specified by:: isHasLiveData in interface ITimeData2

Returns:: The useTime
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHasLiveData

public void setHasLiveData(boolean useTime)
                    throws IOException,
                           AutomationException

setHasLiveData

Product Availability

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

Specified by:: setHasLiveData in interface ITimeData2

Parameters:: useTime - The useTime (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getStartTimeFieldName

public String getStartTimeFieldName()
                             throws IOException,
                                    AutomationException

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

Description

This property contains the name of the column which contains the start time for each feature. If the feature has only one associated time, then this field is used, and the EndTimeFieldName is not set.

Product Availability

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

Specified by:: getStartTimeFieldName in interface ITimeTableDefinition

Returns:: The fieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setStartTimeFieldName

public void setStartTimeFieldName(String fieldName)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Specified by:: setStartTimeFieldName in interface ITimeTableDefinition

Parameters:: fieldName - The fieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

public String getEndTimeFieldName()
                           throws IOException,
                                  AutomationException

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

Description

If the data in a table has a start and an end time, this property contains the name of the column that holds the end time for each feature. If the data only has one time associated with it (it is instantaneous) then this property is not set.

Product Availability

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

Specified by:: getEndTimeFieldName in interface ITimeTableDefinition

Returns:: The fieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setEndTimeFieldName

public void setEndTimeFieldName(String fieldName)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Specified by:: setEndTimeFieldName in interface ITimeTableDefinition

Parameters:: fieldName - The fieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

public String getTimeValueFormat()
                          throws IOException,
                                 AutomationException

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

Description

This property contains an emumeration representing the format of the data stored in the Start Time Field and the End Time Field. The Start Time Field and the End Time Field must use the same format. Only formats allowed by this enumeration are allowed.

Product Availability

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

Specified by:: getTimeValueFormat in interface ITimeTableDefinition

Returns:: The format
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeValueFormat

public void setTimeValueFormat(String format)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Specified by:: setTimeValueFormat in interface ITimeTableDefinition

Parameters:: format - The format (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

public String getTrackIDFieldName()
                           throws IOException,
                                  AutomationException

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

Description

The TrackIDFieldName property contains the name of the field which can be used to group features by the object they represent. For example, if a table contains observations of automobiles, and each feature in the table represents the location of one automobile at one point in time, there will be one field that uniquely identifies which automobile a feature is associated with (e.g. license plate number). The TrackIDFieldName is the field that can be used to group the attributes by the real-world object that they represent (the "Track" that they belong to).

Product Availability

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

Specified by:: getTrackIDFieldName in interface ITimeTableDefinition

Returns:: The fieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTrackIDFieldName

public void setTrackIDFieldName(String fieldName)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Specified by:: setTrackIDFieldName in interface ITimeTableDefinition

Parameters:: fieldName - The fieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference nativeTimeReference)
                           throws IOException,
                                  AutomationException

Time reference for the data.

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCustomTimeExtent

public ITimeExtent getCustomTimeExtent()
                                throws IOException,
                                       AutomationException

Custom time extent during which a layer is visible.

Product Availability

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

Specified by:: getCustomTimeExtent in interface ITimeTableDefinition

Returns:: A reference to a com.esri.arcgis.system.ITimeExtent
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCustomTimeExtentByRef

public void setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime)
                              throws IOException,
                                     AutomationException

Custom time extent during which a layer is visible.

Product Availability

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

Specified by:: setCustomTimeExtentByRef in interface ITimeTableDefinition

Parameters:: layerVisibiltyTime - A reference to a com.esri.arcgis.system.ITimeExtent (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeDataCumulative

public void setTimeDataCumulative(boolean cumilative)
                           throws IOException,
                                  AutomationException

Indicates that features will be animated cumilatively.

Product Availability

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

Specified by:: setTimeDataCumulative in interface ITimeDataDisplay

Parameters:: cumilative - The cumilative (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isTimeDataCumulative

public boolean isTimeDataCumulative()
                             throws IOException,
                                    AutomationException

Indicates that features will be animated cumilatively.

Description

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

Product Availability

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

Specified by:: isTimeDataCumulative in interface ITimeDataDisplay

Returns:: The cumilative
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeInterval

public void setTimeInterval(double interval)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Specified by:: setTimeInterval in interface ITimeDataDisplay

Parameters:: interval - The interval (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeInterval

public double getTimeInterval()
                       throws IOException,
                              AutomationException

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

Description

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

Product Availability

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

Specified by:: getTimeInterval in interface ITimeDataDisplay

Returns:: The interval
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeIntervalUnits

public void setTimeIntervalUnits(int units)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:: setTimeIntervalUnits in interface ITimeDataDisplay

Parameters:: units - A com.esri.arcgis.system.esriTimeUnits constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

public int getTimeIntervalUnits()
                         throws IOException,
                                AutomationException

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

Description

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

Product Availability

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

Specified by:: getTimeIntervalUnits in interface ITimeDataDisplay

Returns:: A com.esri.arcgis.system.esriTimeUnits constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeOffset

public void setTimeOffset(double timeOffset)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Specified by:: setTimeOffset in interface ITimeDataDisplay

Parameters:: timeOffset - The timeOffset (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeOffset

public double getTimeOffset()
                     throws IOException,
                            AutomationException

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

Description

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

Product Availability

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

Specified by:: getTimeOffset in interface ITimeDataDisplay

Returns:: The timeOffset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeOffsetUnits

public void setTimeOffsetUnits(int units)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Specified by:: setTimeOffsetUnits in interface ITimeDataDisplay

Parameters:: units - A com.esri.arcgis.system.esriTimeUnits constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeOffsetUnits

public int getTimeOffsetUnits()
                       throws IOException,
                              AutomationException

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

Description

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

Product Availability

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

Specified by:: getTimeOffsetUnits in interface ITimeDataDisplay

Returns:: A com.esri.arcgis.system.esriTimeUnits constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isMultiDimensional

public boolean isMultiDimensional()
                           throws IOException,
                                  AutomationException

Indicates whether the data is multi-dimensional.

Product Availability

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

Specified by:: isMultiDimensional in interface ITimeDimensionDefinition

Returns:: The isMultidimensional
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeDimensionName

public String getTimeDimensionName()
                            throws IOException,
                                   AutomationException

Returns the name of the dimension that represents time.

Product Availability

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

Specified by:: getTimeDimensionName in interface ITimeDimensionDefinition

Returns:: The fieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeDimensionName

public void setTimeDimensionName(String fieldName)
                          throws IOException,
                                 AutomationException

Returns the name of the dimension that represents time.

Product Availability

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

Specified by:: setTimeDimensionName in interface ITimeDimensionDefinition

Parameters:: fieldName - The fieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeDimensionFormat

public String getTimeDimensionFormat()
                              throws IOException,
                                     AutomationException

Returns the format of the dimension that represents time.

Product Availability

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

Specified by:: getTimeDimensionFormat in interface ITimeDimensionDefinition

Returns:: The format
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeDimensionFormat

public void setTimeDimensionFormat(String format)
                            throws IOException,
                                   AutomationException

Returns the format of the dimension that represents time.

Product Availability

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

Specified by:: setTimeDimensionFormat in interface ITimeDimensionDefinition

Parameters:: format - The format (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

prepareTimeQuery

public void prepareTimeQuery(ITimeValue pTimeValue,
                             IQueryFilter[] pFilter)
                      throws IOException,
                             AutomationException

Prepares an input query filter by appending the time expression into the where clause.

Product Availability

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

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:: 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 IOException,
                               AutomationException

Prepares an input query filter by appending the time expression into the where clause.

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

prepareTimeQueryFromDisplay

public void prepareTimeQueryFromDisplay(IDisplay pDisplay,
                                        IQueryFilter[] pFilter)
                                 throws IOException,
                                        AutomationException

Prepares an input query filter by appending the time expression into the where clause.

Product Availability

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

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:: 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 IOException,
                         AutomationException

Identifies objects at the specified location for the given display.

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onCreateDataset

public void onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent)
                     throws IOException,
                            AutomationException

This event is fired when a dataset is created.

Remarks

The OnCreateDataset method is fired after a dataset has been created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onCreateDataset in interface IWorkspaceEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onRenameDataset

public void onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent)
                     throws IOException,
                            AutomationException

This event is fired when a dataset is renamed.

Remarks

The OnRenameDataset method is fired after a dataset has been renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onRenameDataset in interface IWorkspaceEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onDeleteDataset

public void onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent)
                     throws IOException,
                            AutomationException

This event is fired when a dataset is deleted.

Remarks

The OnDeleteDataset method is fired after a dataset has been created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onDeleteDataset in interface IWorkspaceEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable

Throws:: IOException; ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto Class FeatureLayer

Remarks

Product Availability

Supported Platforms

FeatureLayer

FeatureLayer

getClsid

equals

hashCode

addILayerEventsListener

removeILayerEventsListener

addIFeatureLayerSelectionEventsListener

removeIFeatureLayerSelectionEventsListener

addIDefinitionExpressionEventsListener

removeIDefinitionExpressionEventsListener

getFeatureClass

Description

Product Availability

Supported Platforms

setFeatureClassByRef

Product Availability

Supported Platforms

getDataSourceType

Description

Remarks

Product Availability

Supported Platforms

setDataSourceType

Product Availability

Supported Platforms

getDisplayField

Description

Remarks

Product Availability

Supported Platforms

setDisplayField

Product Availability

Supported Platforms

isSelectable

Description

Remarks

Product Availability

Supported Platforms

setSelectable

Product Availability

Supported Platforms

search

Description

Remarks

Product Availability

Supported Platforms

isScaleSymbols

Description

Product Availability

Supported Platforms

setScaleSymbols

Product Availability

Supported Platforms

getName

Description

Remarks

Product Availability

Supported Platforms

setName

Description

Product Availability

Supported Platforms

isValid

Remarks

Product Availability

Supported Platforms

getAreaOfInterest

Remarks

Product Availability

Supported Platforms

getMinimumScale

Remarks

Product Availability

Supported Platforms

setMinimumScale

com.esri.arcgis.carto
Class FeatureLayer