KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > mondrian > calc > ParameterSlot


1 /*
2 // $Id: //open/mondrian/src/main/mondrian/calc/ParameterSlot.java#1 $
3 // This software is subject to the terms of the Common Public License
4 // Agreement, available at the following URL:
5 // http://www.opensource.org/licenses/cpl.html.
6 // Copyright (C) 2006-2006 Julian Hyde
7 // All Rights Reserved.
8 // You must accept the terms of that agreement to use this software.
9 */

10 package mondrian.calc;
11
12 import mondrian.olap.Parameter;
13
14 /**
15  * Implementation of a parameter.
16  *
17  * @author jhyde
18  * @version $Id: //open/mondrian/src/main/mondrian/calc/ParameterSlot.java#1 $
19  * @since Jul 25, 2006
20  */

21 public interface ParameterSlot {
22     /**
23      * Returns the unique index of the slot.
24      */

25     int getIndex();
26
27     /**
28      * Returns a compiled expression to compute the default value of the
29      * parameter.
30      */

31     Calc getDefaultValueCalc();
32
33     /**
34      * Returns the parameter.
35      */

36     Parameter getParameter();
37
38     /**
39      * Sets the value of this parameter.
40      *
41      * <p>NOTE: This method will be removed when we store parameter values
42      * in the {@link mondrian.olap.Result} rather than in the
43      * {@link mondrian.olap.Query}.
44      */

45     void setParameterValue(Object JavaDoc value);
46
47     /**
48      * Returns the value of this parameter.
49      *
50      * <p>NOTE: This method will be removed when we store parameter values
51      * in the {@link mondrian.olap.Result} rather than in the
52      * {@link mondrian.olap.Query}.
53      */

54     Object JavaDoc getParameterValue();
55
56     void setCachedDefaultValue(Object JavaDoc value);
57
58     Object JavaDoc getCachedDefaultValue();
59 }
60
61 // End ParameterSlot.java
62
Popular Tags