KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > tonbeller > jpivot > olap > model > OlapItem


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
14
15 package com.tonbeller.jpivot.olap.model;
16
17 /**
18  * An Olap Item is a DWH meta object,
19  * eg. dimension, level, member
20  */

21 public interface OlapItem {
22   
23   public static final int TYPE_CATALOG = 1;
24   public static final int TYPE_CUBE = 2;
25   public static final int TYPE_DIMENSION = 3;
26   public static final int TYPE_HIERARCHY = 4;
27   public static final int TYPE_LEVEL = 5;
28   public static final int TYPE_MEMBER = 6;
29   public static final int TYPE_PROPERTY = 7;
30
31   /**
32    * @return type of item
33    */

34   public int getType();
35   
36     /**
37      * Label is the string to be externally displayed
38      * @return label
39      */

40     public String JavaDoc getLabel();
41
42     /**
43       * @return the unique name
44       */

45     public String JavaDoc getUniqueName();
46
47     /**
48       * @return caption (can be null)
49       */

50     public String JavaDoc getCaption();
51
52     /**
53      * @return name
54      */

55     public String JavaDoc getName();
56     
57     /**
58       * @param propName name of the property to be retrieved
59       * @return
60       */

61     public String JavaDoc getProperty(String JavaDoc propName);
62     
63     /**
64      * any OlapItem contains a map of properties,
65      * key and value of type String
66      * @return properties property map
67      */

68     public java.util.Map JavaDoc getProperties();
69
70 } // OlapItem
71
Popular Tags