KickJava   Java API By Example, From Geeks To Geeks.

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


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.Level;
17 import com.tonbeller.jpivot.olap.model.Member;
18 import com.tonbeller.jpivot.olap.model.MemberPropertyMeta;
19
20 /**
21  * retrieves the description of the available member properties
22  * @author av
23  */
24 public interface MemberProperties extends Extension {
25
26   /**
27    * name of the Extension for lookup
28    */
29   static final String JavaDoc ID = "memberProperties";
30                             
31   MemberPropertyMeta[] getMemberPropertyMetas(Level level);
32
33   /**
34    * Properties are either Level scope or Dimension scope.
35    * Properties are unique within their scope. If scope is level, then
36    * properties with same name in different levels are treated
37    * as different Properties.
38    * If false, the scope will be Dimension.
39    * @return
40    */
41   boolean isLevelScope();
42   
43   /**
44    * returns a string <code>scope</code>
45    * that represents the scope of Member m.
46    * The returned String <code>scope</code>
47    * ensures that <code>scope.equals(MemberPropertyMeta.getScope())</code> is
48    * true if the property belongs to member m.
49    */
50   String JavaDoc getPropertyScope(Member m);
51   
52   /**
53    * sets the visible properties. Optimizing implementations of
54    * PropertyHolder may only return these properties.
55    * @see com.tonbeller.jpivot.olap.model.PropertyHolder
56    */
57   void setVisibleProperties(MemberPropertyMeta[] props);
58
59 }
60
Popular Tags