com.esri.arcgis.geodatabase

Class TableSort

java.lang.Object

com.esri.arcgis.geodatabase.TableSort

All Implemented Interfaces:

ITableSort, ITableSort2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class TableSort
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITableSort, ITableSort2

COM Class 'TableSort'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Esri Table Sort object.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabase.ITableSort2

IID, IID56e3ea76_9373_40f8_9868_6aad5bb1c2b3, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ITableSort

IID2d0f935e_32f5_11d2_a06f_0000f8775bf9

Constructor Summary

Constructors

Constructor and Description
TableSort() Constructs a TableSort using ArcGIS Engine.
TableSort(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TableSort theTableSort = (TableSort) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
long	getIDByIndex(int index) A id by its index value.
IEnumIDs	getIDs() List of sorted IDs.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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.
int	hashCode() the hashcode for this object
void	release() Release this COM object reference
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	setSortByCodedValueDescription(java.lang.String field, boolean rhs2) Field sort order by coded value description.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableSort

public TableSort()
          throws java.io.IOException,
                 java.net.UnknownHostException

Constructs a TableSort using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TableSort

public TableSort(java.lang.Object obj)
          throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setTableByRef

public void setTableByRef(ITable table)
                   throws java.io.IOException,
                          AutomationException

The table as a source of the data to sort on.

Specified by:

setTableByRef in interface ITableSort

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

public void setSelectionSetByRef(ISelectionSet selectionSet)
                          throws java.io.IOException,
                                 AutomationException

The selection set as a source of the data to sort on. Cancels Cursor.

Specified by:

setSelectionSetByRef in interface ITableSort

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

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

Specified by:

setCursorByRef in interface ITableSort

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

public void setQueryFilterByRef(IQueryFilter queryFilter)
                         throws java.io.IOException,
                                AutomationException

The query filter on table or selection set.

Specified by:

setQueryFilterByRef in interface ITableSort

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

public IQueryFilter getQueryFilter()
                            throws java.io.IOException,
                                   AutomationException

The query filter on table or selection set.

Specified by:

getQueryFilter in interface ITableSort

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

public void setFields(java.lang.String rhs1)
               throws java.io.IOException,
                      AutomationException

Comma list of field names to sort on.

Specified by:

setFields in interface ITableSort

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAscending

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

Field sort order.

Specified by:

setAscending in interface ITableSort

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

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

Specified by:

setSortCharacters in interface ITableSort

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

public void setCaseSensitive(java.lang.String field,
                             boolean rhs2)
                      throws java.io.IOException,
                             AutomationException

Character fields case sensitive. Default: False.

Specified by:

setCaseSensitive in interface ITableSort

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

public void setCompareByRef(ITableSortCallBack rhs1)
                     throws java.io.IOException,
                            AutomationException

Compare call back interface. Specify Null (default) for normal behavior.

Specified by:

setCompareByRef in interface ITableSort

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

public IEnumIDs getIDs()
                throws java.io.IOException,
                       AutomationException

List of sorted IDs.

Specified by:

getIDs in interface ITableSort

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

public ICursor getRows()
                throws java.io.IOException,
                       AutomationException

Cursor of sorted rows.

Specified by:

getRows in interface ITableSort

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

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

Sort rows.

Specified by:

sort in interface ITableSort

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

public long getIDByIndex(int index)
                  throws java.io.IOException,
                         AutomationException

A id by its index value.

Specified by:

getIDByIndex in interface ITableSort

Parameters:

index - The index (in)

Returns:

Signed 64-bit int

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws java.io.IOException,
                       AutomationException

The table as a source of the data to sort on.

Specified by:

getTable in interface ITableSort

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

public ISelectionSet getSelectionSet()
                              throws java.io.IOException,
                                     AutomationException

The selection set as a source of the data to sort on. Cancels Cursor.

Specified by:

getSelectionSet in interface ITableSort

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.

setSortByCodedValueDescription

public void setSortByCodedValueDescription(java.lang.String field,
                                           boolean rhs2)
                                    throws java.io.IOException,
                                           AutomationException

Field sort order by coded value description.

Specified by:

setSortByCodedValueDescription in interface ITableSort2

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.