Adding JMCR-Stable version

[Benchmarks_CSolver.git] / JMCR-Stable / real-world application / derby-10.3.2.1 / java / engine / org / apache / derby / iapi / store / access / SortController.java

diff --git a/JMCR-Stable/real-world application/derby-10.3.2.1/java/engine/org/apache/derby/iapi/store/access/SortController.java b/JMCR-Stable/real-world application/derby-10.3.2.1/java/engine/org/apache/derby/iapi/store/access/SortController.java
new file mode 100644 (file)
index 0000000..57bb190
--- /dev/null
+++ b/JMCR-Stable/real-world application/derby-10.3.2.1/java/engine/org/apache/derby/iapi/store/access/SortController.java
@@ -0,0 +1,80 @@
+/*\r
+\r
+   Derby - Class org.apache.derby.iapi.store.access.SortController\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.store.access;\r
+\r
+import org.apache.derby.iapi.error.StandardException;\r
+import org.apache.derby.iapi.types.DataValueDescriptor;\r
+\r
+\r
+/**\r
+\r
+  A sort controller is an interface for inserting rows\r
+  into a sort.\r
+  <p>\r
+  A sort is created with the createSort method of\r
+  TransactionController. The rows are read back with\r
+  a scan controller returned from the openSortScan\r
+  method of TranscationController.\r
+\r
+\r
+  @see TransactionController#openSort\r
+  @see ScanController\r
+\r
+**/\r
+\r
+public interface SortController\r
+{\r
+       /**\r
+       Inform SortController that all the rows have\r
+    been inserted into it. \r
+       **/\r
+       void completedInserts();\r
+\r
+       /**\r
+    Insert a row into the sort.\r
+\r
+    @param row The row to insert into the SortController.  The stored\r
+       representations of the row's columns are copied into a new row\r
+       somewhere in the sort.\r
+\r
+       @exception StandardException Standard exception policy.\r
+    **/\r
+    void insert(DataValueDescriptor[] row)\r
+               throws StandardException;\r
+\r
+\r
+    /**\r
+     * Return SortInfo object which contains information about the current\r
+     * state of the sort.\r
+     * <p>\r
+     *\r
+     * @see SortInfo\r
+     *\r
+        * @return The SortInfo object which contains info about current sort.\r
+     *\r
+        * @exception  StandardException  Standard exception policy.\r
+     **/\r
+    SortInfo getSortInfo()\r
+               throws StandardException;\r
+\r
+\r
+}\r