KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > medor > eval > api > EvaluationMetaData


1 /**
2  * MEDOR: Middleware Enabling Distributed Object Requests
3  *
4  * Copyright (C) 2001-2004 France Telecom R&D
5  * Contact: alexandre.lefebvre@rd.francetelecom.com
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  *
21  * Initial developers: M. Alia, A. Lefebvre
22  */
23
24 package org.objectweb.medor.eval.api;
25
26 /**
27  * This interface is used for QueryTrees which can be optimized.
28  */
29 public interface EvaluationMetaData {
30
31     /**
32      * Set a boolean for declaring the use of a cache for intermediate
33      * materialization of results at evaluation time.
34      */
35     void setCache(boolean isCache);
36
37     /**
38      * Get the value of the boolean indicating whether cache is used for
39      * materialization of intermediate results at evaluation time.
40      * @return the boolean indicating whether the cache is used for
41      * materialization of intermediate results.
42      */
43     boolean isCache();
44
45     /**
46      * Set a boolean for declaring parallel evaluation of sub-QueryTrees.
47      */
48     void setParallel(boolean isTupleLoader);
49
50     /**
51      * Get the value of the boolean indicating whether parallel evaluation
52      * of sub-QueryTrees is performed.
53      * @return the boolean indicating parallel evaluation of sub-QueryTrees is
54      * performed.
55      */
56     boolean isParallel();
57
58     /**
59      * Gets the value of the boolean indicating whether a limited range of
60      * evaluation is performed.
61      * <p>If true, there should be a value for the first tuple index and a
62      * value for the maximum number of tuples to be returned by
63      * the evaluation.</p>
64      * @return true if limited range evaluation is to be performed.
65      */
66     boolean isLimitedRange();
67
68     /**
69      * Sets the value for the rank of the first tuple to be returned by the
70      * evaluation in the case of a range-limited evaluation.
71      * @param start the index of the first tuple to be returned by the
72      * evaluation, stating at 0.
73      */
74     void setLimitedRangeStartAt(int start);
75
76     /**
77      * Gets the value for the rank of the first tuple to be returned by the
78      * evaluation in the case of a range-limited evaluation.
79      * @return the value for the first tuple to be returned by the evaluation,
80      * starting at 0.
81      */
82     int getLimitedRangeStartAt();
83
84     /**
85      * Sets the maximum number of tuples to be returned by the evaluation in
86      * the case of a range-limited evaluation.
87      * @param number the maximum number of tuples to be returned by the
88      * evaluation
89      */
90     void setLimitedRangeSize(int number);
91
92     /**
93      * Gets the maximum number of tuples to be returned by the evaluation in
94      * the case of a range-limited evaluation.
95      * @return the maximum number of tuples to be returned by the evaluation.
96      */
97     int getLimitedRangeSize();
98
99 }
100
Popular Tags