Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.sql.execute.BasicSortObserver

Modifier and Type	Field and Description
protected boolean	distinct
protected boolean	doClone
private ExecRow	execRow
private boolean	reuseWrappers
private Vector<DataValueDescriptor[]>	vector

Access	Constructor and Description
public	BasicSortObserver(boolean If true, then rows that are retained by the sorter will be cloned. This is needed if language is reusing row wrappers. doClone, boolean If true, toss out duplicates. Otherwise, retain them. distinct, ExecRow ExecRow to use as source of clone for store. execRow, boolean Whether or not we can reuse the wrappers reuseWrappers) Simple constructor

Method Summary

Modifier and Type	Method and Description
public void	addToFreeList(DataValueDescriptor[] objectArray, int maxFreeListSize) Implements org.apache.derby.iapi.store.access.SortObserver.addToFreeList.
public boolean	deferrable() Implements org.apache.derby.iapi.store.access.SortObserver.deferrable. Overridden by subclasses that observe sorters with uniqueness checking.
public boolean	deferred() Implements org.apache.derby.iapi.store.access.SortObserver.deferred. Overridden by subclasses that observe sorters with uniqueness checking.
public DataValueDescriptor[]	getArrayClone() Implements org.apache.derby.iapi.store.access.SortObserver.getArrayClone.
private DataValueDescriptor[]	getClone(DataValueDescriptor[] origArray)
public DataValueDescriptor[]	insertDuplicateKey(DataValueDescriptor[] the current row that the sorter is on the verge of retaining. It is a duplicate of existingRow. insertRow, DataValueDescriptor[] the row that is already in the the sorter which is a duplicate of insertRow existingRow) Implements org.apache.derby.iapi.store.access.SortObserver.insertDuplicateKey. Called prior to inserting a duplicate sort key.
public DataValueDescriptor[]	Returns: the row to be inserted by the sorter. If null, then nothing is inserted by the sorter. Distinct sorts will want to return null. insertNonDuplicateKey(DataValueDescriptor[] the current row that the sorter is on the verge of retaining insertRow) Implements org.apache.derby.iapi.store.access.SortObserver.insertNonDuplicateKey. Called prior to inserting a distinct sort key.
public void	rememberDuplicate(DataValueDescriptor[] data of offending key row) Implements org.apache.derby.iapi.store.access.SortObserver.rememberDuplicate. Overridden by subclasses that observe sorters with uniqueness checking.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

distinct	back to summary
protected boolean distinct

doClone	back to summary
protected boolean doClone

execRow	back to summary
private ExecRow execRow

reuseWrappers	back to summary
private boolean reuseWrappers

vector	back to summary
private Vector<DataValueDescriptor[]> vector

BasicSortObserver	back to summary
public BasicSortObserver(boolean doClone, boolean distinct, ExecRow execRow, boolean reuseWrappers) Simple constructor Parameters doClone:boolean If true, then rows that are retained by the sorter will be cloned. This is needed if language is reusing row wrappers. distinct:boolean If true, toss out duplicates. Otherwise, retain them. execRow:ExecRow ExecRow to use as source of clone for store. reuseWrappers:boolean Whether or not we can reuse the wrappers

Method Detail

addToFreeList	back to summary
public void addToFreeList(DataValueDescriptor[] objectArray, int maxFreeListSize) Implements org.apache.derby.iapi.store.access.SortObserver.addToFreeList.

deferrable	back to summary
public boolean deferrable() Implements org.apache.derby.iapi.store.access.SortObserver.deferrable. Doc from org.apache.derby.iapi.store.access.SortObserver.deferrable. Overridden by subclasses that observe sorters with uniqueness checking. Returns:boolean true if the index's constraint is deferrable. Any SortObserver implementations that implement uniqueness checking need to keep track of this information.

deferrable

back to summary

public boolean deferrable()

Implements org.apache.derby.iapi.store.access.SortObserver.deferrable.

Doc from org.apache.derby.iapi.store.access.SortObserver.deferrable.

Overridden by subclasses that observe sorters with uniqueness checking.

Returns:boolean: true if the index's constraint is deferrable. Any SortObserver implementations that implement uniqueness checking need to keep track of this information.

deferred	back to summary
public boolean deferred() Implements org.apache.derby.iapi.store.access.SortObserver.deferred. Doc from org.apache.derby.iapi.store.access.SortObserver.deferred. Overridden by subclasses that observe sorters with uniqueness checking. Returns:boolean true if constraint mode of the index's constraint is effectively deferred. Any SortObserver implementations that implement uniqueness checking need to keep track of this information.

deferred

back to summary

public boolean deferred()

Implements org.apache.derby.iapi.store.access.SortObserver.deferred.

Doc from org.apache.derby.iapi.store.access.SortObserver.deferred.

Overridden by subclasses that observe sorters with uniqueness checking.

Returns:boolean: true if constraint mode of the index's constraint is effectively deferred. Any SortObserver implementations that implement uniqueness checking need to keep track of this information.

getArrayClone	back to summary
public DataValueDescriptor[] getArrayClone() throws StandardException Implements org.apache.derby.iapi.store.access.SortObserver.getArrayClone.

getClone	back to summary
private DataValueDescriptor[] getClone(DataValueDescriptor[] origArray)

insertDuplicateKey	back to summary
public DataValueDescriptor[] insertDuplicateKey(DataValueDescriptor[] insertRow, DataValueDescriptor[] existingRow) throws StandardException Implements org.apache.derby.iapi.store.access.SortObserver.insertDuplicateKey. Called prior to inserting a duplicate sort key. Parameters insertRow:DataValueDescriptor[] the current row that the sorter is on the verge of retaining. It is a duplicate of existingRow. existingRow:DataValueDescriptor[] the row that is already in the the sorter which is a duplicate of insertRow Returns:DataValueDescriptor[] Doc from org.apache.derby.iapi.store.access.SortObserver.insertDuplicateKey. the row to be inserted by the sorter. If null, then nothing is inserted by the sorter. Distinct sorts will want to return null. Exceptions StandardException: never thrown

insertDuplicateKey

back to summary

public DataValueDescriptor[] insertDuplicateKey(DataValueDescriptor[] insertRow, DataValueDescriptor[] existingRow) throws StandardException

Implements org.apache.derby.iapi.store.access.SortObserver.insertDuplicateKey.

Called prior to inserting a duplicate sort key.

Parameters

insertRow:DataValueDescriptor[]: the current row that the sorter is on the verge of retaining. It is a duplicate of existingRow.
existingRow:DataValueDescriptor[]: the row that is already in the the sorter which is a duplicate of insertRow

Returns:DataValueDescriptor[]

Doc from org.apache.derby.iapi.store.access.SortObserver.insertDuplicateKey.

the row to be inserted by the sorter. If null, then nothing is inserted by the sorter. Distinct sorts will want to return null.

Exceptions

StandardException:: never thrown

insertNonDuplicateKey	back to summary
public DataValueDescriptor[] insertNonDuplicateKey(DataValueDescriptor[] insertRow) throws StandardException Implements org.apache.derby.iapi.store.access.SortObserver.insertNonDuplicateKey. Called prior to inserting a distinct sort key. Parameters insertRow:DataValueDescriptor[] the current row that the sorter is on the verge of retaining Returns:DataValueDescriptor[] the row to be inserted by the sorter. If null, then nothing is inserted by the sorter. Distinct sorts will want to return null. Exceptions StandardException: never thrown

insertNonDuplicateKey

back to summary

public DataValueDescriptor[] insertNonDuplicateKey(DataValueDescriptor[] insertRow) throws StandardException

Implements org.apache.derby.iapi.store.access.SortObserver.insertNonDuplicateKey.

Called prior to inserting a distinct sort key.

Parameters

insertRow:DataValueDescriptor[]: the current row that the sorter is on the verge of retaining

Returns:DataValueDescriptor[]

the row to be inserted by the sorter. If null, then nothing is inserted by the sorter. Distinct sorts will want to return null.

Exceptions

StandardException:: never thrown

rememberDuplicate	back to summary
public void rememberDuplicate(DataValueDescriptor[] row) throws StandardException Implements org.apache.derby.iapi.store.access.SortObserver.rememberDuplicate. Doc from org.apache.derby.iapi.store.access.SortObserver.rememberDuplicate. Overridden by subclasses that observe sorters with uniqueness checking. Will be called by sorters iff deferrable() and deferred() and uniqueness violation, so implementations that sometimes return true to these must implement this method to save duplicate information till commit time. Parameters row:DataValueDescriptor[] data of offending key Exceptions StandardException: standard error policy

rememberDuplicate

back to summary

public void rememberDuplicate(DataValueDescriptor[] row) throws StandardException

Implements org.apache.derby.iapi.store.access.SortObserver.rememberDuplicate.

Doc from org.apache.derby.iapi.store.access.SortObserver.rememberDuplicate.

Overridden by subclasses that observe sorters with uniqueness checking. Will be called by sorters iff deferrable() and deferred() and uniqueness violation, so implementations that sometimes return true to these must implement this method to save duplicate information till commit time.

Parameters

row:DataValueDescriptor[]: data of offending key

Exceptions

StandardException:: standard error policy

public Class BasicSortObserver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail