KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > mondrian > calc > BooleanCalc


1 /*
2 // $Id: //open/mondrian/src/main/mondrian/calc/BooleanCalc.java#3 $
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.Evaluator;
13
14 /**
15  * Compiled expression whose result is a <code>boolean</code>.
16  *
17  * <p>When implementing this interface, it is convenient to extend
18  * {@link mondrian.calc.impl.AbstractBooleanCalc}, but it is not required.
19  *
20  * @author jhyde
21  * @version $Id: //open/mondrian/src/main/mondrian/calc/BooleanCalc.java#3 $
22  * @since Sep 27, 2005
23  */
24 public interface BooleanCalc extends Calc {
25     /**
26      * Evaluates this expression to yield a <code>boolean</code> value.
27      * If the result is null, returns the special
28      * {@link mondrian.olap.fun.FunUtil#BooleanNull} value.
29      *
30      * @param evaluator Evaluation context
31      * @return evaluation result
32      */
33     boolean evaluateBoolean(Evaluator evaluator);
34 }
35
36 // End BooleanCalc.java
37
Popular Tags