KickJava   Java API By Example, From Geeks To Geeks.

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


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.List JavaDoc;
16
17 import com.tonbeller.jpivot.olap.model.Hierarchy;
18
19 /**
20  * allows to place a set of members on a visible query axis.
21  * @author av
22  */
23
24 public interface PlaceMembersOnAxes extends PlaceHierarchiesOnAxes {
25   /**
26    * name of the Extension for lookup
27    */
28   static final String JavaDoc ID = "membersOnAxes";
29   
30   /**
31    * creates an expression that selects <code>members</code>. In MDX this
32    * would be an enumeration of the members within <code>{ ... }</code>
33    * <p>
34    * If a memberExpression returned by this method is placed on an axis, sorting
35    * should be disabled. If sorting was not disabled, the explicit order or the
36    * members would not be visible to the user.
37    * @param members a List of Members
38    * @return a member expression that can be used with super.setAxis
39    * @see PlaceHierarchiesOnAxes#setQueryAxis
40    * @see com.tonbeller.jpivot.olap.model.Member
41    */
42   Object JavaDoc createMemberExpression(List JavaDoc members);
43   
44   /**
45    * collects all members from the visible axes in the result. If no members of the hierarchy
46    * are on a visible axis, returns an empty list.
47    * @param hier the Hierarchy
48    * @return A list of Members
49    * @see com.tonbeller.jpivot.olap.model.Member
50    */
51   List JavaDoc findVisibleMembers(Hierarchy hier);
52   
53 }
54
Popular Tags