DBA Data[Home] [Help]

PACKAGE: OLAPSYS.CWM$OLAP$MEASURE

Source


1 package cwm$olap$measure as
2 
3   -- Create a measure
4   --
5   -- param cube_owner            owner of the cube
6   -- param cube_name             name of the cube
7   -- param measure_name          name of the measure
8   -- param display_name          display name for the measure
9   -- param description           description text for the measure
10   --
11   -- raise measure_already_exists if measure already exists
12   -- raise invalid_name           if name is empty or null
13   -- raise no_access_privileges  insufficient access privilege
14   procedure create_measure(cube_owner varchar2
15                       , cube_name varchar2
16                       , measure_name varchar2
17                       , display_name varchar2
18                       , description varchar2);
19 
20   -- Set a measure column mapping, the cube must be mapped to a fact table using map_cube
21   --
22   -- param cube_owner            owner of the cube
23   -- param cube_name             name of the cube
24   -- param measure_name          name of the measure
25   -- param fact_table_owner      fact table owner
26   -- param fact_table_name       fact table name containing the column
27   -- param column_name           column to map
28   --
29   -- raise cube_not_found        if cube is not defined
30   -- raise measure_not_found     if measure is not defined
31   -- raise table_not_defined     if table is not defined
32   -- raise fact_table_not_defined if cube not mapped to fact table
33   -- raise no_access_privileges  insufficient access privilege to access table in schema
34   -- raise column_not_found      if column does not exist in fact table
35   -- raise cannot_override_mappings  if cube is mapped to different fact table
36   procedure set_column_map(cube_owner varchar2
37                              , cube_name varchar2
38                              , measure_name varchar2
39                              , fact_table_owner varchar2
40                              , fact_table_name varchar2
41 			     , column_name VARCHAR2);
42 
43   -- Set display name for a measure
44   --
45   -- param cube_owner            owner of the cube
46   -- param cube_name             name of the cube
47   -- param measure_name          name of the measure
48   -- param display_name          display name for the measure
49   --
50   -- raise cube_not_found        if cube is not defined
51   -- raise measure_not_found     if measure is not defined
52   procedure set_display_name(owner        varchar2
53                             ,cube_name    varchar2
54                             ,measure_name varchar2
55                             ,display_name varchar2);
56 
57 
58   -- Set display name for a measure
59   --
60   -- param cube_owner            owner of the cube
61   -- param cube_name             name of the cube
62   -- param measure_name          name of the measure
63   -- param description           description for the measure
64   --
65   -- raise cube_not_found        if cube is not defined
66   -- raise measure_not_found     if measure is not defined
67   procedure set_description(owner        varchar2
68                            ,cube_name    varchar2
69                            ,measure_name varchar2
70                            ,description  varchar2);
71 
72 
73   -- Remove a measure column mapping, the cube must be mapped to a fact table using map_cube
74   --
75   -- param cube_owner            owner of the cube
76   -- param cube_name             name of the cube
77   -- param measure_name          name of the measure
78   -- param fact_table_owner      fact table owner
79   -- param fact_table_name       fact table name containing the column
80   -- param column_name           column to map
81   --
82   -- raise cube_not_found        if cube is not defined
83   -- raise measure_not_found     if measure is not defined
84   -- raise table_not_defined     if table is not defined
85   -- raise no_access_privileges  insufficient access privilege to access table in schema
86   -- raise column_not_found      if column does not exist in fact table
87   -- raise column_map_not_found  if column is not mapped to measure
88   procedure remove_column_map(owner           varchar2
89                              ,cube_name       varchar2
90                              ,measure_name    varchar2
91                              ,table_owner     varchar2
92                              ,fact_table_name varchar2
93                              ,column_name     varchar2);
94 
95   -- Drop a measure
96   --
97   -- param cube_owner            owner of the cube
98   -- param cube_name             name of the cube
99   -- param measure_name          name of the measure
100   --
101   -- raise cube_not_found        if cube is not defined
102   -- raise measure_not_found     if measure is not defined
103   -- raise no_access_privileges  insufficient access privilege
104   procedure drop_measure(owner          varchar2
105                         ,cube_name      varchar2
106                         ,measure_name   varchar2);
107 
108 
109   -- Set default aggregation method for measure
110   --
111   -- param cube_owner            owner of the cube
112   -- param cube_name             name of the cube
113   -- param measure_name          name of the measure
114   -- param function_use_id       identifier for use of a function
115   -- param dimension_owner       owner of the dimension
116   -- param dimension_name        name for the dimension
117   -- param dimension_alias       alias for a dimension
118   --
119   -- raise cube_not_found             if cube is not defined
120   -- raise measure_not_found          if measure is not defined
121   -- raise no_access_privileges       insufficient access privilege
122   -- raise dimension_not_found        if dimension is not defined
123   -- raise invalid_aggregation_method invalid function use identifier
124   procedure set_default_aggregation_method(cube_owner      varchar2
125                                           ,cube_name       varchar2
126                       ,measure_name    varchar2
127                       ,function_use_id number
128                       ,dimension_owner varchar2
129                       ,dimension_name  varchar2
130                       ,dimension_alias varchar2);
131 
132   -- Lock the measure metadata for update
133   --
134   -- param owner                 owner of the cube
135   -- param cube_name             name of the cube
136   -- param measure_name          name of the measure
137   -- param wait_for_lock         wait for lock if acquired by other user
138   --
139   -- raise no_access_privileges  insufficient access privilege
140   -- raise measure_not_found     if measure is not defined
141   -- raise failed_to_gain_lock   if lock could not be acquired
142   procedure lock_measure(owner varchar2
143                        , cube_name varchar2
144                        , measure_name varchar2
145                        , wait_for_lock boolean := false);
146 
147 
148   -- PRIVATE internal operation get the internal measure id
149   function get_measure_id(cube_owner varchar2
150                         , cube_name varchar2
151                         , measure_name varchar2)
152                           return number;
153 
154 end;