com.esri.arcgis.carto
Class GdbRasterCatalogLayer

java.lang.Object
  extended bycom.esri.arcgis.carto.GdbRasterCatalogLayer
All Implemented Interfaces:
java.util.EventListener, IAttributeTable, IClass, IConnectionPointContainer, IDataLayer, IDataLayer2, IDataset, IDisplayAdmin, IDisplayAdmin2, IDisplayFilterManager, IDisplayRelationshipClass, IDisplayTable, IFeatureLayer, IFeatureLayer2, IFeatureLayerDefinition, IFeatureLayerDefinition2, IFeatureSelection, IFind, IGdbRasterCatalogLayer, IGeoDataset, IGeoFeatureLayer, IHotlinkContainer, IHotlinkMacro, IHyperlinkContainer, IIdentify, IIdentify2, ILayer, ILayer2, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerFields, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerSymbologyExtents, ILegendInfo, IMapLevel, IObjectClassSchemaEvents, IPersist, IPersistStream, IPropertySupport, IRasterCatalogDisplayProps, IRasterDataManagementEvents, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ISecureLayer, ISymbolLevels, ITable, ITableDefinition, ITableFields, ITableSelection, java.io.Serializable

public class GdbRasterCatalogLayer
extends java.lang.Object
implements IGdbRasterCatalogLayer, ILayer, IRasterCatalogDisplayProps, IGeoDataset, ILegendInfo, IPersistStream, IIdentify, IDataLayer, ILayerEffects, ILayerExtensions, IDisplayAdmin, IDisplayAdmin2, IFeatureLayer, IGeoFeatureLayer, IHotlinkContainer, IHotlinkMacro, IHyperlinkContainer, IIdentify2, ILayerGeneralProperties, ILayerSymbologyExtents, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ISecureLayer, ISymbolLevels, IDisplayFilterManager, IMapLevel, ITableFields, IPropertySupport, IFeatureLayer2, IObjectClassSchemaEvents, ILayer2, IDataset, IClass, ITable, ITableSelection, IDisplayTable, IAttributeTable, IFeatureSelection, IDataLayer2, IFeatureLayerDefinition, IFeatureLayerDefinition2, ITableDefinition, ILayerFields, IFind, IConnectionPointContainer, IDisplayRelationshipClass, ILayerDrawingProperties, ILayerPosition, ILayerInfo, IRasterDataManagementEvents

Geodabase RasterCatalog source and display options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
GdbRasterCatalogLayer()
          Constructs a GdbRasterCatalogLayer using ArcGIS Engine.
GdbRasterCatalogLayer(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
 
Method Summary
 void add(IFeature feature)
          Adds a feature to the selection set.
 void addExtension(java.lang.Object ext)
          Adds a new extension.
 void addField(IField field)
          Adds a field to this object class.
 void addHyperlink(IHyperlink link)
          Adds a hyperlink.
 void addILayerEventsListener(ILayerEvents theListener)
           
 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(java.lang.Object pUnk)
          Indicates if the receiver can apply the given object at any given time.
 java.lang.Object apply(java.lang.Object newObject)
          Applies the given property to the receiver and returns the old object.
 boolean canApply(java.lang.Object pUnk)
          Indicates if the receiver can apply the given object at that particular moment.
 boolean canCopy()
          True if this dataset can be copied.
 boolean canDelete()
          True if this dataset can be deleted.
 boolean canRename()
          True if this dataset can be renamed.
 IRasterRenderer chooseRenderer(IRaster pRaster)
          Chooses a proper renderer for a given raster.
 void clear()
          Clears the selection.
 void clearPassword(boolean bForceReconnect)
          Removes the passwords from the layer used to access data, and forces a reconnection to the data.
 boolean connect(IName pOptRepairName)
          Connects the layer to its data source.
 IDataset copy(java.lang.String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 IRow createRow()
          Creates a row in the database with a system assigned object ID and null property values.
 IRowBuffer createRowBuffer()
          Creates a row buffer that can be used with an insert cursor.
 IFeatureLayer createSelectionLayer(java.lang.String layerName, boolean useCurrentSelection, java.lang.String joinTableNames, java.lang.String expression)
          Creates a new feature layer from the existing layer based on the current selection and the specified query expression.
 void 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)
          Supported Platforms
 boolean equals(java.lang.Object o)
          Compare this object with another
 void expandRegionForSymbols(IDisplay pDisplay, IGeometry pRegion)
          Enlarges the specified region if necessary to account for the symbology sizes.
 IArray find(java.lang.String search, boolean contains, java.lang.Object fields, ITrackCancel trackCancel)
          Finds the specified search string in the given attribute fields.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          Supported Platforms
 int findField(java.lang.String fieldName)
          The index of the field with the given 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.
 IAttributeTable getAsIAttributeTable()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IClass getAsIClass()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IConnectionPointContainer getAsIConnectionPointContainer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDataLayer getAsIDataLayer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDataLayer2 getAsIDataLayer2()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDataset getAsIDataset()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDisplayAdmin getAsIDisplayAdmin()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDisplayAdmin2 getAsIDisplayAdmin2()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDisplayFilterManager getAsIDisplayFilterManager()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDisplayRelationshipClass getAsIDisplayRelationshipClass()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDisplayTable getAsIDisplayTable()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IFeatureLayer getAsIFeatureLayer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IFeatureLayer2 getAsIFeatureLayer2()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IFeatureLayerDefinition getAsIFeatureLayerDefinition()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IFeatureLayerDefinition2 getAsIFeatureLayerDefinition2()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IFeatureSelection getAsIFeatureSelection()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IFind getAsIFind()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGdbRasterCatalogLayer getAsIGdbRasterCatalogLayer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGeoDataset getAsIGeoDataset()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGeoFeatureLayer getAsIGeoFeatureLayer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IHotlinkContainer getAsIHotlinkContainer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IHotlinkMacro getAsIHotlinkMacro()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IHyperlinkContainer getAsIHyperlinkContainer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IIdentify getAsIIdentify()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IIdentify2 getAsIIdentify2()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayer getAsILayer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayer2 getAsILayer2()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerDrawingProperties getAsILayerDrawingProperties()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerEffects getAsILayerEffects()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerExtensions getAsILayerExtensions()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerFields getAsILayerFields()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerGeneralProperties getAsILayerGeneralProperties()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerInfo getAsILayerInfo()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerPosition getAsILayerPosition()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILayerSymbologyExtents getAsILayerSymbologyExtents()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ILegendInfo getAsILegendInfo()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IMapLevel getAsIMapLevel()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IObjectClassSchemaEvents getAsIObjectClassSchemaEvents()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IPersistStream getAsIPersistStream()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IPropertySupport getAsIPropertySupport()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRasterCatalogDisplayProps getAsIRasterCatalogDisplayProps()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRasterDataManagementEvents getAsIRasterDataManagementEvents()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRelationshipClassCollection getAsIRelationshipClassCollection()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRelationshipClassCollectionEdit getAsIRelationshipClassCollectionEdit()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISecureLayer getAsISecureLayer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISymbolLevels getAsISymbolLevels()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITable getAsITable()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITableDefinition getAsITableDefinition()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITableFields getAsITableFields()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITableSelection getAsITableSelection()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ITable getAttributeTable()
          The attribute table.
 short getBrightness()
          Layer brightness in percent (-100 - 100).
 java.lang.String getBrowseName()
          The browse name of the dataset.
 double getBufferDistance()
          Buffer distance used for the selection.
 java.lang.String getCategory()
          The category of the dataset.
 void getClassID(GUID[] pClassID)
          Supported Platforms
static java.lang.String 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).
 java.lang.Object getCurrent(java.lang.Object pUnk)
          The object currently being used.
 IName getDataSourceName()
          Name of the data object for the layer.
 java.lang.String getDataSourceType()
          Data source type.
 java.lang.String getDefinitionExpression()
          Definition query expression for the existing layer.
 ISelectionSet getDefinitionSelectionSet()
          The selection set that defines the subset of features in a selection layer.
 int getDelayDraw()
          The time in millisecond to delay the drawing of each raster.
 IFeatureClass getDisplayFeatureClass()
          Feature class used for display operations (may include joined fields).
 java.lang.String getDisplayField()
          Primary display field.
 IDisplayFilter getDisplayFilter()
          The display filter.
 int getDisplayRasters()
          Indicates whether to display rasters.
 ISelectionSet getDisplaySelectionSet()
          The selected set of rows from the display table.
 ITable getDisplayTable()
          The display table.
 IFeatureIDSet getExclusionSet()
          The set of features that are excluded from drawing.
 IUID getEXTCLSID()
          The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
 java.lang.Object getExtension()
          The extension for this object class.
 java.lang.Object getExtension(int index)
          The extension at the specified index.
 int getExtensionCount()
          Number of extensions.
 IPropertySet getExtensionProperties()
          The extension properties for this object class.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 IFeatureClass getFeatureClass()
          The layer's feature class.
 IField getField(int index)
          The field at the given index.
 int getFieldCount()
          The field count.
 IFieldInfo getFieldInfo(int index)
          The extended field information for the field at the given index.
 IFields getFields()
          The fields collection for this object class.
 java.lang.String getFindDisplayField()
          The display field.
 java.lang.Object getFindFields()
          The attribute fields.
 IName getFullName()
          The associated name object.
 java.lang.String getHotlinkField()
          Field used for hotlinks.
 int getHotlinkType()
          Hotlink type.
 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.
 java.lang.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.
 java.lang.String getName()
          Layer name.
 java.lang.String getOIDFieldName()
          The name of the field corresponding to the OID.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 IRelationshipClass getRelationshipClass()
          The current relationship class used to display related fields.
 IEnumRelationshipClass getRelationshipClasses()
          The memory relationship classes.
 java.lang.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.
 IArray getRenderers()
          The renderers of RasterCatalog.
 int getResamplingType()
          Resampling method for displaying a raster.
 IRow getRow(int oID)
          The row from the database with the specified object ID.
 ICursor getRows(java.lang.Object oids, boolean recycling)
          The cursor of rows based on a set of object ids.
 int getSearchOrder()
          Flag that specifies the search order used when applying a mixed attribute-spatial query.
 IColor getSelectionColor()
          Selection color.
 ISelectionSet getSelectionSet()
          The selected set of rows.
 ISymbol getSelectionSymbol()
          Selection symbol.
 int getShapeType()
          The layer's shape type.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          Supported Platforms
 int getSmallImage()
          Small image that represents the layer.
 int getSmallSelectedImage()
          Small image that represents the layer when it is selected.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getSupportedDrawPhases()
          Supported draw phases.
 ISymbol getSymbol()
          The symbol of the layer.
 java.lang.String getTipText(double x, double y, double tolerance)
          Map tip text at the specified location.
 double getTransitionScale()
          The scale value to transition between wireframe and raster display.
 short getTransparency()
          Layer transparency in percent (0-100).
 int getType()
          The type of the Dataset.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 int hashCode()
          the hashcode for this object
 IArray identify(IGeometry pGeom)
          Identifies objects at the specified location.
 IArray identify(IGeometry pGeom, ITrackCancel pTrackCancel)
          Identifies objects at the specified location.
 java.lang.String ILayerGeneralProperties_getLayerDescription()
          Description for the layer.
 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 isDataSourceSupported(IName name)
          Indicates if the specified data object name is supported by the layer.
 void isDirty()
          Supported Platforms
 boolean isDisplayAnnotation()
          Indicates if the layer displays annotation.
 boolean isDoesBlending()
          Indicates whether the drawing object blends its output with the background.
 boolean isDrawingPropsDirty()
          Indicates if the layer drawing properties are dirty.
 boolean isDrawRastersOnly()
          Indicates whether to draw the rasters only.
 boolean isDrawSelectedRasters()
          Indicates whether to draw the selected raster.
 boolean isHasOID()
          Indicates if the class has an object identity (OID) field.
 boolean isRedrawDisplay()
          Indicates whether the display should redraw the layer.
 boolean[] isRendererUsage()
          Indicates whether renderers are being used.
 boolean isRequiresBanding()
          Indicates whether the output from the drawing object requires banding.
 boolean isScaleRangeReadOnly()
          Indicates if the minimum and maximum scale range values are read-only.
 boolean 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 isSupportsTransparency()
          Indicates if the layer supports transparency.
 boolean isSymbolsAreGraduated()
          Indicates if symbols are graduated.
 boolean isUseScale()
          Indicates whether the scale is use to control wireframe/raster display transition.
 boolean isUsesFilter()
          Indicates if the current object draws using a filter.
 boolean isUseSymbolLevels()
          Indicates if symbol levels are used for drawing.
 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)
          Supported Platforms
 void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
          This event is fired when a new field is added to the object class.
 void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
          This event is fired when the behavior class for the object class changes.
 void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
          This event is fired when a field is deleted from the object class.
 void onEvent(IRasterDataManagementEventsOnEventEvent theEvent)
          Performs operation on the raster data management event.
 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 removeILayerEventsListener(ILayerEvents theListener)
           
 void removeRelationshipClass(IRelationshipClass relationshipClass)
          Removes the specified memory relationship class from a standalone table or layer.
 void rename(java.lang.String name)
          Renames this Dataset.
 int rowCount(IQueryFilter queryFilter)
          The number of Rows selected by the specified query.
 void save(IStream pstm, int fClearDirty)
          Supported Platforms
 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 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(java.lang.String name)
          The browse name of the dataset.
 void setBufferDistance(double distance)
          Buffer distance used for the selection.
 void setCached(boolean cached)
          Indicates if the layer needs its own display cache.
 void setCombinationMethod(int method)
          Combination method for the selection.
 void setContrast(short contrastValue)
          Layer contrast in percent (-100 - 100).
 void setCurrentMapLevel(int rhs1)
          Current map level for drawing symbols.
 void setDataSourceName(IName name)
          Name of the data object for the layer.
 void setDataSourceType(java.lang.String text)
          Data source type.
 void setDefinitionExpression(java.lang.String expression)
          Definition query expression for the existing layer.
 void setDelayDraw(int ms)
          The time in millisecond to delay the drawing of each raster.
 void setDisplayAnnotation(boolean value)
          Indicates if the layer displays annotation.
 void setDisplayField(java.lang.String fieldName)
          Primary display field.
 void setDisplayFilter(IDisplayFilter displayFilter)
          The display filter.
 void setDisplayRasters(int pNum)
          Indicates whether to display rasters.
 void setDrawingPropsDirty(boolean dirty)
          Indicates if the layer drawing properties are dirty.
 void setDrawRastersOnly(boolean b)
          Indicates whether to draw the rasters only.
 void setDrawSelectedRasters(boolean b)
          Indicates whether to draw the selected raster.
 void setExclusionSetByRef(IFeatureIDSet fids)
          The set of features that are excluded from drawing.
 void setFeatureClassByRef(IFeatureClass fclass)
          The layer's feature class.
 void setHotlinkField(java.lang.String fieldName)
          Field used for hotlinks.
 void setHotlinkType(int linkType)
          Hotlink type.
 void setHyperlinkByRef(int index, IHyperlink link)
          The hyperlink at the specified index.
 void setLayerDescription(java.lang.String text)
          Description for the layer.
 void setLayerWeight(double layerWeight)
          Default layer position.
 void setMacroName(java.lang.String name)
          Name of macro used for the hotlink.
 void setMapLevel(int mapLevel)
          Current map level for drawing multi-level symbols.
 void setMaximumScale(double maxScale)
          Maximum scale (representative fraction) at which the layer will display.
 void setMinimumScale(double minScale)
          Minimum scale (representative fraction) at which the layer will display.
 void setName(java.lang.String name)
          Layer name.
 void setRedrawDisplay(boolean b)
          Indicates whether the display should redraw the layer.
 void setRelationshipClassByRef(IRelationshipClass relClass)
          The current relationship class used to display related fields.
 void setRelativeBase(java.lang.String basePath)
          Base path used when storing relative path names.
 void setRendererByRef(IFeatureRenderer renderer)
          Renderer used to draw the layer.
 void setRendererPropertyPageClassID(IUID clsid)
          Class id of the property page for the renderer.
 void setRenderers(IArray ppRenderers)
          The renderers of RasterCatalog.
 void setResamplingType(int pResamplingType)
          Resampling method for displaying a raster.
 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 rows.
 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 setSupportsInteractive(boolean supported)
          Indicates if the layer supports interactive effects changes.
 void setSymbolByRef(ISymbol ppSymbol)
          The symbol of the layer.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 void setTransitionScale(double scale)
          The scale value to transition between wireframe and raster display.
 void setTransparency(short alpha)
          Layer transparency in percent (0-100).
 boolean setup(ITable pTable)
          Sets up the RasterCatalogLayer based on the given table.
 void setUseScale(boolean b)
          Indicates whether the scale is use to control wireframe/raster display transition.
 void setUseSymbolLevels(boolean useSymbolLevels)
          Indicates if symbol levels are used for drawing.
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GdbRasterCatalogLayer

public GdbRasterCatalogLayer()
                      throws java.io.IOException,
                             java.net.UnknownHostException
Constructs a GdbRasterCatalogLayer using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GdbRasterCatalogLayer

public GdbRasterCatalogLayer(java.lang.Object obj)
                      throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a GdbRasterCatalogLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GdbRasterCatalogLayer.
GdbRasterCatalogLayer theGdbRasterCatalogLayer = (GdbRasterCatalogLayer) obj;

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()

getAsIGdbRasterCatalogLayer

public IGdbRasterCatalogLayer getAsIGdbRasterCatalogLayer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayer

public ILayer getAsILayer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRasterCatalogDisplayProps

public IRasterCatalogDisplayProps getAsIRasterCatalogDisplayProps()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIGeoDataset

public IGeoDataset getAsIGeoDataset()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILegendInfo

public ILegendInfo getAsILegendInfo()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIPersistStream

public IPersistStream getAsIPersistStream()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIIdentify

public IIdentify getAsIIdentify()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDataLayer

public IDataLayer getAsIDataLayer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerEffects

public ILayerEffects getAsILayerEffects()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerExtensions

public ILayerExtensions getAsILayerExtensions()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDisplayAdmin

public IDisplayAdmin getAsIDisplayAdmin()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDisplayAdmin2

public IDisplayAdmin2 getAsIDisplayAdmin2()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIFeatureLayer

public IFeatureLayer getAsIFeatureLayer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIGeoFeatureLayer

public IGeoFeatureLayer getAsIGeoFeatureLayer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIHotlinkContainer

public IHotlinkContainer getAsIHotlinkContainer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIHotlinkMacro

public IHotlinkMacro getAsIHotlinkMacro()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIHyperlinkContainer

public IHyperlinkContainer getAsIHyperlinkContainer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIIdentify2

public IIdentify2 getAsIIdentify2()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerGeneralProperties

public ILayerGeneralProperties getAsILayerGeneralProperties()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerSymbologyExtents

public ILayerSymbologyExtents getAsILayerSymbologyExtents()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRelationshipClassCollection

public IRelationshipClassCollection getAsIRelationshipClassCollection()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRelationshipClassCollectionEdit

public IRelationshipClassCollectionEdit getAsIRelationshipClassCollectionEdit()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISecureLayer

public ISecureLayer getAsISecureLayer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISymbolLevels

public ISymbolLevels getAsISymbolLevels()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDisplayFilterManager

public IDisplayFilterManager getAsIDisplayFilterManager()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIMapLevel

public IMapLevel getAsIMapLevel()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITableFields

public ITableFields getAsITableFields()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIPropertySupport

public IPropertySupport getAsIPropertySupport()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIFeatureLayer2

public IFeatureLayer2 getAsIFeatureLayer2()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIObjectClassSchemaEvents

public IObjectClassSchemaEvents getAsIObjectClassSchemaEvents()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayer2

public ILayer2 getAsILayer2()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDataset

public IDataset getAsIDataset()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIClass

public IClass getAsIClass()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITable

public ITable getAsITable()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITableSelection

public ITableSelection getAsITableSelection()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDisplayTable

public IDisplayTable getAsIDisplayTable()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIAttributeTable

public IAttributeTable getAsIAttributeTable()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIFeatureSelection

public IFeatureSelection getAsIFeatureSelection()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDataLayer2

public IDataLayer2 getAsIDataLayer2()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIFeatureLayerDefinition

public IFeatureLayerDefinition getAsIFeatureLayerDefinition()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIFeatureLayerDefinition2

public IFeatureLayerDefinition2 getAsIFeatureLayerDefinition2()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsITableDefinition

public ITableDefinition getAsITableDefinition()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerFields

public ILayerFields getAsILayerFields()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIFind

public IFind getAsIFind()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIConnectionPointContainer

public IConnectionPointContainer getAsIConnectionPointContainer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDisplayRelationshipClass

public IDisplayRelationshipClass getAsIDisplayRelationshipClass()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerDrawingProperties

public ILayerDrawingProperties getAsILayerDrawingProperties()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerPosition

public ILayerPosition getAsILayerPosition()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsILayerInfo

public ILayerInfo getAsILayerInfo()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRasterDataManagementEvents

public IRasterDataManagementEvents getAsIRasterDataManagementEvents()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


equals

public boolean equals(java.lang.Object o)
Compare this object with another


hashCode

public int hashCode()
the hashcode for this object


addILayerEventsListener

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

removeILayerEventsListener

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

setup

public boolean setup(ITable pTable)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IGdbRasterCatalogLayer
Sets up the RasterCatalogLayer based on the given table.

Specified by:
setup in interface IGdbRasterCatalogLayer
Parameters:
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Returns:
The isSuccessful
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRenderers

public void setRenderers(IArray ppRenderers)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IGdbRasterCatalogLayer
The renderers of RasterCatalog.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRenderers in interface IGdbRasterCatalogLayer
Parameters:
ppRenderers - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRenderers

public IArray getRenderers()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IGdbRasterCatalogLayer
The renderers of RasterCatalog.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRenderers in interface IGdbRasterCatalogLayer
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isRendererUsage

public boolean[] isRendererUsage()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGdbRasterCatalogLayer
Indicates whether renderers are being used.

Specified by:
isRendererUsage in interface IGdbRasterCatalogLayer
Returns:
The pUsage
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isDrawSelectedRasters

public boolean isDrawSelectedRasters()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IGdbRasterCatalogLayer
Indicates whether to draw the selected raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDrawSelectedRasters in interface IGdbRasterCatalogLayer
Returns:
The b
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setDrawSelectedRasters

public void setDrawSelectedRasters(boolean b)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IGdbRasterCatalogLayer
Indicates whether to draw the selected raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDrawSelectedRasters in interface IGdbRasterCatalogLayer
Parameters:
b - The b (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

chooseRenderer

public IRasterRenderer chooseRenderer(IRaster pRaster)
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGdbRasterCatalogLayer
Chooses a proper renderer for a given raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:
chooseRenderer in interface IGdbRasterCatalogLayer
Parameters:
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Returns:
A reference to a com.esri.arcgis.carto.IRasterRenderer
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: ILayer
Layer name.

Supported Platforms

Windows, Solaris, Linux

Description


 

Remarks

Use this property to associate a string with a layer.

Specified by:
getName in interface ILayer
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: ILayer
Layer name.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
setName in interface ILayer
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ILayer
Indicates if the layer is currently valid.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isValid in interface ILayer
Returns:
The valid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ILayer
The default area of interest for the layer.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns the spatial-referenced extent of the layer.

Specified by:
getAreaOfInterest in interface ILayer
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getMinimumScale

public double getMinimumScale()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: ILayer
Minimum scale (representative fraction) at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getMinimumScale in interface ILayer
Returns:
The minScale
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ILayer
Minimum scale (representative fraction) at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
setMinimumScale in interface ILayer
Parameters:
minScale - The minScale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: ILayer
Maximum scale (representative fraction) at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getMaximumScale in interface ILayer
Returns:
The maxScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ILayer
Maximum scale (representative fraction) at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
setMaximumScale in interface ILayer
Parameters:
maxScale - The maxScale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ILayer
Indicates if the layer is currently visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isVisible in interface ILayer
Returns:
The visible
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ILayer
Indicates if the layer is currently visible.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
setVisible in interface ILayer
Parameters:
visible - The visible (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isShowTips

public boolean isShowTips()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: ILayer
Indicates if the layer shows map tips.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isShowTips in interface ILayer
Returns:
The show
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setShowTips

public void setShowTips(boolean show)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: ILayer
Indicates if the layer shows map tips.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
setShowTips in interface ILayer
Parameters:
show - The show (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getTipText

public java.lang.String getTipText(double x,
                                   double y,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ILayer
Map tip text at the specified location.

Supported Platforms

Windows, Solaris, Linux

Remarks

The text string that gets displayed as a map tip if ShowTips = True. For a FeatureLayer this comes from the data in IFeatureLayer::DisplayField.

Specified by:
getTipText in interface ILayer
Parameters:
x - The x (in)
y - The y (in)
tolerance - The tolerance (in)
Returns:
The text
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isCached

public boolean isCached()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: ILayer
Indicates if the layer needs its own display cache.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isCached in interface ILayer
Returns:
The cached
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: ILayer
Indicates if the layer needs its own display cache.

Supported Platforms

Windows, Solaris, Linux

Description

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

Remarks

Informational property.  Container is responsible for cache management.

Specified by:
setCached in interface ILayer
Parameters:
cached - The cached (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: ILayer
Supported draw phases.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getSupportedDrawPhases in interface ILayer
Returns:
The drawPhases
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: ILayer
Spatial reference for the layer.

Specified by:
setSpatialReferenceByRef in interface ILayer
Parameters:
rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: ILayer
Draws the layer to the specified display for the given draw phase.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
draw in interface ILayer
Parameters:
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getDisplayRasters

public int getDisplayRasters()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Indicates whether to display rasters.

Supported Platforms

Windows, Solaris, Linux

Remarks

The DisplayRasters property specifies a threshold (the number of raster datasets are within the display extent) that controls the raster catalog display mode. If the number of the raster datasets in the display extent is greater than the threshold, the raster catalog displays as a wireframe. Otherwise the raster datasets within the display extent will be drawn. The default threshold is 9.

Specified by:
getDisplayRasters in interface IRasterCatalogDisplayProps
Returns:
The pNum
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setDisplayRasters

public void setDisplayRasters(int pNum)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Indicates whether to display rasters.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayRasters in interface IRasterCatalogDisplayProps
Parameters:
pNum - The pNum (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IRasterCatalogDisplayProps
The symbol of the layer.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Symbol specifies the symbol to be use in rendering a raster catalog’s wire frames.

Specified by:
getSymbol in interface IRasterCatalogDisplayProps
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setSymbolByRef

public void setSymbolByRef(ISymbol ppSymbol)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IRasterCatalogDisplayProps
The symbol of the layer.

Specified by:
setSymbolByRef in interface IRasterCatalogDisplayProps
Parameters:
ppSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseScale

public void setUseScale(boolean b)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Indicates whether the scale is use to control wireframe/raster display transition.

Supported Platforms

Windows, Solaris, Linux

Remarks

The UseScale property is also a threshold (map scale) that switches between the raster catalog display modes. For example, if you want the raster catalog display to be switched when displaying at a map scale 1:50000, you should set 50000 to this property. When the display scale goes bigger (i.e. 1:40000), it displays as raster datasets, and when the display scale goes smaller (i.e. 1:60000), it is displayed as a wireframe. This property has a higher priority than the threshold set by DisplayRasters. The UseScale must be true in order to use the this threshold.

Specified by:
setUseScale in interface IRasterCatalogDisplayProps
Parameters:
b - The b (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isUseScale

public boolean isUseScale()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Indicates whether the scale is use to control wireframe/raster display transition.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUseScale in interface IRasterCatalogDisplayProps
Returns:
The b
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setTransitionScale

public void setTransitionScale(double scale)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IRasterCatalogDisplayProps
The scale value to transition between wireframe and raster display.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTransitionScale in interface IRasterCatalogDisplayProps
Parameters:
scale - The scale (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getTransitionScale

public double getTransitionScale()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IRasterCatalogDisplayProps
The scale value to transition between wireframe and raster display.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTransitionScale in interface IRasterCatalogDisplayProps
Returns:
The scale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRedrawDisplay

public boolean isRedrawDisplay()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Indicates whether the display should redraw the layer.

Supported Platforms

Windows, Solaris, Linux

Remarks

Setting the RedrawDisplay property to be true will redraw raster datasets in the display each time you pan or zoom; the default is false.

Specified by:
isRedrawDisplay in interface IRasterCatalogDisplayProps
Returns:
The b
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRedrawDisplay

public void setRedrawDisplay(boolean b)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Indicates whether the display should redraw the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRedrawDisplay in interface IRasterCatalogDisplayProps
Parameters:
b - The b (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getDelayDraw

public int getDelayDraw()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IRasterCatalogDisplayProps
The time in millisecond to delay the drawing of each raster.

Supported Platforms

Windows, Solaris, Linux

Remarks

The DelayDraw property controls the time interval in millisecond between drawing raster datasets. The default is set to 0. If the DelayDraw is set to a value that is less than the time that takes to draw one raster dataset, you will not see the difference by setting this delay property. You might want to increase this delay value to adjust to your application.

Specified by:
getDelayDraw in interface IRasterCatalogDisplayProps
Returns:
The ms
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setDelayDraw

public void setDelayDraw(int ms)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IRasterCatalogDisplayProps
The time in millisecond to delay the drawing of each raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDelayDraw in interface IRasterCatalogDisplayProps
Parameters:
ms - The ms (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getResamplingType

public int getResamplingType()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Resampling method for displaying a raster.

Supported Platforms

Windows, Solaris, Linux

Remarks

The ResamplingType specifies the resample type used in displaying raster datasets. The default is set to be NearestNeighbor resampling.

Specified by:
getResamplingType in interface IRasterCatalogDisplayProps
Returns:
A com.esri.arcgis.geodatabase.rstResamplingTypes constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setResamplingType

public void setResamplingType(int pResamplingType)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Resampling method for displaying a raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setResamplingType in interface IRasterCatalogDisplayProps
Parameters:
pResamplingType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setDrawRastersOnly

public void setDrawRastersOnly(boolean b)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Indicates whether to draw the rasters only.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDrawRastersOnly in interface IRasterCatalogDisplayProps
Parameters:
b - The b (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDrawRastersOnly

public boolean isDrawRastersOnly()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IRasterCatalogDisplayProps
Indicates whether to draw the rasters only.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDrawRastersOnly in interface IRasterCatalogDisplayProps
Returns:
The b
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
Description copied from interface: IGeoDataset
The spatial reference of the GeoDataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getSpatialReference in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IGeoDataset
The extent of the GeoDataset.

Supported Platforms

Windows, Solaris, Linux

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.

 

Specified by:
getExtent in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getLegendGroupCount

public int getLegendGroupCount()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: ILegendInfo
Number of legend groups contained by the object.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getLegendGroupCount in interface ILegendInfo
Returns:
The count
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ILegendInfo
Legend group at the specified index.

Supported Platforms

Windows, Solaris, Linux

Remarks

The content and number of legend groups is determined by the implementation of the renderer, consequently this property is read only.

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

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: ILegendInfo
Optional. Defines legend formatting for layer rendered with this object.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getLegendItem in interface ILegendInfo
Returns:
A reference to a com.esri.arcgis.carto.ILegendItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: ILegendInfo
Indicates if symbols are graduated.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isSymbolsAreGraduated in interface ILegendInfo
Returns:
The symbolsAreGraduated
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ILegendInfo
Indicates if symbols are graduated.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymbolsAreGraduated in interface ILegendInfo
Parameters:
symbolsAreGraduated - The symbolsAreGraduated (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

identify

public IArray identify(IGeometry pGeom)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IIdentify
Identifies objects at the specified location.

Supported Platforms

Windows, Solaris, Linux

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.


 

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

getDataSourceName

public IName getDataSourceName()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IDataLayer
Name of the data object for the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDataSourceName in interface IDataLayer
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setDataSourceName

public void setDataSourceName(IName name)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IDataLayer
Name of the data object for the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDataSourceName in interface IDataLayer
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IDataLayer
Indicates if the specified data object name is supported by the layer.

Supported Platforms

Windows, Solaris, Linux

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

connect

public boolean connect(IName pOptRepairName)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IDataLayer
Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Supported Platforms

Windows, Solaris, Linux

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

getRelativeBase

public java.lang.String getRelativeBase()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IDataLayer
Base path used when storing relative path names.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRelativeBase in interface IDataLayer
Returns:
The basePath
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(java.lang.String basePath)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IDataLayer
Base path used when storing relative path names.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRelativeBase in interface IDataLayer
Parameters:
basePath - The basePath (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: ILayerEffects
Indicates if the layer supports transparency.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsTransparency in interface ILayerEffects
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: ILayerEffects
Indicates if the layer supports contrast changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsContrastChange in interface ILayerEffects
Returns:
The supported
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: ILayerEffects
Indicates if the layer supports brightness changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsBrightnessChange in interface ILayerEffects
Returns:
The supported
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ILayerEffects
Indicates if the layer supports interactive effects changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSupportsInteractive in interface ILayerEffects
Parameters:
supported - The supported (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: ILayerEffects
Indicates if the layer supports interactive effects changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsInteractive in interface ILayerEffects
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ILayerEffects
Layer transparency in percent (0-100).

Supported Platforms

Windows, Solaris, Linux

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.

 

Specified by:
getTransparency in interface ILayerEffects
Returns:
The alpha
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ILayerEffects
Layer transparency in percent (0-100).

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTransparency in interface ILayerEffects
Parameters:
alpha - The alpha (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getContrast

public short getContrast()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ILayerEffects
Layer contrast in percent (-100 - 100).

Supported Platforms

Windows, Solaris, Linux

Specified by:
getContrast in interface ILayerEffects
Returns:
The contrastValue
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setContrast

public void setContrast(short contrastValue)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: ILayerEffects
Layer contrast in percent (-100 - 100).

Supported Platforms

Windows, Solaris, Linux

Specified by:
setContrast in interface ILayerEffects
Parameters:
contrastValue - The contrastValue (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getBrightness

public short getBrightness()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ILayerEffects
Layer brightness in percent (-100 - 100).

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBrightness in interface ILayerEffects
Returns:
The brightnessValue
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setBrightness

public void setBrightness(short brightnessValue)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: ILayerEffects
Layer brightness in percent (-100 - 100).

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBrightness in interface ILayerEffects
Parameters:
brightnessValue - The brightnessValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ILayerExtensions
Number of extensions.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtensionCount in interface ILayerExtensions
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

public java.lang.Object getExtension(int index)
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: ILayerExtensions
The extension at the specified index.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtension in interface ILayerExtensions
Parameters:
index - The index (in)
Returns:
A reference to another Object (IUnknown)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

addExtension

public void addExtension(java.lang.Object ext)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ILayerExtensions
Adds a new extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
addExtension in interface ILayerExtensions
Parameters:
ext - A reference to another Object (IUnknown) (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

removeExtension

public void removeExtension(int index)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ILayerExtensions
Removes the specified extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
removeExtension in interface ILayerExtensions
Parameters:
index - The index (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isUsesFilter

public boolean isUsesFilter()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IDisplayAdmin
Indicates if the current object draws using a filter.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isUsesFilter in interface IDisplayAdmin
Returns:
The usesFilter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRequiresBanding

public boolean isRequiresBanding()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IDisplayAdmin2
Indicates whether the output from the drawing object requires banding. Generally this is true if the output is raster.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isRequiresBanding in interface IDisplayAdmin2
Returns:
The flag
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isDoesBlending

public boolean isDoesBlending()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IDisplayAdmin2
Indicates whether the drawing object blends its output with the background. For example, if the object is transparent, the background becomes part of its rendering.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDoesBlending in interface IDisplayAdmin2
Returns:
The flag
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IFeatureLayer
The layer's feature class.

Supported Platforms

Windows, Solaris, Linux

Description

The FeatureClass data source for the layer.

Specified by:
getFeatureClass in interface IFeatureLayer
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass fclass)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IFeatureLayer
The layer's feature class.

Specified by:
setFeatureClassByRef in interface IFeatureLayer
Parameters:
fclass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getDataSourceType

public java.lang.String getDataSourceType()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: IFeatureLayer
Data source type.

Supported Platforms

Windows, Solaris, Linux

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"
ArcInfo or PC ArcInfo Coverage (annotation) "Annotation Feature Class"
ArcInfo or PC ArcInfo Coverage (point) "Point Feature Class"
ArcInfo or PC ArcInfo Coverage (line) "Arc Feature Class"
ArcInfo 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"

Specified by:
getDataSourceType in interface IFeatureLayer
Returns:
The text
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSourceType

public void setDataSourceType(java.lang.String text)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IFeatureLayer
Data source type.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDataSourceType in interface IFeatureLayer
Parameters:
text - The text (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getDisplayField

public java.lang.String getDisplayField()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IFeatureLayer
Primary display field.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getDisplayField in interface IFeatureLayer
Returns:
The fieldName
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setDisplayField

public void setDisplayField(java.lang.String fieldName)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IFeatureLayer
Primary display field.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayField in interface IFeatureLayer
Parameters:
fieldName - The fieldName (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isSelectable

public boolean isSelectable()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IFeatureLayer
Indicates if layer is selectable.

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the layer's features are selectable.

Remarks

The default value for Selectable is False.

Specified by:
isSelectable in interface IFeatureLayer
Returns:
The value
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setSelectable

public void setSelectable(boolean value)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IFeatureLayer
Indicates if layer is selectable.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSelectable in interface IFeatureLayer
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

search

public IFeatureCursor search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IFeatureLayer
Creates a cursor based upon the search criteria.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
search in interface IFeatureLayer
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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isScaleSymbols

public boolean isScaleSymbols()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IFeatureLayer
Indicates if symbols are scaled for the layer.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isScaleSymbols in interface IFeatureLayer
Returns:
The scale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IFeatureLayer
Indicates if symbols are scaled for the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setScaleSymbols in interface IFeatureLayer
Parameters:
scale - The scale (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getRenderer

public IFeatureRenderer getRenderer()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IGeoFeatureLayer
Renderer used to draw the layer.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getRenderer in interface IGeoFeatureLayer
Returns:
A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setRendererByRef

public void setRendererByRef(IFeatureRenderer renderer)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IGeoFeatureLayer
Renderer used to draw the layer.

Specified by:
setRendererByRef in interface IGeoFeatureLayer
Parameters:
renderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getRendererPropertyPageClassID

public IUID getRendererPropertyPageClassID()
                                    throws java.io.IOException,
                                           AutomationException
Description copied from interface: IGeoFeatureLayer
Class id of the property page for the renderer.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getRendererPropertyPageClassID in interface IGeoFeatureLayer
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setRendererPropertyPageClassID

public void setRendererPropertyPageClassID(IUID clsid)
                                    throws java.io.IOException,
                                           AutomationException
Description copied from interface: IGeoFeatureLayer
Class id of the property page for the renderer.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
setRendererPropertyPageClassID in interface IGeoFeatureLayer
Parameters:
clsid - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isDisplayAnnotation

public boolean isDisplayAnnotation()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IGeoFeatureLayer
Indicates if the layer displays annotation.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isDisplayAnnotation in interface IGeoFeatureLayer
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayAnnotation

public void setDisplayAnnotation(boolean value)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGeoFeatureLayer
Indicates if the layer displays annotation.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayAnnotation in interface IGeoFeatureLayer
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationPropertiesID

public IUID getAnnotationPropertiesID()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGeoFeatureLayer
The UID used for annotation properties.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getAnnotationPropertiesID in interface IGeoFeatureLayer
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnotationPropertiesIDByRef

public void setAnnotationPropertiesIDByRef(IUID uid)
                                    throws java.io.IOException,
                                           AutomationException
Description copied from interface: IGeoFeatureLayer
The UID used for annotation properties.

Specified by:
setAnnotationPropertiesIDByRef in interface IGeoFeatureLayer
Parameters:
uid - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationProperties

public IAnnotateLayerPropertiesCollection getAnnotationProperties()
                                                           throws java.io.IOException,
                                                                  AutomationException
Description copied from interface: IGeoFeatureLayer
Annotation properties.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getAnnotationProperties in interface IGeoFeatureLayer
Returns:
A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setAnnotationProperties

public void setAnnotationProperties(IAnnotateLayerPropertiesCollection props)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IGeoFeatureLayer
Annotation properties.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAnnotationProperties in interface IGeoFeatureLayer
Parameters:
props - A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setCurrentMapLevel

public void setCurrentMapLevel(int rhs1)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IGeoFeatureLayer
Current map level for drawing symbols.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
setCurrentMapLevel in interface IGeoFeatureLayer
Parameters:
rhs1 - The rhs1 (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getExclusionSet

public IFeatureIDSet getExclusionSet()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IGeoFeatureLayer
The set of features that are excluded from drawing.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getExclusionSet in interface IGeoFeatureLayer
Returns:
A reference to a com.esri.arcgis.carto.IFeatureIDSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionSetByRef

public void setExclusionSetByRef(IFeatureIDSet fids)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGeoFeatureLayer
The set of features that are excluded from drawing.

Specified by:
setExclusionSetByRef in interface IGeoFeatureLayer
Parameters:
fids - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getDisplayFeatureClass

public IFeatureClass getDisplayFeatureClass()
                                     throws java.io.IOException,
                                            AutomationException
Description copied from interface: IGeoFeatureLayer
Feature class used for display operations (may include joined fields).

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getDisplayFeatureClass in interface IGeoFeatureLayer
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

searchDisplayFeatures

public IFeatureCursor searchDisplayFeatures(IQueryFilter queryFilter,
                                            boolean recycling)
                                     throws java.io.IOException,
                                            AutomationException
Description copied from interface: IGeoFeatureLayer
Creates a cursor from the display feature class based upon the search criteria.

Supported Platforms

Windows, Solaris, Linux

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.

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

getHotlinkField

public java.lang.String getHotlinkField()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IHotlinkContainer
Field used for hotlinks.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHotlinkField in interface IHotlinkContainer
Returns:
The fieldName
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setHotlinkField

public void setHotlinkField(java.lang.String fieldName)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IHotlinkContainer
Field used for hotlinks.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setHotlinkField in interface IHotlinkContainer
Parameters:
fieldName - The fieldName (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getHotlinkType

public int getHotlinkType()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IHotlinkContainer
Hotlink type.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHotlinkType in interface IHotlinkContainer
Returns:
A com.esri.arcgis.carto.esriHyperlinkType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHotlinkType

public void setHotlinkType(int linkType)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IHotlinkContainer
Hotlink type.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setHotlinkType in interface IHotlinkContainer
Parameters:
linkType - A com.esri.arcgis.carto.esriHyperlinkType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMacroName

public java.lang.String getMacroName()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IHotlinkMacro
Name of macro used for the hotlink.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMacroName in interface IHotlinkMacro
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMacroName

public void setMacroName(java.lang.String name)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IHotlinkMacro
Name of macro used for the hotlink.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMacroName in interface IHotlinkMacro
Parameters:
name - The name (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getHyperlinkCount

public int getHyperlinkCount()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IHyperlinkContainer
Number of hyperlinks.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHyperlinkCount in interface IHyperlinkContainer
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHyperlink

public IHyperlink getHyperlink(int index)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IHyperlinkContainer
The hyperlink at the specified index.

Supported Platforms

Windows, Solaris, Linux

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

setHyperlinkByRef

public void setHyperlinkByRef(int index,
                              IHyperlink link)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IHyperlinkContainer
The hyperlink at the specified index.

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

addHyperlink

public void addHyperlink(IHyperlink link)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IHyperlinkContainer
Adds a hyperlink.

Supported Platforms

Windows, Solaris, Linux

Specified by:
addHyperlink in interface IHyperlinkContainer
Parameters:
link - A reference to a com.esri.arcgis.carto.IHyperlink (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

removeHyperlink

public void removeHyperlink(int index)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IHyperlinkContainer
Removes the hyperlink at the specified index.

Supported Platforms

Windows, Solaris, Linux

Specified by:
removeHyperlink in interface IHyperlinkContainer
Parameters:
index - The index (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

identify

public IArray identify(IGeometry pGeom,
                       ITrackCancel pTrackCancel)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IIdentify2
Identifies objects at the specified location.

Supported Platforms

Windows, Solaris, Linux

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.

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

setScale

public void setScale(double rhs1)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IIdentify2
The current scale of the display.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setScale in interface IIdentify2
Parameters:
rhs1 - The rhs1 (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getLastMinimumScale

public double getLastMinimumScale()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: ILayerGeneralProperties
Last minimum scale setting used by layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLastMinimumScale in interface ILayerGeneralProperties
Returns:
The minScale
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getLastMaximumScale

public double getLastMaximumScale()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: ILayerGeneralProperties
Last maximum scale setting used by layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLastMaximumScale in interface ILayerGeneralProperties
Returns:
The maxScale
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

ILayerGeneralProperties_getLayerDescription

public java.lang.String ILayerGeneralProperties_getLayerDescription()
                                                             throws java.io.IOException,
                                                                    AutomationException
Description copied from interface: ILayerGeneralProperties
Description for the layer.

Specified by:
ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties
Returns:
The text
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(java.lang.String text)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: ILayerGeneralProperties
Description for the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLayerDescription in interface ILayerGeneralProperties
Parameters:
text - The text (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay pDisplay,
                                   IGeometry pRegion)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ILayerSymbologyExtents
Enlarges the specified region if necessary to account for the symbology sizes.

Specified by:
expandRegionForSymbols in interface ILayerSymbologyExtents
Parameters:
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
pRegion - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses()
                                              throws java.io.IOException,
                                                     AutomationException
Description copied from interface: IRelationshipClassCollection
The memory relationship classes.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRelationshipClasses in interface IRelationshipClassCollection
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

findRelationshipClasses

public IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass,
                                                      int role)
                                               throws java.io.IOException,
                                                      AutomationException
Description copied from interface: IRelationshipClassCollection
Finds all relationship classes in the collection that reference the given object class in the specified role.

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

addRelationshipClass

public void addRelationshipClass(IRelationshipClass relationshipClass)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IRelationshipClassCollectionEdit
Adds the specified memory relationship class to a standalone table or layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
addRelationshipClass in interface IRelationshipClassCollectionEdit
Parameters:
relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

removeRelationshipClass

public void removeRelationshipClass(IRelationshipClass relationshipClass)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IRelationshipClassCollectionEdit
Removes the specified memory relationship class from a standalone table or layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
removeRelationshipClass in interface IRelationshipClassCollectionEdit
Parameters:
relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

removeAllRelationshipClasses

public void removeAllRelationshipClasses()
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IRelationshipClassCollectionEdit
Removes all memory relationship classes from a standalone table or layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
removeAllRelationshipClasses in interface IRelationshipClassCollectionEdit
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

clearPassword

public void clearPassword(boolean bForceReconnect)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: ISecureLayer
Removes the passwords from the layer used to access data, and forces a reconnection to the data.

Supported Platforms

Windows, Solaris, Linux

Specified by:
clearPassword in interface ISecureLayer
Parameters:
bForceReconnect - The bForceReconnect (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isUseSymbolLevels

public boolean isUseSymbolLevels()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: ISymbolLevels
Indicates if symbol levels are used for drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUseSymbolLevels in interface ISymbolLevels
Returns:
The useSymbolLevels
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setUseSymbolLevels

public void setUseSymbolLevels(boolean useSymbolLevels)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: ISymbolLevels
Indicates if symbol levels are used for drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUseSymbolLevels in interface ISymbolLevels
Parameters:
useSymbolLevels - The useSymbolLevels (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayFilter

public void setDisplayFilter(IDisplayFilter displayFilter)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IDisplayFilterManager
The display filter.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayFilter in interface IDisplayFilterManager
Parameters:
displayFilter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getDisplayFilter

public IDisplayFilter getDisplayFilter()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IDisplayFilterManager
The display filter.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayFilter in interface IDisplayFilterManager
Returns:
A reference to a com.esri.arcgis.display.IDisplayFilter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapLevel

public int getMapLevel()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMapLevel
Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMapLevel in interface IMapLevel
Returns:
The mapLevel
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMapLevel
Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMapLevel in interface IMapLevel
Parameters:
mapLevel - The mapLevel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldCount

public int getFieldCount()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ITableFields
The field count.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFieldCount in interface ITableFields
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getField

public IField getField(int index)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ITableFields
The field at the given index.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getField in interface ITableFields
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IField
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldInfo

public IFieldInfo getFieldInfo(int index)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: ITableFields
The extended field information for the field at the given index.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFieldInfo in interface ITableFields
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFieldInfo
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

findField

public int findField(java.lang.String fieldName)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: ITableFields
The index of the field with the given name.

Supported Platforms

Windows, Solaris, Linux

Specified by:
findField in interface ITableFields
Parameters:
fieldName - The fieldName (in)
Returns:
The index
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPropertySupport
Indicates if the receiver can apply the given object at any given time.

Supported Platforms

Windows, Solaris, Linux

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.

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

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IPropertySupport
Indicates if the receiver can apply the given object at that particular moment.

Supported Platforms

Windows, Solaris, Linux

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.

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

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IPropertySupport
The object currently being used.

Supported Platforms

Windows, Solaris, Linux

Remarks

Current will return you the current object of the specified type.  For instance, I may ask a CircleElement if it supports a Color object.  If it does, then I can use Current to get the Color object currently applied to my CircleElement.

Specified by:
getCurrent in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IPropertySupport
Applies the given property to the receiver and returns the old object.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
apply in interface IPropertySupport
Parameters:
newObject - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getShapeType

public int getShapeType()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IFeatureLayer2
The layer's shape type.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
getShapeType in interface IFeatureLayer2
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

onAddField

public void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IObjectClassSchemaEvents
This event is fired when a new field is added to the object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
onAddField in interface IObjectClassSchemaEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onDeleteField

public void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IObjectClassSchemaEvents
This event is fired when a field is deleted from the object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
onDeleteField in interface IObjectClassSchemaEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onBehaviorChanged

public void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IObjectClassSchemaEvents
This event is fired when the behavior class for the object class changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:
onBehaviorChanged in interface IObjectClassSchemaEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: ILayer2
Indicates if the minimum and maximum scale range values are read-only.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
isScaleRangeReadOnly in interface ILayer2
Returns:
The flag
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: ILayer2
The default area of interest for the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAreaOfInterest in interface ILayer2
Parameters:
aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataset
The associated name object.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getFullName in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IDataset
The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
getBrowseName in interface IDataset
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IDataset
The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBrowseName in interface IDataset
Parameters:
name - The name (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IDataset
The type of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Type property returns the enumerated type for the dataset, such as esriDTTable or esriDTFeatureDataset.

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IDataset
The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getCategory in interface IDataset
Returns:
The category
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IDataset
Datasets contained within this dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getSubsets in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IDataset
The workspace containing this dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The Workspace property returns the containing workspace for this dataset.

Specified by:
getWorkspace in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IDataset
The set of properties for the dataset.

Supported Platforms

Windows, Solaris, Linux

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.

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.

Specified by:
getPropertySet in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IDataset
True if this dataset can be copied.

Supported Platforms

Windows, Solaris, Linux

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:

Specified by:
canCopy in interface IDataset
Returns:
The canCopy
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IDataset
Copies this dataset to a new dataset with the specified name.

Supported Platforms

Windows, Solaris, Linux

Remarks

IDataset::Copy does not support the copying of Graph objects such as a Geometric Network.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
See Also:
GeoDBDataTransfer

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataset
True if this dataset can be deleted.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
canDelete in interface IDataset
Returns:
The canDelete
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IDataset
Deletes this dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
delete in interface IDataset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataset
True if this dataset can be renamed.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
canRename in interface IDataset
Returns:
The canRename
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IDataset
Renames this Dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
rename in interface IDataset
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IClass
The fields collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFields in interface IClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getIndexes

public IIndexes getIndexes()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IClass
The indexes collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getIndexes in interface IClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IIndexes
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IClass
Adds a field to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
addField in interface IClass
Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IClass
Deletes a field from this object class.

Supported Platforms

Windows, Solaris, Linux

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:

 

Specified by:
deleteField in interface IClass
Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IClass
Adds an index to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
addIndex in interface IClass
Parameters:
index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IClass
Deletes an index from this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
deleteIndex in interface IClass
Parameters:
index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IClass
Indicates if the class has an object identity (OID) field.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isHasOID in interface IClass
Returns:
The hasOID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public java.lang.String getOIDFieldName()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IClass
The name of the field corresponding to the OID.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOIDFieldName in interface IClass
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getCLSID

public IUID getCLSID()
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IClass
The GUID for the COM Class (CoClass) corresponding to instances of this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCLSID in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

public IUID getEXTCLSID()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IClass
The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEXTCLSID in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getExtension

public java.lang.Object getExtension()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IClass
The extension for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtension in interface IClass
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public IPropertySet getExtensionProperties()
                                    throws java.io.IOException,
                                           AutomationException
Description copied from interface: IClass
The extension properties for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtensionProperties in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

createRow

public IRow createRow()
               throws java.io.IOException,
                      AutomationException
Description copied from interface: ITable
Creates a row in the database with a system assigned object ID and null property values.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
createRow in interface ITable
Returns:
A reference to a com.esri.arcgis.geodatabase.IRow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: ITable
The row from the database with the specified object ID.

Supported Platforms

Windows, Solaris, Linux

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.

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

getRows

public ICursor getRows(java.lang.Object oids,
                       boolean recycling)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ITable
The cursor of rows based on a set of object ids.

Supported Platforms

Windows, Solaris, Linux

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.

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

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: ITable
Creates a row buffer that can be used with an insert cursor.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
createRowBuffer in interface ITable
Returns:
A reference to a com.esri.arcgis.geodatabase.IRowBuffer
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

updateSearchedRows

public void updateSearchedRows(IQueryFilter queryFilter,
                               IRowBuffer buffer)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: ITable
Update the Rows in the database selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

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

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: ITable
Delete the Rows in the database selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Specified by:
deleteSearchedRows in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: ITable
The number of Rows selected by the specified query.

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

ITable_search

public ICursor ITable_search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ITable
An object cursor that can be used to fetch row objects selected by the specified query.

Specified by:
ITable_search in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
recycling - The recycling (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: ITable
Returns a cursor that can be used to update Rows selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

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

All edits to features that participate in a Topology or Geometric Network must be bracketed within an edit operation.

Specified by:
update in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
recycling - The recycling (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: ITable
Returns a cursor that can be used to insert new Rows.

Supported Platforms

Windows, Solaris, Linux

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 custom rows and objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.

Specified by:
insert in interface ITable
Parameters:
useBuffering - The useBuffering (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

select

public ISelectionSet select(IQueryFilter queryFilter,
                            int selType,
                            int selOption,
                            IWorkspace selectionContainer)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ITable
A selection that contains the object ids selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

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

When calling Select the selectionContainer parameter is no longer required. Null (C#, VB.Net) or Nothing (VB6) should be supplied it its place. 

Specified by:
select in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)
selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)
selectionContainer - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: ITableSelection
The selected set of rows.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSelectionSet in interface ITableSelection
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet selectionSet)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: ITableSelection
The selected set of rows.

Specified by:
setSelectionSetByRef in interface ITableSelection
Parameters:
selectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addRow

public void addRow(IRow row)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: ITableSelection
Adds a row to the selection set (honoring the current combination method).

Supported Platforms

Windows, Solaris, Linux

Specified by:
addRow in interface ITableSelection
Parameters:
row - A reference to a com.esri.arcgis.geodatabase.IRow (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectRows

public void selectRows(IQueryFilter filter,
                       int method,
                       boolean justOne)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ITableSelection
Selects rows based upon the specified criteria and combination method.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
selectRows in interface ITableSelection
Parameters:
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)
justOne - The justOne (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException
Description copied from interface: ITableSelection
Clears the selection.

Supported Platforms

Windows, Solaris, Linux

Specified by:
clear in interface ITableSelection
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

selectionChanged

public void selectionChanged()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ITableSelection
Fires the layer update event. Required when SelectionSet changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:
selectionChanged in interface ITableSelection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayTable

public ITable getDisplayTable()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IDisplayTable
The display table.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayTable in interface IDisplayTable
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

searchDisplayTable

public ICursor searchDisplayTable(IQueryFilter pQueryFilter,
                                  boolean recycling)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IDisplayTable
Creates a cursor from the display table based upon the search criteria.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
searchDisplayTable in interface IDisplayTable
Parameters:
pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
recycling - The recycling (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectDisplayTable

public ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter,
                                        int selType,
                                        int selOption,
                                        IWorkspace pSelWorkspace)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IDisplayTable
Creates a selection set from the display table based upon the search criteria.

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

getDisplaySelectionSet

public ISelectionSet getDisplaySelectionSet()
                                     throws java.io.IOException,
                                            AutomationException
Description copied from interface: IDisplayTable
The selected set of rows from the display table.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplaySelectionSet in interface IDisplayTable
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeTable

public ITable getAttributeTable()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IAttributeTable
The attribute table.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAttributeTable in interface IAttributeTable
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getCombinationMethod

public int getCombinationMethod()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IFeatureSelection
Combination method for the selection.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCombinationMethod in interface IFeatureSelection
Returns:
A com.esri.arcgis.carto.esriSelectionResultEnum constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCombinationMethod

public void setCombinationMethod(int method)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IFeatureSelection
Combination method for the selection.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCombinationMethod in interface IFeatureSelection
Parameters:
method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getBufferDistance

public double getBufferDistance()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IFeatureSelection
Buffer distance used for the selection.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBufferDistance in interface IFeatureSelection
Returns:
The distance
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setBufferDistance

public void setBufferDistance(double distance)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IFeatureSelection
Buffer distance used for the selection.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBufferDistance in interface IFeatureSelection
Parameters:
distance - The distance (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isSetSelectionSymbol

public boolean isSetSelectionSymbol()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IFeatureSelection
Indicates if the selected set of features is drawn using the SelectionSymbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSetSelectionSymbol in interface IFeatureSelection
Returns:
The setSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSetSelectionSymbol

public void setSetSelectionSymbol(boolean setSymbol)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IFeatureSelection
Indicates if the selected set of features is drawn using the SelectionSymbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSetSelectionSymbol in interface IFeatureSelection
Parameters:
setSymbol - The setSymbol (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSelectionColor

public IColor getSelectionColor()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IFeatureSelection
Selection color. (used when SetSelectionSymbol = FALSE).

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSelectionColor in interface IFeatureSelection
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionColorByRef

public void setSelectionColorByRef(IColor color)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IFeatureSelection
Selection color. (used when SetSelectionSymbol = FALSE).

Specified by:
setSelectionColorByRef in interface IFeatureSelection
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSelectionSymbol

public ISymbol getSelectionSymbol()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IFeatureSelection
Selection symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSelectionSymbol in interface IFeatureSelection
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setSelectionSymbolByRef

public void setSelectionSymbolByRef(ISymbol symbol)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IFeatureSelection
Selection symbol.

Specified by:
setSelectionSymbolByRef in interface IFeatureSelection
Parameters:
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IFeature feature)
         throws java.io.IOException,
                AutomationException
Description copied from interface: IFeatureSelection
Adds a feature to the selection set.

Supported Platforms

Windows, Solaris, Linux

Specified by:
add in interface IFeatureSelection
Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectFeatures

public void selectFeatures(IQueryFilter filter,
                           int method,
                           boolean justOne)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IFeatureSelection
Selects features based upon the specifed criteria and combination method.

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

disconnect

public void disconnect()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IDataLayer2
Disconnects the data from the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
disconnect in interface IDataLayer2
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IDataLayer2
Returns TRUE if the layer is in the specified workspace.

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

getDefinitionExpression

public java.lang.String getDefinitionExpression()
                                         throws java.io.IOException,
                                                AutomationException
Description copied from interface: IFeatureLayerDefinition
Definition query expression for the existing layer.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getDefinitionExpression in interface IFeatureLayerDefinition
Returns:
The expression
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

public void setDefinitionExpression(java.lang.String expression)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IFeatureLayerDefinition
Definition query expression for the existing layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefinitionExpression in interface IFeatureLayerDefinition
Parameters:
expression - The expression (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getDefinitionSelectionSet

public ISelectionSet getDefinitionSelectionSet()
                                        throws java.io.IOException,
                                               AutomationException
Description copied from interface: IFeatureLayerDefinition
The selection set that defines the subset of features in a selection layer.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
getDefinitionSelectionSet in interface IFeatureLayerDefinition
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

createSelectionLayer

public IFeatureLayer createSelectionLayer(java.lang.String layerName,
                                          boolean useCurrentSelection,
                                          java.lang.String joinTableNames,
                                          java.lang.String expression)
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: IFeatureLayerDefinition
Creates a new feature layer from the existing layer based on the current selection and the specified query expression.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
createSelectionLayer in interface IFeatureLayerDefinition
Parameters:
layerName - The layerName (in)
useCurrentSelection - The useCurrentSelection (in)
joinTableNames - The joinTableNames (in)
expression - The expression (in)
Returns:
A reference to a com.esri.arcgis.carto.IFeatureLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelationshipClass

public IRelationshipClass getRelationshipClass()
                                        throws java.io.IOException,
                                               AutomationException
Description copied from interface: IFeatureLayerDefinition
The current relationship class used to display related fields.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
getRelationshipClass in interface IFeatureLayerDefinition
Returns:
A reference to a com.esri.arcgis.geodatabase.IRelationshipClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelationshipClassByRef

public void setRelationshipClassByRef(IRelationshipClass relClass)
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IFeatureLayerDefinition
The current relationship class used to display related fields.

Specified by:
setRelationshipClassByRef in interface IFeatureLayerDefinition
Parameters:
relClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSearchOrder

public int getSearchOrder()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IFeatureLayerDefinition2
Flag that specifies the search order used when applying a mixed attribute-spatial query.

Specified by:
getSearchOrder in interface IFeatureLayerDefinition2
Returns:
A com.esri.arcgis.geodatabase.esriSearchOrder constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSearchOrder

public void setSearchOrder(int order)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IFeatureLayerDefinition2
Flag that specifies the search order used when applying a mixed attribute-spatial query.

Specified by:
setSearchOrder in interface IFeatureLayerDefinition2
Parameters:
order - A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

find

public IArray find(java.lang.String search,
                   boolean contains,
                   java.lang.Object fields,
                   ITrackCancel trackCancel)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IFind
Finds the specified search string in the given attribute fields.

Supported Platforms

Windows, Solaris, Linux

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.

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

getFindFields

public java.lang.Object getFindFields()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IFind
The attribute fields.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFindFields in interface IFind
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFindDisplayField

public java.lang.String getFindDisplayField()
                                     throws java.io.IOException,
                                            AutomationException
Description copied from interface: IFind
The display field.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFindDisplayField in interface IFind
Returns:
The field
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

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

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

getJoinType

public int getJoinType()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IDisplayRelationshipClass
Join type for the most recent join performed.

Supported Platforms

Windows, Solaris, Linux

Description

Indicates the type of the most recent join.

Specified by:
getJoinType in interface IDisplayRelationshipClass
Returns:
A com.esri.arcgis.geodatabase.esriJoinType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

displayRelationshipClass

public void displayRelationshipClass(IRelationshipClass relClass,
                                     int joinType)
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IDisplayRelationshipClass
Sets a join based on the specified relationship class and join type.

Supported Platforms

Windows, Solaris, Linux

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

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

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ILayerDrawingProperties
Indicates if the layer drawing properties are dirty.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDrawingPropsDirty in interface ILayerDrawingProperties
Returns:
The dirty
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: ILayerDrawingProperties
Indicates if the layer drawing properties are dirty.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDrawingPropsDirty in interface ILayerDrawingProperties
Parameters:
dirty - The dirty (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getLayerWeight

public double getLayerWeight()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ILayerPosition
Default layer position.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:
getLayerWeight in interface ILayerPosition
Returns:
The layerWeight
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ILayerPosition
Default layer position.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLayerWeight in interface ILayerPosition
Parameters:
layerWeight - The layerWeight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ILayerInfo
Small image that represents the layer.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getSmallImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: ILayerInfo
Small image that represents the layer when it is selected.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getSmallSelectedImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ILayerInfo
Large image that represents the layer.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getLargeImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: ILayerInfo
Large image that represents the layer when it is selected.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getLargeSelectedImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

onEvent

public void onEvent(IRasterDataManagementEventsOnEventEvent theEvent)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IRasterDataManagementEvents
Performs operation on the raster data management event.

Supported Platforms

Windows, Solaris, Linux

Specified by:
onEvent in interface IRasterDataManagementEvents
Parameters:
theEvent - The event
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.