KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > derby > impl > sql > execute > rts > ResultSetStatistics


1 /*
2
3    Derby - Class org.apache.derby.impl.sql.execute.rts.ResultSetStatistics
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.impl.sql.execute.rts;
23
24 /**
25  * The ResultSetStatistics interface is used to provide run time
26  * statistics information on a specific ResultSet.
27  * <p>
28  * This interface extends Formatable so that all objects which implement
29  * this interface can be easily saved to the database.
30  *
31  * @author jerry
32  */
33 public interface ResultSetStatistics
34 {
35     /**
36      * Return the statement execution plan as a String.
37      *
38      * @param depth Indentation level.
39      *
40      * @return String The statement execution plan as a String.
41      */
42     public String JavaDoc getStatementExecutionPlanText(int depth);
43
44     /**
45      * Return information on the scan nodes from the statement execution
46      * plan as a String.
47      *
48      * @param depth Indentation level.
49      * @param tableName if not NULL then return information for this table only
50      * @return String The information on the scan nodes from the
51      * statement execution plan as a String.
52      */
53     public String JavaDoc getScanStatisticsText(String JavaDoc tableName, int depth);
54
55     /**
56      * Get the estimated row count for the number of rows returned
57      * by the associated query or statement.
58      *
59      * @return The estimated number of rows returned by the associated
60      * query or statement.
61      */
62     public double getEstimatedRowCount();
63 }
64
Popular Tags