--- /dev/null
+/*\r
+\r
+ Derby - Class org.apache.derby.iapi.sql.execute.TupleFilter\r
+\r
+ Licensed to the Apache Software Foundation (ASF) under one or more\r
+ contributor license agreements. See the NOTICE file distributed with\r
+ this work for additional information regarding copyright ownership.\r
+ The ASF licenses this file to you under the Apache License, Version 2.0\r
+ (the "License"); you may not use this file except in compliance with\r
+ the License. You may obtain a copy of the License at\r
+\r
+ http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+ Unless required by applicable law or agreed to in writing, software\r
+ distributed under the License is distributed on an "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ See the License for the specific language governing permissions and\r
+ limitations under the License.\r
+\r
+ */\r
+\r
+package org.apache.derby.iapi.sql.execute;\r
+\r
+import org.apache.derby.iapi.types.BooleanDataValue;\r
+\r
+import org.apache.derby.iapi.error.StandardException;\r
+\r
+/**\r
+ * A TupleFilter is used to qualify rows from a tuple stream.\r
+ *\r
+ */\r
+public interface TupleFilter\r
+{\r
+ /**\r
+ * Initialize a Filter with a vector of parameters.\r
+ *\r
+ * @param parameters An ExecRow of parameter values\r
+ *\r
+ * @exception StandardException Thrown on error\r
+ */\r
+ public void init( ExecRow parameters )\r
+ throws StandardException;\r
+\r
+ /**\r
+ * Pump a row through the Filter.\r
+ *\r
+ * @param currentRow Column values to plug into restriction\r
+ *\r
+ * @return True if the row qualifies. False otherwise.\r
+ *\r
+ * @exception StandardException Thrown on error\r
+ */\r
+ public BooleanDataValue execute( ExecRow currentRow )\r
+ throws StandardException;\r
+}\r