|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IDisplayTable
Provides access to members that work with the display table associated with a standalone table.
This interface provides access to the table used for display purposes for layers and standalone tables. This table can be different from the table of the layer's data source in that it may contain joined fields. For example the table that you access through IFeatureLayer::FeatureClass will not have joined fields, but the table you access through IDisplayTable::DisplayTable will.
DisplayTable is a RelQueryTable. In addition to providing access to this object, IDisplayTable has methods and a property to perform searches and selections on the display table. If you want your code to be generic enough to work on different types of layers and standalone tables, you should perform selections and searches using the methods on IDisplayTable rather than similar methods on other interfaces.
| Method Summary | |
|---|---|
ISelectionSet |
getDisplaySelectionSet()
The selected set of rows from the display table. |
ITable |
getDisplayTable()
The display table. |
ICursor |
searchDisplayTable(IQueryFilter pQueryFilter,
boolean recycling)
Creates a cursor from the display table based upon the search criteria. |
ISelectionSet |
selectDisplayTable(IQueryFilter pQueryFilter,
int selType,
int selOption,
IWorkspace pSelWorkspace)
Creates a selection set from the display table based upon the search criteria. |
| Method Detail |
|---|
ITable getDisplayTable()
throws IOException,
AutomationException
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ICursor searchDisplayTable(IQueryFilter pQueryFilter,
boolean recycling)
throws IOException,
AutomationException
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.
pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter,
int selType,
int selOption,
IWorkspace pSelWorkspace)
throws IOException,
AutomationException
pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)pSelWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ISelectionSet getDisplaySelectionSet()
throws IOException,
AutomationException
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||