Save This Page
1 /*
2
3 Derby - Class org.apache.derby.iapi.store.access.conglomerate.SortFactory
4
5 Licensed to the Apache Software Foundation (ASF) under one or more
6 contributor license agreements. See the NOTICE file distributed with
7 this work for additional information regarding copyright ownership.
8 The ASF licenses this file to you under the Apache License, Version 2.0
9 (the "License"); you may not use this file except in compliance with
10 the License. You may obtain a copy of the License at
11
12 http://www.apache.org/licenses/LICENSE-2.0
13
14 Unless required by applicable law or agreed to in writing, software
15 distributed under the License is distributed on an "AS IS" BASIS,
16 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 See the License for the specific language governing permissions and
18 limitations under the License.
19
20 */
21
22 package org.apache.derby.iapi.store.access.conglomerate;
23
24 import java.util.Properties;
25 import org.apache.derby.catalog.UUID;
26 import org.apache.derby.iapi.error.StandardException;
27 import org.apache.derby.iapi.store.access.SortObserver;
28 import org.apache.derby.iapi.store.access.SortCostController;
29 import org.apache.derby.iapi.store.access.ColumnOrdering;
30 import org.apache.derby.iapi.store.access.TransactionController;
31
32 import org.apache.derby.iapi.types.DataValueDescriptor;
33
34 /**
35
36 The factory interface for all sort access methods.
37
38 **/
39
40 public interface SortFactory extends MethodFactory
41 {
42 /**
43 Used to identify this interface when finding it with the Monitor.
44 **/
45 public static final String MODULE =
46 "org.apache.derby.iapi.store.access.conglomerate.SortFactory";
47
48 /**
49 Create the sort and return a sort object for it.
50
51 @exception StandardException if the sort could not be
52 opened for some reason, or if an error occurred in one of
53 the lower level modules.
54
55 **/
56 Sort createSort(
57 TransactionController tran,
58 int segment,
59 Properties implParameters,
60 DataValueDescriptor[] template,
61 ColumnOrdering columnOrdering[],
62 SortObserver sortObserver,
63 boolean alreadyInOrder,
64 long estimatedRows,
65 int estimatedRowSize)
66 throws StandardException;
67
68 /**
69 * Return an open SortCostController.
70 * <p>
71 * Return an open SortCostController which can be used to ask about
72 * the estimated costs of SortController() operations.
73 * <p>
74 *
75 * @return The open StoreCostController.
76 *
77 * @exception StandardException Standard exception policy.
78 *
79 * @see org.apache.derby.iapi.store.access.StoreCostController
80 **/
81 SortCostController openSortCostController()
82 throws StandardException;
83 }