KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > derby > iapi > sql > execute > ResultSetStatisticsFactory


1 /*
2
3    Derby - Class org.apache.derby.iapi.sql.execute.ResultSetStatisticsFactory
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.sql.execute;
23
24 import org.apache.derby.iapi.error.StandardException;
25
26 import org.apache.derby.iapi.sql.Activation;
27 import org.apache.derby.iapi.sql.ResultSet;
28
29 import org.apache.derby.iapi.sql.execute.RunTimeStatistics;
30
31 import org.apache.derby.impl.sql.execute.rts.ResultSetStatistics;
32
33 /**
34  * ResultSetStatisticsFactory provides a wrapper around all of
35  * the result sets statistics objects needed in building the run time statistics.
36  *
37  * @author jerry
38  */
39 public interface ResultSetStatisticsFactory
40 {
41     /**
42         Module name for the monitor's module locating system.
43      */
44     String JavaDoc MODULE = "org.apache.derby.iapi.sql.execute.ResultSetStatisticsFactory";
45
46     //
47 // RunTimeStatistics Object
48 //
49
50     /**
51      * RunTimeStatistics creation.
52      *
53      * @param activation The Activation we are generating the statistics for
54      * @param rs The top ResultSet for the ResultSet tree
55      * @param subqueryTrackingArray Array of subqueries, used for finding
56      * materialized subqueries.
57      *
58      * @exception StandardException on error
59      */
60     RunTimeStatistics getRunTimeStatistics(Activation activation, ResultSet rs,
61                                            NoPutResultSet[] subqueryTrackingArray)
62         throws StandardException;
63
64
65     //
66 // ResultSetStatistics Objects
67 //
68
69     /**
70         Get the matching ResultSetStatistics for the specified ResultSet.
71      */
72     public ResultSetStatistics getResultSetStatistics(ResultSet rs);
73
74     public ResultSetStatistics getResultSetStatistics(NoPutResultSet rs);
75
76     public ResultSetStatistics getNoRowsResultSetStatistics(ResultSet rs);
77 }
78
Popular Tags