Top Description Methods
org.apache.derby.iapi.store.access

public Interface SortController

Known Direct Implementers
org.apache.derby.impl.store.access.sort.MergeInserter
Imports
org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.types.DataValueDescriptor
A sort controller is an interface for inserting rows into a sort.

A sort is created with the createSort method of TransactionController. The rows are read back with a scan controller returned from the openSortScan method of TranscationController.

See Also
TransactionController#openSort, ScanController

Method Summary

Modifier and TypeMethod and Description
public void
completedInserts()

Inform SortController that all the rows have been inserted into it.

public SortInfo

Returns:

The SortInfo object which contains info about current sort.
getSortInfo()

Return SortInfo object which contains information about the current state of the sort.

public void
insert(DataValueDescriptor[]
The row to insert into the SortController. The stored representations of the row's columns are copied into a new row somewhere in the sort.
row)

Insert a row into the sort.

Method Detail

completedInsertsback to summary
public void completedInserts()

Inform SortController that all the rows have been inserted into it.

getSortInfoback to summary
public SortInfo getSortInfo() throws StandardException

Return SortInfo object which contains information about the current state of the sort.

Returns:SortInfo

The SortInfo object which contains info about current sort.

Exceptions
StandardException:
Standard exception policy.
See Also
SortInfo
insertback to summary
public void insert(DataValueDescriptor[] row) throws StandardException

Insert a row into the sort.

Parameters
row:DataValueDescriptor[]

The row to insert into the SortController. The stored representations of the row's columns are copied into a new row somewhere in the sort.

Exceptions
StandardException:
Standard exception policy.