|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.esri.arcgis.carto.GdbRasterCatalogLayer
Geodabase RasterCatalog source and display options.
| 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 |
public GdbRasterCatalogLayer()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public GdbRasterCatalogLayer(java.lang.Object obj)
throws java.io.IOException
obj to GdbRasterCatalogLayer. GdbRasterCatalogLayer theGdbRasterCatalogLayer = (GdbRasterCatalogLayer) obj;
obj - an object returned from ArcGIS Engine or Server
java.io.IOException - if there are interop problems| Method Detail |
public static java.lang.String getClsid()
public IGdbRasterCatalogLayer getAsIGdbRasterCatalogLayer()
public ILayer getAsILayer()
public IRasterCatalogDisplayProps getAsIRasterCatalogDisplayProps()
public IGeoDataset getAsIGeoDataset()
public ILegendInfo getAsILegendInfo()
public IPersistStream getAsIPersistStream()
public IIdentify getAsIIdentify()
public IDataLayer getAsIDataLayer()
public ILayerEffects getAsILayerEffects()
public ILayerExtensions getAsILayerExtensions()
public IDisplayAdmin getAsIDisplayAdmin()
public IDisplayAdmin2 getAsIDisplayAdmin2()
public IFeatureLayer getAsIFeatureLayer()
public IGeoFeatureLayer getAsIGeoFeatureLayer()
public IHotlinkContainer getAsIHotlinkContainer()
public IHotlinkMacro getAsIHotlinkMacro()
public IHyperlinkContainer getAsIHyperlinkContainer()
public IIdentify2 getAsIIdentify2()
public ILayerGeneralProperties getAsILayerGeneralProperties()
public ILayerSymbologyExtents getAsILayerSymbologyExtents()
public IRelationshipClassCollection getAsIRelationshipClassCollection()
public IRelationshipClassCollectionEdit getAsIRelationshipClassCollectionEdit()
public ISecureLayer getAsISecureLayer()
public ISymbolLevels getAsISymbolLevels()
public IDisplayFilterManager getAsIDisplayFilterManager()
public IMapLevel getAsIMapLevel()
public ITableFields getAsITableFields()
public IPropertySupport getAsIPropertySupport()
public IFeatureLayer2 getAsIFeatureLayer2()
public IObjectClassSchemaEvents getAsIObjectClassSchemaEvents()
public ILayer2 getAsILayer2()
public IDataset getAsIDataset()
public IClass getAsIClass()
public ITable getAsITable()
public ITableSelection getAsITableSelection()
public IDisplayTable getAsIDisplayTable()
public IAttributeTable getAsIAttributeTable()
public IFeatureSelection getAsIFeatureSelection()
public IDataLayer2 getAsIDataLayer2()
public IFeatureLayerDefinition getAsIFeatureLayerDefinition()
public IFeatureLayerDefinition2 getAsIFeatureLayerDefinition2()
public ITableDefinition getAsITableDefinition()
public ILayerFields getAsILayerFields()
public IFind getAsIFind()
public IConnectionPointContainer getAsIConnectionPointContainer()
public IDisplayRelationshipClass getAsIDisplayRelationshipClass()
public ILayerDrawingProperties getAsILayerDrawingProperties()
public ILayerPosition getAsILayerPosition()
public ILayerInfo getAsILayerInfo()
public IRasterDataManagementEvents getAsIRasterDataManagementEvents()
public boolean equals(java.lang.Object o)
public int hashCode()
public void addILayerEventsListener(ILayerEvents theListener)
throws java.io.IOException
java.io.IOException
public void removeILayerEventsListener(ILayerEvents theListener)
throws java.io.IOException
java.io.IOException
public boolean setup(ITable pTable)
throws java.io.IOException,
AutomationException
IGdbRasterCatalogLayer
setup in interface IGdbRasterCatalogLayerpTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRenderers(IArray ppRenderers)
throws java.io.IOException,
AutomationException
IGdbRasterCatalogLayer
setRenderers in interface IGdbRasterCatalogLayerppRenderers - A reference to a com.esri.arcgis.system.IArray (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray getRenderers()
throws java.io.IOException,
AutomationException
IGdbRasterCatalogLayer
getRenderers in interface IGdbRasterCatalogLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean[] isRendererUsage()
throws java.io.IOException,
AutomationException
IGdbRasterCatalogLayer
isRendererUsage in interface IGdbRasterCatalogLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isDrawSelectedRasters()
throws java.io.IOException,
AutomationException
IGdbRasterCatalogLayer
isDrawSelectedRasters in interface IGdbRasterCatalogLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDrawSelectedRasters(boolean b)
throws java.io.IOException,
AutomationException
IGdbRasterCatalogLayer
setDrawSelectedRasters in interface IGdbRasterCatalogLayerb - The b (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRasterRenderer chooseRenderer(IRaster pRaster)
throws java.io.IOException,
AutomationException
IGdbRasterCatalogLayer
chooseRenderer in interface IGdbRasterCatalogLayerpRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getName()
throws java.io.IOException,
AutomationException
ILayer
Use this property to associate a string with a layer.
getName in interface ILayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setName(java.lang.String name)
throws java.io.IOException,
AutomationException
ILayer
setName in interface ILayername - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isValid()
throws java.io.IOException,
AutomationException
ILayerThe 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.
isValid in interface ILayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getAreaOfInterest()
throws java.io.IOException,
AutomationException
ILayerReturns the spatial-referenced extent of the layer.
getAreaOfInterest in interface ILayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public double getMinimumScale()
throws java.io.IOException,
AutomationException
ILayerSpecifies 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.
getMinimumScale in interface ILayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setMinimumScale(double minScale)
throws java.io.IOException,
AutomationException
ILayer
setMinimumScale in interface ILayerminScale - The minScale (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getMaximumScale()
throws java.io.IOException,
AutomationException
ILayerSpecifies 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.
getMaximumScale in interface ILayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMaximumScale(double maxScale)
throws java.io.IOException,
AutomationException
ILayer
setMaximumScale in interface ILayermaxScale - The maxScale (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isVisible()
throws java.io.IOException,
AutomationException
ILayer
isVisible in interface ILayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setVisible(boolean visible)
throws java.io.IOException,
AutomationException
ILayer
setVisible in interface ILayervisible - The visible (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isShowTips()
throws java.io.IOException,
AutomationException
ILayerIndicates 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.
isShowTips in interface ILayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setShowTips(boolean show)
throws java.io.IOException,
AutomationException
ILayer
setShowTips in interface ILayershow - The show (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getTipText(double x,
double y,
double tolerance)
throws java.io.IOException,
AutomationException
ILayer
getTipText in interface ILayerx - The x (in)y - The y (in)tolerance - The tolerance (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isCached()
throws java.io.IOException,
AutomationException
ILayerThis 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.
isCached in interface ILayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCached(boolean cached)
throws java.io.IOException,
AutomationException
ILayerInformational property. Container is responsible for cache management.
setCached in interface ILayercached - The cached (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getSupportedDrawPhases()
throws java.io.IOException,
AutomationException
ILayerIndicates 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.
getSupportedDrawPhases in interface ILayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSpatialReferenceByRef(ISpatialReference rhs1)
throws java.io.IOException,
AutomationException
ILayer
setSpatialReferenceByRef in interface ILayerrhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void draw(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
throws java.io.IOException,
AutomationException
ILayerThis 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.
draw in interface ILayerdrawPhase - 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getDisplayRasters()
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayPropsThe 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.
getDisplayRasters in interface IRasterCatalogDisplayPropsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDisplayRasters(int pNum)
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
setDisplayRasters in interface IRasterCatalogDisplayPropspNum - The pNum (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISymbol getSymbol()
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayPropsThe Symbol specifies the symbol to be use in rendering a raster catalog’s wire frames.
getSymbol in interface IRasterCatalogDisplayPropsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setSymbolByRef(ISymbol ppSymbol)
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
setSymbolByRef in interface IRasterCatalogDisplayPropsppSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseScale(boolean b)
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayPropsThe 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.
setUseScale in interface IRasterCatalogDisplayPropsb - The b (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isUseScale()
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
isUseScale in interface IRasterCatalogDisplayPropsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setTransitionScale(double scale)
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
setTransitionScale in interface IRasterCatalogDisplayPropsscale - The scale (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public double getTransitionScale()
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
getTransitionScale in interface IRasterCatalogDisplayPropsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isRedrawDisplay()
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayPropsSetting the RedrawDisplay property to be true will redraw raster datasets in the display each time you pan or zoom; the default is false.
isRedrawDisplay in interface IRasterCatalogDisplayPropsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRedrawDisplay(boolean b)
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
setRedrawDisplay in interface IRasterCatalogDisplayPropsb - The b (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getDelayDraw()
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayPropsThe 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.
getDelayDraw in interface IRasterCatalogDisplayPropsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDelayDraw(int ms)
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
setDelayDraw in interface IRasterCatalogDisplayPropsms - The ms (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getResamplingType()
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayPropsThe ResamplingType specifies the resample type used in displaying raster datasets. The default is set to be NearestNeighbor resampling.
getResamplingType in interface IRasterCatalogDisplayPropsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setResamplingType(int pResamplingType)
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
setResamplingType in interface IRasterCatalogDisplayPropspResamplingType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDrawRastersOnly(boolean b)
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
setDrawRastersOnly in interface IRasterCatalogDisplayPropsb - The b (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDrawRastersOnly()
throws java.io.IOException,
AutomationException
IRasterCatalogDisplayProps
isDrawRastersOnly in interface IRasterCatalogDisplayPropsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public ISpatialReference getSpatialReference()
throws java.io.IOException,
AutomationException
IGeoDatasetThis 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.
getSpatialReference in interface IGeoDatasetjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getExtent()
throws java.io.IOException,
AutomationException
IGeoDatasetThe IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.
Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.
If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.
If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.
ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.
getExtent in interface IGeoDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getLegendGroupCount()
throws java.io.IOException,
AutomationException
ILegendInfoThe 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.
getLegendGroupCount in interface ILegendInfoAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public ILegendGroup getLegendGroup(int index)
throws java.io.IOException,
AutomationException
ILegendInfoThe content and number of legend groups is determined by the implementation of the renderer, consequently this property is read only.
getLegendGroup in interface ILegendInfoindex - The index (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILegendItem getLegendItem()
throws java.io.IOException,
AutomationException
ILegendInfoLayer 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.
getLegendItem in interface ILegendInfojava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSymbolsAreGraduated()
throws java.io.IOException,
AutomationException
ILegendInfoIndicates whether the symbols used for a layer or renderer's legend vary by size.
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.
isSymbolsAreGraduated in interface ILegendInfoAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
throws java.io.IOException,
AutomationException
ILegendInfo
setSymbolsAreGraduated in interface ILegendInfosymbolsAreGraduated - The symbolsAreGraduated (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws java.io.IOException,
AutomationException
IPersistStreamIPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws java.io.IOException,
AutomationException
IPersistStreamIPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void save(IStream pstm,
int fClearDirty)
throws java.io.IOException,
AutomationException
IPersistStreamIPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws java.io.IOException,
AutomationException
IPersistStreamIPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void getClassID(GUID[] pClassID)
throws java.io.IOException,
AutomationException
IPersistIPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IArray identify(IGeometry pGeom)
throws java.io.IOException,
AutomationException
IIdentifyWhen 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.
identify in interface IIdentifypGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getDataSourceName()
throws java.io.IOException,
AutomationException
IDataLayer
getDataSourceName in interface IDataLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDataSourceName(IName name)
throws java.io.IOException,
AutomationException
IDataLayer
setDataSourceName in interface IDataLayername - A reference to a com.esri.arcgis.system.IName (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isDataSourceSupported(IName name)
throws java.io.IOException,
AutomationException
IDataLayer
isDataSourceSupported in interface IDataLayername - A reference to a com.esri.arcgis.system.IName (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean connect(IName pOptRepairName)
throws java.io.IOException,
AutomationException
IDataLayer
connect in interface IDataLayerpOptRepairName - A reference to a com.esri.arcgis.system.IName (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getRelativeBase()
throws java.io.IOException,
AutomationException
IDataLayer
getRelativeBase in interface IDataLayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRelativeBase(java.lang.String basePath)
throws java.io.IOException,
AutomationException
IDataLayer
setRelativeBase in interface IDataLayerbasePath - The basePath (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isSupportsTransparency()
throws java.io.IOException,
AutomationException
ILayerEffects
isSupportsTransparency in interface ILayerEffectsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportsContrastChange()
throws java.io.IOException,
AutomationException
ILayerEffects
isSupportsContrastChange in interface ILayerEffectsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isSupportsBrightnessChange()
throws java.io.IOException,
AutomationException
ILayerEffects
isSupportsBrightnessChange in interface ILayerEffectsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setSupportsInteractive(boolean supported)
throws java.io.IOException,
AutomationException
ILayerEffects
setSupportsInteractive in interface ILayerEffectssupported - The supported (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isSupportsInteractive()
throws java.io.IOException,
AutomationException
ILayerEffects
isSupportsInteractive in interface ILayerEffectsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public short getTransparency()
throws java.io.IOException,
AutomationException
ILayerEffects
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.
getTransparency in interface ILayerEffectsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTransparency(short alpha)
throws java.io.IOException,
AutomationException
ILayerEffects
setTransparency in interface ILayerEffectsalpha - The alpha (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public short getContrast()
throws java.io.IOException,
AutomationException
ILayerEffects
getContrast in interface ILayerEffectsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setContrast(short contrastValue)
throws java.io.IOException,
AutomationException
ILayerEffects
setContrast in interface ILayerEffectscontrastValue - The contrastValue (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public short getBrightness()
throws java.io.IOException,
AutomationException
ILayerEffects
getBrightness in interface ILayerEffectsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setBrightness(short brightnessValue)
throws java.io.IOException,
AutomationException
ILayerEffects
setBrightness in interface ILayerEffectsbrightnessValue - The brightnessValue (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getExtensionCount()
throws java.io.IOException,
AutomationException
ILayerExtensions
getExtensionCount in interface ILayerExtensionsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.Object getExtension(int index)
throws java.io.IOException,
AutomationException
ILayerExtensions
getExtension in interface ILayerExtensionsindex - The index (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void addExtension(java.lang.Object ext)
throws java.io.IOException,
AutomationException
ILayerExtensions
addExtension in interface ILayerExtensionsext - A reference to another Object (IUnknown) (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void removeExtension(int index)
throws java.io.IOException,
AutomationException
ILayerExtensions
removeExtension in interface ILayerExtensionsindex - The index (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isUsesFilter()
throws java.io.IOException,
AutomationException
IDisplayAdminThe 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.
isUsesFilter in interface IDisplayAdminjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isRequiresBanding()
throws java.io.IOException,
AutomationException
IDisplayAdmin2
isRequiresBanding in interface IDisplayAdmin2AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isDoesBlending()
throws java.io.IOException,
AutomationException
IDisplayAdmin2
isDoesBlending in interface IDisplayAdmin2AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IFeatureClass getFeatureClass()
throws java.io.IOException,
AutomationException
IFeatureLayerThe FeatureClass data source for the layer.
getFeatureClass in interface IFeatureLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setFeatureClassByRef(IFeatureClass fclass)
throws java.io.IOException,
AutomationException
IFeatureLayer
setFeatureClassByRef in interface IFeatureLayerfclass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getDataSourceType()
throws java.io.IOException,
AutomationException
IFeatureLayerDescribes 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:"
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" |
getDataSourceType in interface IFeatureLayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDataSourceType(java.lang.String text)
throws java.io.IOException,
AutomationException
IFeatureLayer
setDataSourceType in interface IFeatureLayertext - The text (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getDisplayField()
throws java.io.IOException,
AutomationException
IFeatureLayerThe name of the layer's primary display field.
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.
getDisplayField in interface IFeatureLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDisplayField(java.lang.String fieldName)
throws java.io.IOException,
AutomationException
IFeatureLayer
setDisplayField in interface IFeatureLayerfieldName - The fieldName (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isSelectable()
throws java.io.IOException,
AutomationException
IFeatureLayerIndicates whether the layer's features are selectable.
The default value for Selectable is False.
isSelectable in interface IFeatureLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setSelectable(boolean value)
throws java.io.IOException,
AutomationException
IFeatureLayer
setSelectable in interface IFeatureLayervalue - The value (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFeatureCursor search(IQueryFilter queryFilter,
boolean recycling)
throws java.io.IOException,
AutomationException
IFeatureLayerUse this method to return a read-only cursor of the layer's features.
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.
search in interface IFeatureLayerqueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isScaleSymbols()
throws java.io.IOException,
AutomationException
IFeatureLayerIndicates 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.
isScaleSymbols in interface IFeatureLayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setScaleSymbols(boolean scale)
throws java.io.IOException,
AutomationException
IFeatureLayer
setScaleSymbols in interface IFeatureLayerscale - The scale (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IFeatureRenderer getRenderer()
throws java.io.IOException,
AutomationException
IGeoFeatureLayer
getRenderer in interface IGeoFeatureLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setRendererByRef(IFeatureRenderer renderer)
throws java.io.IOException,
AutomationException
IGeoFeatureLayer
setRendererByRef in interface IGeoFeatureLayerrenderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IUID getRendererPropertyPageClassID()
throws java.io.IOException,
AutomationException
IGeoFeatureLayer
getRendererPropertyPageClassID in interface IGeoFeatureLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setRendererPropertyPageClassID(IUID clsid)
throws java.io.IOException,
AutomationException
IGeoFeatureLayer
setRendererPropertyPageClassID in interface IGeoFeatureLayerclsid - A reference to a com.esri.arcgis.system.IUID (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isDisplayAnnotation()
throws java.io.IOException,
AutomationException
IGeoFeatureLayerIndicates 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.
isDisplayAnnotation in interface IGeoFeatureLayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDisplayAnnotation(boolean value)
throws java.io.IOException,
AutomationException
IGeoFeatureLayer
setDisplayAnnotation in interface IGeoFeatureLayervalue - The value (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getAnnotationPropertiesID()
throws java.io.IOException,
AutomationException
IGeoFeatureLayerIndicates the CLSID of the labeling properties used to label the layer.
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.
getAnnotationPropertiesID in interface IGeoFeatureLayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAnnotationPropertiesIDByRef(IUID uid)
throws java.io.IOException,
AutomationException
IGeoFeatureLayer
setAnnotationPropertiesIDByRef in interface IGeoFeatureLayeruid - A reference to a com.esri.arcgis.system.IUID (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IAnnotateLayerPropertiesCollection getAnnotationProperties()
throws java.io.IOException,
AutomationException
IGeoFeatureLayerProvides access to the labeling properites for the layer.
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.
getAnnotationProperties in interface IGeoFeatureLayerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setAnnotationProperties(IAnnotateLayerPropertiesCollection props)
throws java.io.IOException,
AutomationException
IGeoFeatureLayer
setAnnotationProperties in interface IGeoFeatureLayerprops - A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setCurrentMapLevel(int rhs1)
throws java.io.IOException,
AutomationException
IGeoFeatureLayerWhen 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.
setCurrentMapLevel in interface IGeoFeatureLayerrhs1 - The rhs1 (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IFeatureIDSet getExclusionSet()
throws java.io.IOException,
AutomationException
IGeoFeatureLayerProvides 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.
getExclusionSet in interface IGeoFeatureLayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExclusionSetByRef(IFeatureIDSet fids)
throws java.io.IOException,
AutomationException
IGeoFeatureLayer
setExclusionSetByRef in interface IGeoFeatureLayerfids - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IFeatureClass getDisplayFeatureClass()
throws java.io.IOException,
AutomationException
IGeoFeatureLayerProvides access to an IFeatureClass object that contains joined fields if present on the layer.
getDisplayFeatureClass in interface IGeoFeatureLayerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFeatureCursor searchDisplayFeatures(IQueryFilter queryFilter,
boolean recycling)
throws java.io.IOException,
AutomationException
IGeoFeatureLayerSearchDisplayFeatures 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.
searchDisplayFeatures in interface IGeoFeatureLayerqueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getHotlinkField()
throws java.io.IOException,
AutomationException
IHotlinkContainer
getHotlinkField in interface IHotlinkContainerAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setHotlinkField(java.lang.String fieldName)
throws java.io.IOException,
AutomationException
IHotlinkContainer
setHotlinkField in interface IHotlinkContainerfieldName - The fieldName (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getHotlinkType()
throws java.io.IOException,
AutomationException
IHotlinkContainer
getHotlinkType in interface IHotlinkContainerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setHotlinkType(int linkType)
throws java.io.IOException,
AutomationException
IHotlinkContainer
setHotlinkType in interface IHotlinkContainerlinkType - A com.esri.arcgis.carto.esriHyperlinkType constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getMacroName()
throws java.io.IOException,
AutomationException
IHotlinkMacro
getMacroName in interface IHotlinkMacrojava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMacroName(java.lang.String name)
throws java.io.IOException,
AutomationException
IHotlinkMacro
setMacroName in interface IHotlinkMacroname - The name (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getHyperlinkCount()
throws java.io.IOException,
AutomationException
IHyperlinkContainer
getHyperlinkCount in interface IHyperlinkContainerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IHyperlink getHyperlink(int index)
throws java.io.IOException,
AutomationException
IHyperlinkContainer
getHyperlink in interface IHyperlinkContainerindex - The index (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setHyperlinkByRef(int index,
IHyperlink link)
throws java.io.IOException,
AutomationException
IHyperlinkContainer
setHyperlinkByRef in interface IHyperlinkContainerindex - The index (in)link - A reference to a com.esri.arcgis.carto.IHyperlink (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addHyperlink(IHyperlink link)
throws java.io.IOException,
AutomationException
IHyperlinkContainer
addHyperlink in interface IHyperlinkContainerlink - A reference to a com.esri.arcgis.carto.IHyperlink (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void removeHyperlink(int index)
throws java.io.IOException,
AutomationException
IHyperlinkContainer
removeHyperlink in interface IHyperlinkContainerindex - The index (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IArray identify(IGeometry pGeom,
ITrackCancel pTrackCancel)
throws java.io.IOException,
AutomationException
IIdentify2When 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.
identify in interface IIdentify2pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setScale(double rhs1)
throws java.io.IOException,
AutomationException
IIdentify2
setScale in interface IIdentify2rhs1 - The rhs1 (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public double getLastMinimumScale()
throws java.io.IOException,
AutomationException
ILayerGeneralProperties
getLastMinimumScale in interface ILayerGeneralPropertiesAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public double getLastMaximumScale()
throws java.io.IOException,
AutomationException
ILayerGeneralProperties
getLastMaximumScale in interface ILayerGeneralPropertiesAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String ILayerGeneralProperties_getLayerDescription()
throws java.io.IOException,
AutomationException
ILayerGeneralProperties
ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralPropertiesjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLayerDescription(java.lang.String text)
throws java.io.IOException,
AutomationException
ILayerGeneralProperties
setLayerDescription in interface ILayerGeneralPropertiestext - The text (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void expandRegionForSymbols(IDisplay pDisplay,
IGeometry pRegion)
throws java.io.IOException,
AutomationException
ILayerSymbologyExtents
expandRegionForSymbols in interface ILayerSymbologyExtentspDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)pRegion - A reference to a com.esri.arcgis.geometry.IGeometry (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumRelationshipClass getRelationshipClasses()
throws java.io.IOException,
AutomationException
IRelationshipClassCollection
getRelationshipClasses in interface IRelationshipClassCollectionAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass,
int role)
throws java.io.IOException,
AutomationException
IRelationshipClassCollection
findRelationshipClasses in interface IRelationshipClassCollectionobjectClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void addRelationshipClass(IRelationshipClass relationshipClass)
throws java.io.IOException,
AutomationException
IRelationshipClassCollectionEdit
addRelationshipClass in interface IRelationshipClassCollectionEditrelationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void removeRelationshipClass(IRelationshipClass relationshipClass)
throws java.io.IOException,
AutomationException
IRelationshipClassCollectionEdit
removeRelationshipClass in interface IRelationshipClassCollectionEditrelationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void removeAllRelationshipClasses()
throws java.io.IOException,
AutomationException
IRelationshipClassCollectionEdit
removeAllRelationshipClasses in interface IRelationshipClassCollectionEditAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void clearPassword(boolean bForceReconnect)
throws java.io.IOException,
AutomationException
ISecureLayer
clearPassword in interface ISecureLayerbForceReconnect - The bForceReconnect (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isUseSymbolLevels()
throws java.io.IOException,
AutomationException
ISymbolLevels
isUseSymbolLevels in interface ISymbolLevelsAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setUseSymbolLevels(boolean useSymbolLevels)
throws java.io.IOException,
AutomationException
ISymbolLevels
setUseSymbolLevels in interface ISymbolLevelsuseSymbolLevels - The useSymbolLevels (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDisplayFilter(IDisplayFilter displayFilter)
throws java.io.IOException,
AutomationException
IDisplayFilterManager
setDisplayFilter in interface IDisplayFilterManagerdisplayFilter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IDisplayFilter getDisplayFilter()
throws java.io.IOException,
AutomationException
IDisplayFilterManager
getDisplayFilter in interface IDisplayFilterManagerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getMapLevel()
throws java.io.IOException,
AutomationException
IMapLevel
getMapLevel in interface IMapLevelAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setMapLevel(int mapLevel)
throws java.io.IOException,
AutomationException
IMapLevel
setMapLevel in interface IMapLevelmapLevel - The mapLevel (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getFieldCount()
throws java.io.IOException,
AutomationException
ITableFields
getFieldCount in interface ITableFieldsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IField getField(int index)
throws java.io.IOException,
AutomationException
ITableFields
getField in interface ITableFieldsindex - The index (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFieldInfo getFieldInfo(int index)
throws java.io.IOException,
AutomationException
ITableFields
getFieldInfo in interface ITableFieldsindex - The index (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int findField(java.lang.String fieldName)
throws java.io.IOException,
AutomationException
ITableFields
findField in interface ITableFieldsfieldName - The fieldName (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean applies(java.lang.Object pUnk)
throws java.io.IOException,
AutomationException
IPropertySupportApplies 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.
applies in interface IPropertySupportpUnk - A reference to another Object (IUnknown) (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean canApply(java.lang.Object pUnk)
throws java.io.IOException,
AutomationException
IPropertySupportCanApply 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.
canApply in interface IPropertySupportpUnk - A reference to another Object (IUnknown) (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.Object getCurrent(java.lang.Object pUnk)
throws java.io.IOException,
AutomationException
IPropertySupportCurrent 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.
getCurrent in interface IPropertySupportpUnk - A reference to another Object (IUnknown) (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.Object apply(java.lang.Object newObject)
throws java.io.IOException,
AutomationException
IPropertySupportApply 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.
apply in interface IPropertySupportnewObject - A reference to another Object (IUnknown) (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getShapeType()
throws java.io.IOException,
AutomationException
IFeatureLayer2Returns the basic geometry type of the layer's underlying feature class. See IFeatureClass::ShapeType for more information.
getShapeType in interface IFeatureLayer2AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
throws java.io.IOException,
AutomationException
IObjectClassSchemaEvents
onAddField in interface IObjectClassSchemaEventstheEvent - The event
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
throws java.io.IOException,
AutomationException
IObjectClassSchemaEvents
onDeleteField in interface IObjectClassSchemaEventstheEvent - The event
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
throws java.io.IOException,
AutomationException
IObjectClassSchemaEvents
onBehaviorChanged in interface IObjectClassSchemaEventstheEvent - The event
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isScaleRangeReadOnly()
throws java.io.IOException,
AutomationException
ILayer2Some layer types do not support a writeable MinimumScale or MaximumScale. Use this property to determine whether or not a layer supports this.
isScaleRangeReadOnly in interface ILayer2AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setAreaOfInterest(IEnvelope aoi)
throws java.io.IOException,
AutomationException
ILayer2
setAreaOfInterest in interface ILayer2aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getFullName()
throws java.io.IOException,
AutomationException
IDataset
getFullName in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getBrowseName()
throws java.io.IOException,
AutomationException
IDataset
getBrowseName in interface IDatasetjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBrowseName(java.lang.String name)
throws java.io.IOException,
AutomationException
IDataset
setBrowseName in interface IDatasetname - The name (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getType()
throws java.io.IOException,
AutomationException
IDataset
getType in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getCategory()
throws java.io.IOException,
AutomationException
IDatasetIDataset::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.
getCategory in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnumDataset getSubsets()
throws java.io.IOException,
AutomationException
IDatasetThe Subsets property returns other Dataset objects contained in this dataset.
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.
getSubsets in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IWorkspace getWorkspace()
throws java.io.IOException,
AutomationException
IDatasetThe Workspace property returns the containing workspace for this dataset.
getWorkspace in interface IDatasetjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getPropertySet()
throws java.io.IOException,
AutomationException
IDatasetThe 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.
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.
getPropertySet in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean canCopy()
throws java.io.IOException,
AutomationException
IDatasetThe 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:
canCopy in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IDataset copy(java.lang.String copyName,
IWorkspace copyWorkspace)
throws java.io.IOException,
AutomationException
IDatasetIDataset::Copy does not support the copying of Graph objects such as a Geometric Network.
copy in interface IDatasetcopyName - The copyName (in)copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.GeoDBDataTransfer
public boolean canDelete()
throws java.io.IOException,
AutomationException
IDatasetThe 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.
canDelete in interface IDatasetjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void delete()
throws java.io.IOException,
AutomationException
IDatasetCertain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
delete in interface IDatasetAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean canRename()
throws java.io.IOException,
AutomationException
IDatasetThe 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.
canRename in interface IDatasetjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void rename(java.lang.String name)
throws java.io.IOException,
AutomationException
IDatasetIDataset::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.
rename in interface IDatasetname - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getFields()
throws java.io.IOException,
AutomationException
IClass
getFields in interface IClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IIndexes getIndexes()
throws java.io.IOException,
AutomationException
IClass
getIndexes in interface IClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addField(IField field)
throws java.io.IOException,
AutomationException
IClass
addField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteField(IField field)
throws java.io.IOException,
AutomationException
IClassDeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:
deleteField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addIndex(IIndex index)
throws java.io.IOException,
AutomationException
IClass
addIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteIndex(IIndex index)
throws java.io.IOException,
AutomationException
IClass
deleteIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isHasOID()
throws java.io.IOException,
AutomationException
IClass
isHasOID in interface IClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getOIDFieldName()
throws java.io.IOException,
AutomationException
IClass
getOIDFieldName in interface IClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IUID getCLSID()
throws java.io.IOException,
AutomationException
IClass
getCLSID in interface IClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getEXTCLSID()
throws java.io.IOException,
AutomationException
IClass
getEXTCLSID in interface IClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.Object getExtension()
throws java.io.IOException,
AutomationException
IClass
getExtension in interface IClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getExtensionProperties()
throws java.io.IOException,
AutomationException
IClass
getExtensionProperties in interface IClassAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IRow createRow()
throws java.io.IOException,
AutomationException
ITableThe 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.
createRow in interface ITablejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRow getRow(int oID)
throws java.io.IOException,
AutomationException
ITableThe 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.
getRow in interface ITableoID - The oID (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor getRows(java.lang.Object oids,
boolean recycling)
throws java.io.IOException,
AutomationException
ITableThe 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.
getRows in interface ITableoids - A Variant (in)recycling - The recycling (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IRowBuffer createRowBuffer()
throws java.io.IOException,
AutomationException
ITableThe 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.
createRowBuffer in interface ITableAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void updateSearchedRows(IQueryFilter queryFilter,
IRowBuffer buffer)
throws java.io.IOException,
AutomationException
ITableAll edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
updateSearchedRows in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void deleteSearchedRows(IQueryFilter queryFilter)
throws java.io.IOException,
AutomationException
ITable
deleteSearchedRows in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int rowCount(IQueryFilter queryFilter)
throws java.io.IOException,
AutomationException
ITable
rowCount in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor ITable_search(IQueryFilter queryFilter,
boolean recycling)
throws java.io.IOException,
AutomationException
ITable
ITable_search in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor update(IQueryFilter queryFilter,
boolean recycling)
throws java.io.IOException,
AutomationException
ITableThe 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.
update in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor insert(boolean useBuffering)
throws java.io.IOException,
AutomationException
ITableThe 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.
insert in interface ITableuseBuffering - The useBuffering (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet select(IQueryFilter queryFilter,
int selType,
int selOption,
IWorkspace selectionContainer)
throws java.io.IOException,
AutomationException
ITableThe 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.
select in interface ITablequeryFilter - 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet getSelectionSet()
throws java.io.IOException,
AutomationException
ITableSelection
getSelectionSet in interface ITableSelectionAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setSelectionSetByRef(ISelectionSet selectionSet)
throws java.io.IOException,
AutomationException
ITableSelection
setSelectionSetByRef in interface ITableSelectionselectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addRow(IRow row)
throws java.io.IOException,
AutomationException
ITableSelection
addRow in interface ITableSelectionrow - A reference to a com.esri.arcgis.geodatabase.IRow (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void selectRows(IQueryFilter filter,
int method,
boolean justOne)
throws java.io.IOException,
AutomationException
ITableSelectionThe justOne parameter tells the search to stop once it has found one feature.
selectRows in interface ITableSelectionfilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)justOne - The justOne (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void clear()
throws java.io.IOException,
AutomationException
ITableSelection
clear in interface ITableSelectionAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void selectionChanged()
throws java.io.IOException,
AutomationException
ITableSelection
selectionChanged in interface ITableSelectionjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable getDisplayTable()
throws java.io.IOException,
AutomationException
IDisplayTable
getDisplayTable in interface IDisplayTablejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor searchDisplayTable(IQueryFilter pQueryFilter,
boolean recycling)
throws java.io.IOException,
AutomationException
IDisplayTable
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.
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.
searchDisplayTable in interface IDisplayTablepQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter,
int selType,
int selOption,
IWorkspace pSelWorkspace)
throws java.io.IOException,
AutomationException
IDisplayTable
selectDisplayTable in interface IDisplayTablepQueryFilter - 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public ISelectionSet getDisplaySelectionSet()
throws java.io.IOException,
AutomationException
IDisplayTable
getDisplaySelectionSet in interface IDisplayTablejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable getAttributeTable()
throws java.io.IOException,
AutomationException
IAttributeTable
getAttributeTable in interface IAttributeTableAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getCombinationMethod()
throws java.io.IOException,
AutomationException
IFeatureSelection
getCombinationMethod in interface IFeatureSelectionjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCombinationMethod(int method)
throws java.io.IOException,
AutomationException
IFeatureSelection
setCombinationMethod in interface IFeatureSelectionmethod - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public double getBufferDistance()
throws java.io.IOException,
AutomationException
IFeatureSelection
getBufferDistance in interface IFeatureSelectionAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setBufferDistance(double distance)
throws java.io.IOException,
AutomationException
IFeatureSelection
setBufferDistance in interface IFeatureSelectiondistance - The distance (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isSetSelectionSymbol()
throws java.io.IOException,
AutomationException
IFeatureSelection
isSetSelectionSymbol in interface IFeatureSelectionjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSetSelectionSymbol(boolean setSymbol)
throws java.io.IOException,
AutomationException
IFeatureSelection
setSetSelectionSymbol in interface IFeatureSelectionsetSymbol - The setSymbol (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IColor getSelectionColor()
throws java.io.IOException,
AutomationException
IFeatureSelection
getSelectionColor in interface IFeatureSelectionjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSelectionColorByRef(IColor color)
throws java.io.IOException,
AutomationException
IFeatureSelection
setSelectionColorByRef in interface IFeatureSelectioncolor - A reference to a com.esri.arcgis.display.IColor (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public ISymbol getSelectionSymbol()
throws java.io.IOException,
AutomationException
IFeatureSelection
getSelectionSymbol in interface IFeatureSelectionAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setSelectionSymbolByRef(ISymbol symbol)
throws java.io.IOException,
AutomationException
IFeatureSelection
setSelectionSymbolByRef in interface IFeatureSelectionsymbol - A reference to a com.esri.arcgis.display.ISymbol (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void add(IFeature feature)
throws java.io.IOException,
AutomationException
IFeatureSelection
add in interface IFeatureSelectionfeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void selectFeatures(IQueryFilter filter,
int method,
boolean justOne)
throws java.io.IOException,
AutomationException
IFeatureSelection
selectFeatures in interface IFeatureSelectionfilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)justOne - The justOne (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void disconnect()
throws java.io.IOException,
AutomationException
IDataLayer2
disconnect in interface IDataLayer2java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean inWorkspace(IWorkspace workspace)
throws java.io.IOException,
AutomationException
IDataLayer2
inWorkspace in interface IDataLayer2workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getDefinitionExpression()
throws java.io.IOException,
AutomationException
IFeatureLayerDefinition
getDefinitionExpression in interface IFeatureLayerDefinitionjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefinitionExpression(java.lang.String expression)
throws java.io.IOException,
AutomationException
IFeatureLayerDefinition
setDefinitionExpression in interface IFeatureLayerDefinitionexpression - The expression (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public ISelectionSet getDefinitionSelectionSet()
throws java.io.IOException,
AutomationException
IFeatureLayerDefinitionYou 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.
getDefinitionSelectionSet in interface IFeatureLayerDefinitionAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IFeatureLayer createSelectionLayer(java.lang.String layerName,
boolean useCurrentSelection,
java.lang.String joinTableNames,
java.lang.String expression)
throws java.io.IOException,
AutomationException
IFeatureLayerDefinition
createSelectionLayer in interface IFeatureLayerDefinitionlayerName - The layerName (in)useCurrentSelection - The useCurrentSelection (in)joinTableNames - The joinTableNames (in)expression - The expression (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRelationshipClass getRelationshipClass()
throws java.io.IOException,
AutomationException
IFeatureLayerDefinitionRelClass must be a defined relationship class on the base feature class.
getRelationshipClass in interface IFeatureLayerDefinitionjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRelationshipClassByRef(IRelationshipClass relClass)
throws java.io.IOException,
AutomationException
IFeatureLayerDefinition
setRelationshipClassByRef in interface IFeatureLayerDefinitionrelClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getSearchOrder()
throws java.io.IOException,
AutomationException
IFeatureLayerDefinition2
getSearchOrder in interface IFeatureLayerDefinition2java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSearchOrder(int order)
throws java.io.IOException,
AutomationException
IFeatureLayerDefinition2
setSearchOrder in interface IFeatureLayerDefinition2order - A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray find(java.lang.String search,
boolean contains,
java.lang.Object fields,
ITrackCancel trackCancel)
throws java.io.IOException,
AutomationException
IFindThis 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.
find in interface IFindsearch - The search (in)contains - The contains (in)fields - A Variant (in)trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.Object getFindFields()
throws java.io.IOException,
AutomationException
IFind
getFindFields in interface IFindjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getFindDisplayField()
throws java.io.IOException,
AutomationException
IFind
getFindDisplayField in interface IFindjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
throws java.io.IOException,
AutomationException
IConnectionPointContainerIConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints in interface IConnectionPointContainerppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
throws java.io.IOException,
AutomationException
IConnectionPointContainerIConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint in interface IConnectionPointContainerriid - 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getJoinType()
throws java.io.IOException,
AutomationException
IDisplayRelationshipClassIndicates the type of the most recent join.
getJoinType in interface IDisplayRelationshipClassjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void displayRelationshipClass(IRelationshipClass relClass,
int joinType)
throws java.io.IOException,
AutomationException
IDisplayRelationshipClassRelClass can be either a file or memory based relationship class, but must be defined on the base feature class.
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
displayRelationshipClass in interface IDisplayRelationshipClassrelClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)joinType - A com.esri.arcgis.geodatabase.esriJoinType constant (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isDrawingPropsDirty()
throws java.io.IOException,
AutomationException
ILayerDrawingProperties
isDrawingPropsDirty in interface ILayerDrawingPropertiesAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setDrawingPropsDirty(boolean dirty)
throws java.io.IOException,
AutomationException
ILayerDrawingProperties
setDrawingPropsDirty in interface ILayerDrawingPropertiesdirty - The dirty (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public double getLayerWeight()
throws java.io.IOException,
AutomationException
ILayerPositionThe 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
getLayerWeight in interface ILayerPositionAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setLayerWeight(double layerWeight)
throws java.io.IOException,
AutomationException
ILayerPosition
setLayerWeight in interface ILayerPositionlayerWeight - The layerWeight (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSmallImage()
throws java.io.IOException,
AutomationException
ILayerInfoThe icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.
getSmallImage in interface ILayerInfoAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getSmallSelectedImage()
throws java.io.IOException,
AutomationException
ILayerInfoThe icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.
getSmallSelectedImage in interface ILayerInfojava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLargeImage()
throws java.io.IOException,
AutomationException
ILayerInfoThe icon used to represent the layer in ArcCatalog's 'Large Icon' view.
getLargeImage in interface ILayerInfoAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getLargeSelectedImage()
throws java.io.IOException,
AutomationException
ILayerInfoThe icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.
getLargeSelectedImage in interface ILayerInfoAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void onEvent(IRasterDataManagementEventsOnEventEvent theEvent)
throws java.io.IOException,
AutomationException
IRasterDataManagementEvents
onEvent in interface IRasterDataManagementEventstheEvent - The event
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||