KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > mondrian > olap > Dimension


1 /*
2 // $Id: //open/mondrian/src/main/mondrian/olap/Dimension.java#6 $
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-2005 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>Dimension</code> represents a dimension of a cube.
18  */
19 public interface Dimension extends OlapElement {
20     final String JavaDoc MEASURES_UNIQUE_NAME = "[Measures]";
21     final String JavaDoc MEASURES_NAME = "Measures";
22
23     /**
24      * Returns an array of the hierarchies which belong to this dimension.
25      */
26     Hierarchy[] getHierarchies();
27
28     /**
29      * Returns whether this is the <code>[Measures]</code> dimension.
30      */
31     boolean isMeasures();
32
33     /**
34      * Returns the type of this dimension
35      * ({@link DimensionType#StandardDimension} or
36      * {@link DimensionType#TimeDimension}
37      */
38     DimensionType getDimensionType();
39
40     /**
41      * Returns dimension's ordinal within a given cube.
42      * The <code>[Measures]</code> always has ordinal 0.
43      */
44     int getOrdinal(Cube cube);
45
46     /**
47      * Returns the schema this dimension belongs to.
48      */
49     Schema getSchema();
50 }
51
52 // End Dimension.java
53
Popular Tags