KickJava   Java API By Example, From Geeks To Geeks.

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


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 com.tonbeller.jpivot.core.Extension;
16 import com.tonbeller.jpivot.olap.model.Hierarchy;
17 import com.tonbeller.jpivot.olap.model.Member;
18
19 /**
20  * Substitues the members of a hierarchy with the children of a member.
21  * Example: A table shows the continents "America", "Asia", "Europe" etc. DrillReplace
22  * for "Europe" will replace the continents with the countries of "Europe".
23  * @author av
24  */
25 public interface DrillReplace extends Extension {
26   /**
27    * name of the Extension for lookup
28    */
29   public static final String JavaDoc ID = "drillReplace";
30
31   /**
32    * drill down is possible if <code>member</code> has children
33    */
34   boolean canDrillDown(Member member);
35   
36   /**
37    * drill up is possible if not all members of the top level
38    * hierarchy are shown.
39    */
40   boolean canDrillUp(Hierarchy hier);
41   
42   /**
43    * replaces the members. Let <code>H</code> be the hierarchy
44    * that member belongs to. Then drillDown will replace all members from <code>H</code>
45    * that are currently visible with the children of <code>member</code>.
46    */
47   void drillDown(Member member);
48   
49   /**
50    * replaces all visible members of hier with the members of the
51    * next higher level.
52    */
53   void drillUp(Hierarchy hier);
54
55 }
56
Popular Tags