Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.derby.iapi.store.access.conglomerate
Interface Sort  view Sort download Sort.java


public interface Sort

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


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

Method Detail

open

public org.apache.derby.iapi.store.access.SortController open(TransactionManager tran)
                                                       throws org.apache.derby.iapi.error.StandardException
Open a sort controller.

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


openSortScan

public org.apache.derby.iapi.store.access.ScanController openSortScan(TransactionManager tran,
                                                                      boolean hold)
                                                               throws org.apache.derby.iapi.error.StandardException
Open a scan controller.

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


openSortRowSource

public ScanControllerRowSource openSortRowSource(TransactionManager tran)
                                          throws org.apache.derby.iapi.error.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.


drop

public void drop(org.apache.derby.iapi.store.access.TransactionController tran)
          throws org.apache.derby.iapi.error.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.