Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geodatabase
Interface ITableSort

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ITableSort2
All Known Implementing Classes:
ITableSort2Proxy, ITableSortProxy, TableSort
public interface ITableSort
extends java.io.Serializable

COM Interface 'ITableSort'. Generated 3/19/2015 1:20:56 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members that return and modify information to sort a table.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID2d0f935e_32f5_11d2_a06f_0000f8775bf9
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int getIDByIndex(int index)
          A id by its index value.
 IEnumIDs getIDs()
          List of sorted IDs.
 IQueryFilter getQueryFilter()
          The query filter on table or selection set.
 ICursor getRows()
          Cursor of sorted rows.
 ISelectionSet getSelectionSet()
          The selection set as a source of the data to sort on.
 ITable getTable()
          The table as a source of the data to sort on.
 void setAscending(java.lang.String field, boolean rhs2)
          Field sort order.
 void setCaseSensitive(java.lang.String field, boolean rhs2)
          Character fields case sensitive.
 void setCompareByRef(ITableSortCallBack rhs1)
          Compare call back interface.
 void setCursorByRef(ICursor rhs1)
          The cursor of the data to sort on.
 void setFields(java.lang.String rhs1)
          Comma list of field names to sort on.
 void setQueryFilterByRef(IQueryFilter queryFilter)
          The query filter on table or selection set.
 void setSelectionSetByRef(ISelectionSet selectionSet)
          The selection set as a source of the data to sort on.
 void setSortCharacters(java.lang.String field, int rhs2)
          Number of characters to sort on, for string fields.
 void setTableByRef(ITable table)
          The table as a source of the data to sort on.
 void sort(ITrackCancel trackCancel)
          Sort rows.
 

Field Detail

IID2d0f935e_32f5_11d2_a06f_0000f8775bf9

static final int IID2d0f935e_32f5_11d2_a06f_0000f8775bf9
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

setTableByRef

void setTableByRef(ITable table)
                   throws java.io.IOException,
                          AutomationException
The table as a source of the data to sort on.

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

setSelectionSetByRef

void setSelectionSetByRef(ISelectionSet selectionSet)
                          throws java.io.IOException,
                                 AutomationException
The selection set as a source of the data to sort on. Cancels Cursor.

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

setCursorByRef

void setCursorByRef(ICursor rhs1)
                    throws java.io.IOException,
                           AutomationException
The cursor of the data to sort on. Ensure that sorting fields are available. Cancels SelectionSet.

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

setQueryFilterByRef

void setQueryFilterByRef(IQueryFilter queryFilter)
                         throws java.io.IOException,
                                AutomationException
The query filter on table or selection set.

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

getQueryFilter

IQueryFilter getQueryFilter()
                            throws java.io.IOException,
                                   AutomationException
The query filter on table or selection set.

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

setFields

void setFields(java.lang.String rhs1)
               throws java.io.IOException,
                      AutomationException
Comma list of field names to sort on.

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

setAscending

void setAscending(java.lang.String field,
                  boolean rhs2)
                  throws java.io.IOException,
                         AutomationException
Field sort order.

Parameters:
field - The field (in)
rhs2 - The rhs2 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSortCharacters

void setSortCharacters(java.lang.String field,
                       int rhs2)
                       throws java.io.IOException,
                              AutomationException
Number of characters to sort on, for string fields. A null (default) sorts on the whole string.

Parameters:
field - The field (in)
rhs2 - The rhs2 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCaseSensitive

void setCaseSensitive(java.lang.String field,
                      boolean rhs2)
                      throws java.io.IOException,
                             AutomationException
Character fields case sensitive. Default: False.

Parameters:
field - The field (in)
rhs2 - The rhs2 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCompareByRef

void setCompareByRef(ITableSortCallBack rhs1)
                     throws java.io.IOException,
                            AutomationException
Compare call back interface. Specify Null (default) for normal behavior.

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

getIDs

IEnumIDs getIDs()
                throws java.io.IOException,
                       AutomationException
List of sorted IDs.

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

getRows

ICursor getRows()
                throws java.io.IOException,
                       AutomationException
Cursor of sorted rows.

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

sort

void sort(ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException
Sort rows.

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

getIDByIndex

int getIDByIndex(int index)
                 throws java.io.IOException,
                        AutomationException
A id by its index value.

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

getTable

ITable getTable()
                throws java.io.IOException,
                       AutomationException
The table as a source of the data to sort on.

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

getSelectionSet

ISelectionSet getSelectionSet()
                              throws java.io.IOException,
                                     AutomationException
The selection set as a source of the data to sort on. Cancels Cursor.

Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD