KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > mondrian > olap > Level


1 /*
2 // $Id: //open/mondrian/src/main/mondrian/olap/Level.java#14 $
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) 1999-2002 Kana Software, Inc.
7 // Copyright (C) 2001-2006 Julian Hyde and others
8 // All Rights Reserved.
9 // You must accept the terms of that agreement to use this software.
10 //
11 // jhyde, 1 March, 1999
12 */
13
14 package mondrian.olap;
15
16 /**
17  * A <code>Level</code> is a group of {@link Member}s in a {@link Hierarchy},
18  * all with the same attributes and at the same depth in the hierarchy.
19  */
20 public interface Level extends OlapElement {
21
22     /**
23      * Returns the depth of this level.
24      *
25      * <p>Note #1: In an access-controlled context, the first visible level of
26      * a hierarchy (as returned by {@link SchemaReader#getHierarchyLevels}) may
27      * not have a depth of 0.</p>
28      *
29      * <p>Note #2: In a parent-child hierarchy, the depth of a member (as
30      * returned by {@link SchemaReader#getMemberDepth}) may not be the same as
31      * the depth of its level.
32      */
33     int getDepth();
34     Hierarchy getHierarchy();
35
36     Level getChildLevel();
37     Level getParentLevel();
38     boolean isAll();
39     boolean areMembersUnique();
40     LevelType getLevelType();
41
42     /** Returns properties defined against this level. */
43     Property[] getProperties();
44     /** Returns properties defined against this level and parent levels. */
45     Property[] getInheritedProperties();
46
47     /** @return the MemberFormatter
48       */
49     MemberFormatter getMemberFormatter();
50
51     /**
52      * Returns the approximate number of members in this level, or
53      * {@link Integer#MIN_VALUE} if no approximation is known.
54      */
55     int getApproxRowCount();
56 }
57
58 // End Level.java
59
Popular Tags