KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > tonbeller > jpivot > olap > navi > SetParameter


1 /*
2  * ====================================================================
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) 2003-2004 TONBELLER AG.
7  * All Rights Reserved.
8  * You must accept the terms of that agreement to use this software.
9  * ====================================================================
10  *
11  *
12  */
13 package com.tonbeller.jpivot.olap.navi;
14
15 import java.util.Map JavaDoc;
16
17 import com.tonbeller.jpivot.core.Extension;
18 import com.tonbeller.jpivot.olap.model.Expression;
19
20 /**
21  * sets a parameter of the MDX Query
22  *
23  * @author av
24  */
25 public interface SetParameter extends Extension {
26   public static final String JavaDoc ID = "setParameter";
27
28   /**
29    * sets a parameter
30    * @param paramName name of the parameter in the MDX query
31    * @param expr the value of the parameter, e.g. a member
32    */
33   void setParameter(String JavaDoc paramName, Expression expr);
34
35   /**
36    * for scripting.
37    * @return Map containing parameter names (= keys) and strings to display value (= value)
38    */
39   public Map JavaDoc getDisplayValues();
40   
41   /**
42    * return the names of all defined parameters in this query
43    * @return the names of all defined parameters in this query
44    */
45   public String JavaDoc[] getParameterNames();
46 }
47
Popular Tags