org.apache.derby.iapi.store.access
Interface SortController

All Known Implementing Classes:

MergeInserter

public interface SortController

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(long), ScanController

Method Summary

void	close() Close this sort controller.
SortInfo	getSortInfo() Return SortInfo object which contains information about the current state of the sort.
void	insert(DataValueDescriptor[] row) Insert a row into the sort.

Method Detail

close

public void close()

Close this sort controller.

Currently, since only one sort controller is allowed per sort, closing the sort controller means the last row has been inserted.

insert

public void insert(DataValueDescriptor[] row)
            throws StandardException

Insert a row into the sort.

Parameters:

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

Throws:

StandardException - Standard exception policy.

See Also:

CloneableObject

getSortInfo

public SortInfo getSortInfo()
                     throws StandardException

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

Returns:

The SortInfo object which contains info about current sort.

Throws:

StandardException - Standard exception policy.

See Also:

SortInfo