org.apache.derby.iapi.store.access.conglomerate
Interface Sort

All Known Implementing Classes:

MergeSort, UniqueWithDuplicateNullsMergeSort

public interface Sort

The sort interface corresponds to an instance of an in-progress sort. Sorts are not persistent.

Method Summary

void	drop(TransactionController tran) Drop the sort - this means release all its resources.
SortController	open(TransactionManager tran) Open a sort controller.
ScanControllerRowSource	openSortRowSource(TransactionManager tran) Open a row Source to get rows out of the sorter.
ScanController	openSortScan(TransactionManager tran, boolean hold) Open a scan controller.

Method Detail

open

SortController open(TransactionManager tran)
                    throws StandardException

Open a sort controller.

The sort may have been dropped already, in which case this method should thrown an exception.

Throws:

StandardException - Standard exception policy.

openSortScan

ScanController openSortScan(TransactionManager tran,
                            boolean hold)
                            throws StandardException

Open a scan controller.

The sort may have been dropped already, in which case this method should thrown an exception.

Throws:

StandardException - Standard exception policy.

openSortRowSource

ScanControllerRowSource openSortRowSource(TransactionManager tran)
                                          throws StandardException

Open a row Source to get rows out of the sorter.

The sort may have been dropped already, in which case this method should thrown an exception.

Throws:

StandardException - Standard exception policy.

drop

void drop(TransactionController tran)
          throws StandardException

Drop the sort - this means release all its resources.

Note: drop is like close, it has to be tolerant of being called more than once, it must succeed or at least not throw any exceptions.

Throws:

StandardException