org.apache.derby.iapi.sql.execute
Interface TupleFilter

All Known Implementing Classes:

DropDependencyFilter

public interface TupleFilter

A TupleFilter is used to qualify rows from a tuple stream.

Method Summary

BooleanDataValue	execute(ExecRow currentRow) Pump a row through the Filter.
void	init(ExecRow parameters) Initialize a Filter with a vector of parameters.

Method Detail

init

void init(ExecRow parameters)
          throws StandardException

Initialize a Filter with a vector of parameters.

Parameters:

parameters - An ExecRow of parameter values

Throws:

StandardException - Thrown on error

execute

BooleanDataValue execute(ExecRow currentRow)
                         throws StandardException

Pump a row through the Filter.

Parameters:

currentRow - Column values to plug into restriction

Returns:

True if the row qualifies. False otherwise.

Throws:

StandardException - Thrown on error