Top Description Fields Constructors Methods
org.apache.derby.impl.sql.execute

public Class GenericScanQualifier

extends Object
implements ScanQualifier
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.sql.execute.ScanQualifier, org.apache.derby.iapi.store.access.Qualifier
Imports
org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.sql.execute.ScanQualifier, org.apache.derby.iapi.store.access.Qualifier, org.apache.derby.iapi.types.DataValueDescriptor

This is the implementation for ScanQualifier. It is used for system and user scans.
Version
0.1

Field Summary

Modifier and TypeField and Description
private int
private boolean
private int
private DataValueDescriptor
private boolean
private boolean
private boolean

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
clearOrderableCache()

Implements org.apache.derby.iapi.store.access.Qualifier.clearOrderableCache.

Clear the DataValueDescriptor cache, if one exists.

public int
getColumnId()

Implements org.apache.derby.iapi.store.access.Qualifier.getColumnId.

Get the (zero based) id of the column to be qualified.

public int
getOperator()

Implements org.apache.derby.iapi.store.access.Qualifier.getOperator.

Get the operator to use in the comparison.

public DataValueDescriptor
getOrderable()

Implements org.apache.derby.iapi.store.access.Qualifier.getOrderable.

Get the value that the column is to be compared to.

public boolean
getOrderedNulls()

Implements org.apache.derby.iapi.store.access.Qualifier.getOrderedNulls.

Get the getOrderedNulls argument to use in the comparison.

public boolean
getUnknownRV()

Implements org.apache.derby.iapi.store.access.Qualifier.getUnknownRV.

Get the getOrderedNulls argument to use in the comparison.

public boolean
negateCompareResult()

Implements org.apache.derby.iapi.store.access.Qualifier.negateCompareResult.

Should the result from the compare operation be negated?

public void
reinitialize()

Implements org.apache.derby.iapi.store.access.Qualifier.reinitialize.

This method reinitializes all the state of the Qualifier.

public void
setQualifier(int columnId, DataValueDescriptor orderable, int operator, boolean negateCR, boolean orderedNulls, boolean unknownRV)

Implements org.apache.derby.iapi.sql.execute.ScanQualifier.setQualifier.

Set the info in a ScanQualifier

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

columnIdback to summary
private int columnId
negateCRback to summary
private boolean negateCR
operatorback to summary
private int operator
orderableback to summary
private DataValueDescriptor orderable
orderedNullsback to summary
private boolean orderedNulls
properInitback to summary
private boolean properInit
unknownRVback to summary
private boolean unknownRV

Constructor Detail

GenericScanQualifierback to summary
public GenericScanQualifier()

Method Detail

clearOrderableCacheback to summary
public void clearOrderableCache()

Implements org.apache.derby.iapi.store.access.Qualifier.clearOrderableCache.

Clear the DataValueDescriptor cache, if one exists. (The DataValueDescriptor can be 1 of 3 types: o VARIANT - cannot be cached as its value can vary within a scan o SCAN_INVARIANT - can be cached within a scan as its value will not change within a scan o QUERY_INVARIANT- can be cached across the life of the query as its value will never change o CONSTANT - immutable

See Also
Qualifier#getUnknownRV
getColumnIdback to summary
public int getColumnId()

Implements org.apache.derby.iapi.store.access.Qualifier.getColumnId.

Doc from org.apache.derby.iapi.store.access.Qualifier.getColumnId.

Get the (zero based) id of the column to be qualified.

This id is the column number of the column in the table, no matter whether a partial column set is being retrieved by the actual fetch. Note that the column being specified in the qualifier must appear in the column list being fetched.

See Also
Qualifier#getColumnId
getOperatorback to summary
public int getOperator()

Implements org.apache.derby.iapi.store.access.Qualifier.getOperator.

Get the operator to use in the comparison.

See Also
Qualifier#getOperator
getOrderableback to summary
public DataValueDescriptor getOrderable()

Implements org.apache.derby.iapi.store.access.Qualifier.getOrderable.

Doc from org.apache.derby.iapi.store.access.Qualifier.getOrderable.

Get the value that the column is to be compared to.

See Also
Qualifier#getOrderable
getOrderedNullsback to summary
public boolean getOrderedNulls()

Implements org.apache.derby.iapi.store.access.Qualifier.getOrderedNulls.

Get the getOrderedNulls argument to use in the comparison.

See Also
Qualifier#getOrderedNulls
getUnknownRVback to summary
public boolean getUnknownRV()

Implements org.apache.derby.iapi.store.access.Qualifier.getUnknownRV.

Get the getOrderedNulls argument to use in the comparison.

See Also
Qualifier#getUnknownRV
negateCompareResultback to summary
public boolean negateCompareResult()

Implements org.apache.derby.iapi.store.access.Qualifier.negateCompareResult.

Should the result from the compare operation be negated? If true then only rows which fail the compare operation will qualify.

See Also
Qualifier#negateCompareResult
reinitializeback to summary
public void reinitialize()

Implements org.apache.derby.iapi.store.access.Qualifier.reinitialize.

This method reinitializes all the state of the Qualifier. It is used to distinguish between resetting something that is query invariant and something that is constant over every execution of a query. Basically, clearOrderableCache() will only clear out its cache if it is a VARIANT or SCAN_INVARIANT value. However, each time a query is executed, the QUERY_INVARIANT qualifiers need to be reset.

setQualifierback to summary
public void setQualifier(int columnId, DataValueDescriptor orderable, int operator, boolean negateCR, boolean orderedNulls, boolean unknownRV)

Implements org.apache.derby.iapi.sql.execute.ScanQualifier.setQualifier.

Doc from org.apache.derby.iapi.sql.execute.ScanQualifier.setQualifier.

Set the info in a ScanQualifier

See Also
ScanQualifier#setQualifier