/usr/share/doc/libolap4j-java/api/src-html/org/olap4j/metadata/Level.html is in libolap4j-java-doc 1.0.1.500-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span>// $Id: Level.java 485 2012-01-17 06:57:57Z jhyde $<a name="line.2"></a>
<span class="sourceLineNo">003</span>//<a name="line.3"></a>
<span class="sourceLineNo">004</span>// Licensed to Julian Hyde under one or more contributor license<a name="line.4"></a>
<span class="sourceLineNo">005</span>// agreements. See the NOTICE file distributed with this work for<a name="line.5"></a>
<span class="sourceLineNo">006</span>// additional information regarding copyright ownership.<a name="line.6"></a>
<span class="sourceLineNo">007</span>//<a name="line.7"></a>
<span class="sourceLineNo">008</span>// Julian Hyde licenses this file to you under the Apache License,<a name="line.8"></a>
<span class="sourceLineNo">009</span>// Version 2.0 (the "License"); you may not use this file except in<a name="line.9"></a>
<span class="sourceLineNo">010</span>// compliance with the License. You may obtain a copy of the License at:<a name="line.10"></a>
<span class="sourceLineNo">011</span>//<a name="line.11"></a>
<span class="sourceLineNo">012</span>// http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
<span class="sourceLineNo">013</span>//<a name="line.13"></a>
<span class="sourceLineNo">014</span>// Unless required by applicable law or agreed to in writing, software<a name="line.14"></a>
<span class="sourceLineNo">015</span>// distributed under the License is distributed on an "AS IS" BASIS,<a name="line.15"></a>
<span class="sourceLineNo">016</span>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.16"></a>
<span class="sourceLineNo">017</span>// See the License for the specific language governing permissions and<a name="line.17"></a>
<span class="sourceLineNo">018</span>// limitations under the License.<a name="line.18"></a>
<span class="sourceLineNo">019</span>*/<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.olap4j.metadata;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.olap4j.OlapException;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Group of {@link Member} objects in a {@link Hierarchy},<a name="line.27"></a>
<span class="sourceLineNo">028</span> * all with the same attributes and at the same depth in the hierarchy.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * @author jhyde<a name="line.30"></a>
<span class="sourceLineNo">031</span> * @version $Id: Level.java 485 2012-01-17 06:57:57Z jhyde $<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @since Aug 23, 2006<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span>public interface Level extends MetadataElement {<a name="line.34"></a>
<span class="sourceLineNo">035</span> /**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Returns the depth of this <code>Level</code>.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * <p>Note #1: In an access-controlled context, the first visible level of<a name="line.38"></a>
<span class="sourceLineNo">039</span> * a hierarchy may not have a depth of 0.</p><a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * <p>Note #2: In a parent-child hierarchy, the depth of a member (as<a name="line.41"></a>
<span class="sourceLineNo">042</span> * returned by may not be the same as the depth of its level.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @return depth of this level<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> int getDepth();<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Returns the {@link Hierarchy} this <code>Level</code> belongs to.<a name="line.49"></a>
<span class="sourceLineNo">050</span> *<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @return hierarchy this level belongs to<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> Hierarchy getHierarchy();<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Returns the Dimension this <code>Level</code> belongs to.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * (Always equivalent to <code>getHierarchy().getDimension()</code>.)<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @return dimension this level belongs to<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> Dimension getDimension();<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Returns the type of this <code>Level</code>.<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @return level type<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> Level.Type getLevelType();<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * Returns whether the level is calculated.<a name="line.71"></a>
<span class="sourceLineNo">072</span> *<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @return Whether this level is calculated<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> boolean isCalculated();<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> /**<a name="line.77"></a>
<span class="sourceLineNo">078</span> * Returns a list of definitions for the properties available to members<a name="line.78"></a>
<span class="sourceLineNo">079</span> * of this <code>Level</code>.<a name="line.79"></a>
<span class="sourceLineNo">080</span> *<a name="line.80"></a>
<span class="sourceLineNo">081</span> * <p>The caller should assume that the list is immutable;<a name="line.81"></a>
<span class="sourceLineNo">082</span> * if the caller modifies the list, behavior is undefined.</p><a name="line.82"></a>
<span class="sourceLineNo">083</span> *<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @see org.olap4j.OlapDatabaseMetaData#getProperties<a name="line.84"></a>
<span class="sourceLineNo">085</span> *<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @return properties of this Level<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> NamedList<Property> getProperties();<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> /**<a name="line.90"></a>
<span class="sourceLineNo">091</span> * Returns a list of {@link Member} objects that belong to this Level.<a name="line.91"></a>
<span class="sourceLineNo">092</span> *<a name="line.92"></a>
<span class="sourceLineNo">093</span> * <p>The list does not include calculated members.</p><a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * <p>Some levels have a very many members. In this case, calling this<a name="line.95"></a>
<span class="sourceLineNo">096</span> * method may be expensive in space and/or time and is not recommended.</p><a name="line.96"></a>
<span class="sourceLineNo">097</span> *<a name="line.97"></a>
<span class="sourceLineNo">098</span> * <p>If you need to include calculated members, or if you need to query<a name="line.98"></a>
<span class="sourceLineNo">099</span> * specific members or subsets of members in a level, consider instead<a name="line.99"></a>
<span class="sourceLineNo">100</span> * generating and executing an MDX query with a single axis. MDX functions<a name="line.100"></a>
<span class="sourceLineNo">101</span> * {@code AddCalculatedMembers}, {@code Filter} and {@code Order} are<a name="line.101"></a>
<span class="sourceLineNo">102</span> * especially useful. For example,<a name="line.102"></a>
<span class="sourceLineNo">103</span> *<a name="line.103"></a>
<span class="sourceLineNo">104</span> * <pre>with member [Measures].[Zero] as 0<a name="line.104"></a>
<span class="sourceLineNo">105</span> * select AddCalculatedMembers([Time].[Month].Members) on 0<a name="line.105"></a>
<span class="sourceLineNo">106</span> * from [Sales]<a name="line.106"></a>
<span class="sourceLineNo">107</span> * where [Measures].[Zero]</pre><a name="line.107"></a>
<span class="sourceLineNo">108</span> *<a name="line.108"></a>
<span class="sourceLineNo">109</span> * returns the {@code [Month]} level including calculated members. The<a name="line.109"></a>
<span class="sourceLineNo">110</span> * {@code [Measures].[Zero]} calculated member saves the OLAP server the<a name="line.110"></a>
<span class="sourceLineNo">111</span> * effort of retrieving cell values.</p><a name="line.111"></a>
<span class="sourceLineNo">112</span> *<a name="line.112"></a>
<span class="sourceLineNo">113</span> * <p>The members of a level do not have unique names, so unlike<a name="line.113"></a>
<span class="sourceLineNo">114</span> * {@link Hierarchy#getRootMembers()} and<a name="line.114"></a>
<span class="sourceLineNo">115</span> * {@link Member#getChildMembers()} the result type<a name="line.115"></a>
<span class="sourceLineNo">116</span> * is a {@link List} not a {@link NamedList}.<a name="line.116"></a>
<span class="sourceLineNo">117</span> *<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @return List of members in this Level<a name="line.118"></a>
<span class="sourceLineNo">119</span> *<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @throws OlapException if database error occurs<a name="line.120"></a>
<span class="sourceLineNo">121</span> */<a name="line.121"></a>
<span class="sourceLineNo">122</span> List<Member> getMembers() throws OlapException;<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
<span class="sourceLineNo">125</span> * Returns the number of members in this Level.<a name="line.125"></a>
<span class="sourceLineNo">126</span> *<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @return number of members<a name="line.127"></a>
<span class="sourceLineNo">128</span> */<a name="line.128"></a>
<span class="sourceLineNo">129</span> int getCardinality();<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> /**<a name="line.131"></a>
<span class="sourceLineNo">132</span> * Enumeration of the types of a {@link Level}.<a name="line.132"></a>
<span class="sourceLineNo">133</span> *<a name="line.133"></a>
<span class="sourceLineNo">134</span> * <p>Several of the values are defined by OLE DB for OLAP and/or XML/A,<a name="line.134"></a>
<span class="sourceLineNo">135</span> * sans the "MDLEVEL_TYPE_" prefix to their name. For example,<a name="line.135"></a>
<span class="sourceLineNo">136</span> * {@link #GEO_CONTINENT} corresponds to<a name="line.136"></a>
<span class="sourceLineNo">137</span> * the value <code>MDLEVEL_TYPE_GEO_CONTINENT</code> for the<a name="line.137"></a>
<span class="sourceLineNo">138</span> * <code>LEVEL_TYPE</code> property in the <code>MDSCHEMA_LEVELS</code><a name="line.138"></a>
<span class="sourceLineNo">139</span> * schema rowset.<a name="line.139"></a>
<span class="sourceLineNo">140</span> *<a name="line.140"></a>
<span class="sourceLineNo">141</span> * <p>Some of the values are specified by OLE DB for OLAP:<a name="line.141"></a>
<span class="sourceLineNo">142</span> * <ul><a name="line.142"></a>
<span class="sourceLineNo">143</span> * <li>MDLEVEL_TYPE_REGULAR (0x0000)<a name="line.143"></a>
<span class="sourceLineNo">144</span> * <li>MDLEVEL_TYPE_ALL (0x0001)<a name="line.144"></a>
<span class="sourceLineNo">145</span> * <li>MDLEVEL_TYPE_TIME_YEARS (0x0014)<a name="line.145"></a>
<span class="sourceLineNo">146</span> * <li>MDLEVEL_TYPE_TIME_HALF_YEAR (0x0024)<a name="line.146"></a>
<span class="sourceLineNo">147</span> * <li>MDLEVEL_TYPE_TIME_QUARTERS (0x0044)<a name="line.147"></a>
<span class="sourceLineNo">148</span> * <li>MDLEVEL_TYPE_TIME_MONTHS (0x0084)<a name="line.148"></a>
<span class="sourceLineNo">149</span> * <li>MDLEVEL_TYPE_TIME_WEEKS (0x0104)<a name="line.149"></a>
<span class="sourceLineNo">150</span> * <li>MDLEVEL_TYPE_TIME_DAYS (0x0204)<a name="line.150"></a>
<span class="sourceLineNo">151</span> * <li>MDLEVEL_TYPE_TIME_HOURS (0x0304)<a name="line.151"></a>
<span class="sourceLineNo">152</span> * <li>MDLEVEL_TYPE_TIME_MINUTES (0x0404)<a name="line.152"></a>
<span class="sourceLineNo">153</span> * <li>MDLEVEL_TYPE_TIME_SECONDS (0x0804)<a name="line.153"></a>
<span class="sourceLineNo">154</span> * <li>MDLEVEL_TYPE_TIME_UNDEFINED (0x1004)<a name="line.154"></a>
<span class="sourceLineNo">155</span> * </ul><a name="line.155"></a>
<span class="sourceLineNo">156</span> *<a name="line.156"></a>
<span class="sourceLineNo">157</span> * Some of the OLE DB for OLAP values are as flags, and do not become<a name="line.157"></a>
<span class="sourceLineNo">158</span> * values of the enumeration:<a name="line.158"></a>
<span class="sourceLineNo">159</span> * <ul><a name="line.159"></a>
<span class="sourceLineNo">160</span> * <li>MDLEVEL_TYPE_UNKNOWN (0x0000) signals that no other flags are set.<a name="line.160"></a>
<span class="sourceLineNo">161</span> * Use {@link #REGULAR}<a name="line.161"></a>
<span class="sourceLineNo">162</span> * <li>MDLEVEL_TYPE_CALCULATED (0x0002) indicates that the level is<a name="line.162"></a>
<span class="sourceLineNo">163</span> * calculated. Use {@link Level#isCalculated}.<a name="line.163"></a>
<span class="sourceLineNo">164</span> * <li>MDLEVEL_TYPE_TIME (0x0004) indicates that the level is time-related.<a name="line.164"></a>
<span class="sourceLineNo">165</span> * Use {@link #isTime}.<a name="line.165"></a>
<span class="sourceLineNo">166</span> * <li>MDLEVEL_TYPE_RESERVED1 (0x0008) is reserved for future use.<a name="line.166"></a>
<span class="sourceLineNo">167</span> * </ul><a name="line.167"></a>
<span class="sourceLineNo">168</span> *<a name="line.168"></a>
<span class="sourceLineNo">169</span> * <p>Some of the values are specified by XMLA:<a name="line.169"></a>
<span class="sourceLineNo">170</span> * <ul><a name="line.170"></a>
<span class="sourceLineNo">171</span> * <li>MDLEVEL_TYPE_GEO_CONTINENT (0x2001)<a name="line.171"></a>
<span class="sourceLineNo">172</span> * <li>MDLEVEL_TYPE_GEO_REGION (0x2002)<a name="line.172"></a>
<span class="sourceLineNo">173</span> * <li>MDLEVEL_TYPE_GEO_COUNTRY (0x2003)<a name="line.173"></a>
<span class="sourceLineNo">174</span> * <li>MDLEVEL_TYPE_GEO_STATE_OR_PROVINCE (0x2004)<a name="line.174"></a>
<span class="sourceLineNo">175</span> * <li>MDLEVEL_TYPE_GEO_COUNTY (0x2005)<a name="line.175"></a>
<span class="sourceLineNo">176</span> * <li>MDLEVEL_TYPE_GEO_CITY (0x2006)<a name="line.176"></a>
<span class="sourceLineNo">177</span> * <li>MDLEVEL_TYPE_GEO_POSTALCODE (0x2007)<a name="line.177"></a>
<span class="sourceLineNo">178</span> * <li>MDLEVEL_TYPE_GEO_POINT (0x2008)<a name="line.178"></a>
<span class="sourceLineNo">179</span> * <li>MDLEVEL_TYPE_ORG_UNIT (0x1011)<a name="line.179"></a>
<span class="sourceLineNo">180</span> * <li>MDLEVEL_TYPE_BOM_RESOURCE (0x1012)<a name="line.180"></a>
<span class="sourceLineNo">181</span> * <li>MDLEVEL_TYPE_QUANTITATIVE (0x1013)<a name="line.181"></a>
<span class="sourceLineNo">182</span> * <li>MDLEVEL_TYPE_ACCOUNT (0x1014)<a name="line.182"></a>
<span class="sourceLineNo">183</span> * <li>MDLEVEL_TYPE_CUSTOMER (0x1021)<a name="line.183"></a>
<span class="sourceLineNo">184</span> * <li>MDLEVEL_TYPE_CUSTOMER_GROUP (0x1022)<a name="line.184"></a>
<span class="sourceLineNo">185</span> * <li>MDLEVEL_TYPE_CUSTOMER_HOUSEHOLD (0x1023)<a name="line.185"></a>
<span class="sourceLineNo">186</span> * <li>MDLEVEL_TYPE_PRODUCT (0x1031)<a name="line.186"></a>
<span class="sourceLineNo">187</span> * <li>MDLEVEL_TYPE_PRODUCT_GROUP (0x1032)<a name="line.187"></a>
<span class="sourceLineNo">188</span> * <li>MDLEVEL_TYPE_SCENARIO (0x1015)<a name="line.188"></a>
<span class="sourceLineNo">189</span> * <li>MDLEVEL_TYPE_UTILITY (0x1016)<a name="line.189"></a>
<span class="sourceLineNo">190</span> * <li>MDLEVEL_TYPE_PERSON (0x1041)<a name="line.190"></a>
<span class="sourceLineNo">191</span> * <li>MDLEVEL_TYPE_COMPANY (0x1042)<a name="line.191"></a>
<span class="sourceLineNo">192</span> * <li>MDLEVEL_TYPE_CURRENCY_SOURCE (0x1051)<a name="line.192"></a>
<span class="sourceLineNo">193</span> * <li>MDLEVEL_TYPE_CURRENCY_DESTINATION (0x1052)<a name="line.193"></a>
<span class="sourceLineNo">194</span> * <li>MDLEVEL_TYPE_CHANNEL (0x1061)<a name="line.194"></a>
<span class="sourceLineNo">195</span> * <li>MDLEVEL_TYPE_REPRESENTATIVE (0x1062)<a name="line.195"></a>
<span class="sourceLineNo">196</span> * <li>MDLEVEL_TYPE_PROMOTION (0x1071)<a name="line.196"></a>
<span class="sourceLineNo">197</span> * </ul><a name="line.197"></a>
<span class="sourceLineNo">198</span> *<a name="line.198"></a>
<span class="sourceLineNo">199</span> * @see Level#getLevelType<a name="line.199"></a>
<span class="sourceLineNo">200</span> * @see org.olap4j.OlapDatabaseMetaData#getLevels<a name="line.200"></a>
<span class="sourceLineNo">201</span> */<a name="line.201"></a>
<span class="sourceLineNo">202</span> public enum Type implements XmlaConstant {<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span> /**<a name="line.204"></a>
<span class="sourceLineNo">205</span> * Indicates that the level is not related to time.<a name="line.205"></a>
<span class="sourceLineNo">206</span> */<a name="line.206"></a>
<span class="sourceLineNo">207</span> REGULAR(0x0000),<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> /**<a name="line.209"></a>
<span class="sourceLineNo">210</span> * Indicates that the level contains the 'all' member of its hierarchy.<a name="line.210"></a>
<span class="sourceLineNo">211</span> */<a name="line.211"></a>
<span class="sourceLineNo">212</span> ALL(0x0001),<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span> /**<a name="line.214"></a>
<span class="sourceLineNo">215</span> * Indicates that a level holds the null member. Does not correspond to<a name="line.215"></a>
<span class="sourceLineNo">216</span> * an XMLA or OLE DB value.<a name="line.216"></a>
<span class="sourceLineNo">217</span> */<a name="line.217"></a>
<span class="sourceLineNo">218</span> NULL(-1),<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span> /**<a name="line.220"></a>
<span class="sourceLineNo">221</span> * Indicates that a level refers to years.<a name="line.221"></a>
<span class="sourceLineNo">222</span> * It must be used in a dimension whose type is<a name="line.222"></a>
<span class="sourceLineNo">223</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.223"></a>
<span class="sourceLineNo">224</span> */<a name="line.224"></a>
<span class="sourceLineNo">225</span> TIME_YEARS(0x0014),<a name="line.225"></a>
<span class="sourceLineNo">226</span><a name="line.226"></a>
<span class="sourceLineNo">227</span> /**<a name="line.227"></a>
<span class="sourceLineNo">228</span> * Indicates that a level refers to half years.<a name="line.228"></a>
<span class="sourceLineNo">229</span> * It must be used in a dimension whose type is<a name="line.229"></a>
<span class="sourceLineNo">230</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.230"></a>
<span class="sourceLineNo">231</span> */<a name="line.231"></a>
<span class="sourceLineNo">232</span> TIME_HALF_YEAR(0x0024),<a name="line.232"></a>
<span class="sourceLineNo">233</span><a name="line.233"></a>
<span class="sourceLineNo">234</span> /**<a name="line.234"></a>
<span class="sourceLineNo">235</span> * Indicates that a level refers to quarters.<a name="line.235"></a>
<span class="sourceLineNo">236</span> * It must be used in a dimension whose type is<a name="line.236"></a>
<span class="sourceLineNo">237</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.237"></a>
<span class="sourceLineNo">238</span> */<a name="line.238"></a>
<span class="sourceLineNo">239</span> TIME_QUARTERS(0x0044),<a name="line.239"></a>
<span class="sourceLineNo">240</span><a name="line.240"></a>
<span class="sourceLineNo">241</span> /**<a name="line.241"></a>
<span class="sourceLineNo">242</span> * Indicates that a level refers to months.<a name="line.242"></a>
<span class="sourceLineNo">243</span> * It must be used in a dimension whose type is<a name="line.243"></a>
<span class="sourceLineNo">244</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.244"></a>
<span class="sourceLineNo">245</span> */<a name="line.245"></a>
<span class="sourceLineNo">246</span> TIME_MONTHS(0x0084),<a name="line.246"></a>
<span class="sourceLineNo">247</span><a name="line.247"></a>
<span class="sourceLineNo">248</span> /**<a name="line.248"></a>
<span class="sourceLineNo">249</span> * Indicates that a level refers to weeks.<a name="line.249"></a>
<span class="sourceLineNo">250</span> * It must be used in a dimension whose type is<a name="line.250"></a>
<span class="sourceLineNo">251</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.251"></a>
<span class="sourceLineNo">252</span> */<a name="line.252"></a>
<span class="sourceLineNo">253</span> TIME_WEEKS(0x0104),<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span> /**<a name="line.255"></a>
<span class="sourceLineNo">256</span> * Indicates that a level refers to days.<a name="line.256"></a>
<span class="sourceLineNo">257</span> * It must be used in a dimension whose type is<a name="line.257"></a>
<span class="sourceLineNo">258</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.258"></a>
<span class="sourceLineNo">259</span> */<a name="line.259"></a>
<span class="sourceLineNo">260</span> TIME_DAYS(0x0204),<a name="line.260"></a>
<span class="sourceLineNo">261</span><a name="line.261"></a>
<span class="sourceLineNo">262</span> /**<a name="line.262"></a>
<span class="sourceLineNo">263</span> * Indicates that a level refers to hours.<a name="line.263"></a>
<span class="sourceLineNo">264</span> * It must be used in a dimension whose type is<a name="line.264"></a>
<span class="sourceLineNo">265</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.265"></a>
<span class="sourceLineNo">266</span> */<a name="line.266"></a>
<span class="sourceLineNo">267</span> TIME_HOURS(0x0304),<a name="line.267"></a>
<span class="sourceLineNo">268</span><a name="line.268"></a>
<span class="sourceLineNo">269</span> /**<a name="line.269"></a>
<span class="sourceLineNo">270</span> * Indicates that a level refers to minutes.<a name="line.270"></a>
<span class="sourceLineNo">271</span> * It must be used in a dimension whose type is<a name="line.271"></a>
<span class="sourceLineNo">272</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.272"></a>
<span class="sourceLineNo">273</span> */<a name="line.273"></a>
<span class="sourceLineNo">274</span> TIME_MINUTES(0x0404),<a name="line.274"></a>
<span class="sourceLineNo">275</span><a name="line.275"></a>
<span class="sourceLineNo">276</span> /**<a name="line.276"></a>
<span class="sourceLineNo">277</span> * Indicates that a level refers to seconds.<a name="line.277"></a>
<span class="sourceLineNo">278</span> * It must be used in a dimension whose type is<a name="line.278"></a>
<span class="sourceLineNo">279</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.279"></a>
<span class="sourceLineNo">280</span> */<a name="line.280"></a>
<span class="sourceLineNo">281</span> TIME_SECONDS(0x0804),<a name="line.281"></a>
<span class="sourceLineNo">282</span><a name="line.282"></a>
<span class="sourceLineNo">283</span> /**<a name="line.283"></a>
<span class="sourceLineNo">284</span> * Indicates that a level refers to days.<a name="line.284"></a>
<span class="sourceLineNo">285</span> * It must be used in a dimension whose type is<a name="line.285"></a>
<span class="sourceLineNo">286</span> * {@link org.olap4j.metadata.Dimension.Type#TIME}.<a name="line.286"></a>
<span class="sourceLineNo">287</span> */<a name="line.287"></a>
<span class="sourceLineNo">288</span> TIME_UNDEFINED(0x1004),<a name="line.288"></a>
<span class="sourceLineNo">289</span><a name="line.289"></a>
<span class="sourceLineNo">290</span> GEO_CONTINENT(0x2001),<a name="line.290"></a>
<span class="sourceLineNo">291</span> GEO_REGION(0x2002),<a name="line.291"></a>
<span class="sourceLineNo">292</span> GEO_COUNTRY(0x2003),<a name="line.292"></a>
<span class="sourceLineNo">293</span> GEO_STATE_OR_PROVINCE(0x2004),<a name="line.293"></a>
<span class="sourceLineNo">294</span> GEO_COUNTY(0x2005),<a name="line.294"></a>
<span class="sourceLineNo">295</span> GEO_CITY(0x2006),<a name="line.295"></a>
<span class="sourceLineNo">296</span> GEO_POSTALCODE(0x2007),<a name="line.296"></a>
<span class="sourceLineNo">297</span> GEO_POINT(0x2008),<a name="line.297"></a>
<span class="sourceLineNo">298</span> ORG_UNIT(0x1011),<a name="line.298"></a>
<span class="sourceLineNo">299</span> BOM_RESOURCE(0x1012),<a name="line.299"></a>
<span class="sourceLineNo">300</span> QUANTITATIVE(0x1013),<a name="line.300"></a>
<span class="sourceLineNo">301</span> ACCOUNT(0x1014),<a name="line.301"></a>
<span class="sourceLineNo">302</span> CUSTOMER(0x1021),<a name="line.302"></a>
<span class="sourceLineNo">303</span> CUSTOMER_GROUP(0x1022),<a name="line.303"></a>
<span class="sourceLineNo">304</span> CUSTOMER_HOUSEHOLD(0x1023),<a name="line.304"></a>
<span class="sourceLineNo">305</span> PRODUCT(0x1031),<a name="line.305"></a>
<span class="sourceLineNo">306</span> PRODUCT_GROUP(0x1032),<a name="line.306"></a>
<span class="sourceLineNo">307</span> SCENARIO(0x1015),<a name="line.307"></a>
<span class="sourceLineNo">308</span> UTILITY(0x1016),<a name="line.308"></a>
<span class="sourceLineNo">309</span> PERSON(0x1041),<a name="line.309"></a>
<span class="sourceLineNo">310</span> COMPANY(0x1042),<a name="line.310"></a>
<span class="sourceLineNo">311</span> CURRENCY_SOURCE(0x1051),<a name="line.311"></a>
<span class="sourceLineNo">312</span> CURRENCY_DESTINATION(0x1052),<a name="line.312"></a>
<span class="sourceLineNo">313</span> CHANNEL(0x1061),<a name="line.313"></a>
<span class="sourceLineNo">314</span> REPRESENTATIVE(0x1062),<a name="line.314"></a>
<span class="sourceLineNo">315</span> PROMOTION(0x1071);<a name="line.315"></a>
<span class="sourceLineNo">316</span><a name="line.316"></a>
<span class="sourceLineNo">317</span> private final int xmlaOrdinal;<a name="line.317"></a>
<span class="sourceLineNo">318</span><a name="line.318"></a>
<span class="sourceLineNo">319</span> private static final Dictionary<Type> DICTIONARY =<a name="line.319"></a>
<span class="sourceLineNo">320</span> DictionaryImpl.forClass(Type.class);<a name="line.320"></a>
<span class="sourceLineNo">321</span><a name="line.321"></a>
<span class="sourceLineNo">322</span> /**<a name="line.322"></a>
<span class="sourceLineNo">323</span> * Per {@link org.olap4j.metadata.XmlaConstant}, returns a dictionary<a name="line.323"></a>
<span class="sourceLineNo">324</span> * of all values of this enumeration.<a name="line.324"></a>
<span class="sourceLineNo">325</span> *<a name="line.325"></a>
<span class="sourceLineNo">326</span> * @return Dictionary of all values<a name="line.326"></a>
<span class="sourceLineNo">327</span> */<a name="line.327"></a>
<span class="sourceLineNo">328</span> public static Dictionary<Type> getDictionary() {<a name="line.328"></a>
<span class="sourceLineNo">329</span> return DICTIONARY;<a name="line.329"></a>
<span class="sourceLineNo">330</span> }<a name="line.330"></a>
<span class="sourceLineNo">331</span><a name="line.331"></a>
<span class="sourceLineNo">332</span> /**<a name="line.332"></a>
<span class="sourceLineNo">333</span> * Creates a level type.<a name="line.333"></a>
<span class="sourceLineNo">334</span> *<a name="line.334"></a>
<span class="sourceLineNo">335</span> * @param xmlaOrdinal Ordinal code in XMLA or OLE DB for OLAP<a name="line.335"></a>
<span class="sourceLineNo">336</span> * specification<a name="line.336"></a>
<span class="sourceLineNo">337</span> */<a name="line.337"></a>
<span class="sourceLineNo">338</span> private Type(int xmlaOrdinal) {<a name="line.338"></a>
<span class="sourceLineNo">339</span> this.xmlaOrdinal = xmlaOrdinal;<a name="line.339"></a>
<span class="sourceLineNo">340</span> }<a name="line.340"></a>
<span class="sourceLineNo">341</span><a name="line.341"></a>
<span class="sourceLineNo">342</span> public String xmlaName() {<a name="line.342"></a>
<span class="sourceLineNo">343</span> return "MDLEVEL_TYPE_" + name();<a name="line.343"></a>
<span class="sourceLineNo">344</span> }<a name="line.344"></a>
<span class="sourceLineNo">345</span><a name="line.345"></a>
<span class="sourceLineNo">346</span> public String getDescription() {<a name="line.346"></a>
<span class="sourceLineNo">347</span> return "";<a name="line.347"></a>
<span class="sourceLineNo">348</span> }<a name="line.348"></a>
<span class="sourceLineNo">349</span><a name="line.349"></a>
<span class="sourceLineNo">350</span> public int xmlaOrdinal() {<a name="line.350"></a>
<span class="sourceLineNo">351</span> return xmlaOrdinal;<a name="line.351"></a>
<span class="sourceLineNo">352</span> }<a name="line.352"></a>
<span class="sourceLineNo">353</span><a name="line.353"></a>
<span class="sourceLineNo">354</span> /**<a name="line.354"></a>
<span class="sourceLineNo">355</span> * Returns whether this is a time-related level<a name="line.355"></a>
<span class="sourceLineNo">356</span> * ({@link #TIME_YEARS},<a name="line.356"></a>
<span class="sourceLineNo">357</span> * {@link #TIME_HALF_YEAR},<a name="line.357"></a>
<span class="sourceLineNo">358</span> * {@link #TIME_QUARTERS},<a name="line.358"></a>
<span class="sourceLineNo">359</span> * {@link #TIME_MONTHS},<a name="line.359"></a>
<span class="sourceLineNo">360</span> * {@link #TIME_WEEKS},<a name="line.360"></a>
<span class="sourceLineNo">361</span> * {@link #TIME_DAYS},<a name="line.361"></a>
<span class="sourceLineNo">362</span> * {@link #TIME_HOURS},<a name="line.362"></a>
<span class="sourceLineNo">363</span> * {@link #TIME_MINUTES},<a name="line.363"></a>
<span class="sourceLineNo">364</span> * {@link #TIME_SECONDS},<a name="line.364"></a>
<span class="sourceLineNo">365</span> * {@link #TIME_UNDEFINED}).<a name="line.365"></a>
<span class="sourceLineNo">366</span> *<a name="line.366"></a>
<span class="sourceLineNo">367</span> * @return whether this is a time-related level<a name="line.367"></a>
<span class="sourceLineNo">368</span> */<a name="line.368"></a>
<span class="sourceLineNo">369</span> public boolean isTime() {<a name="line.369"></a>
<span class="sourceLineNo">370</span> switch (this) {<a name="line.370"></a>
<span class="sourceLineNo">371</span> case TIME_YEARS:<a name="line.371"></a>
<span class="sourceLineNo">372</span> case TIME_HALF_YEAR:<a name="line.372"></a>
<span class="sourceLineNo">373</span> case TIME_QUARTERS:<a name="line.373"></a>
<span class="sourceLineNo">374</span> case TIME_MONTHS:<a name="line.374"></a>
<span class="sourceLineNo">375</span> case TIME_WEEKS:<a name="line.375"></a>
<span class="sourceLineNo">376</span> case TIME_DAYS:<a name="line.376"></a>
<span class="sourceLineNo">377</span> case TIME_HOURS:<a name="line.377"></a>
<span class="sourceLineNo">378</span> case TIME_MINUTES:<a name="line.378"></a>
<span class="sourceLineNo">379</span> case TIME_SECONDS:<a name="line.379"></a>
<span class="sourceLineNo">380</span> case TIME_UNDEFINED:<a name="line.380"></a>
<span class="sourceLineNo">381</span> return true;<a name="line.381"></a>
<span class="sourceLineNo">382</span> default:<a name="line.382"></a>
<span class="sourceLineNo">383</span> return false;<a name="line.383"></a>
<span class="sourceLineNo">384</span> }<a name="line.384"></a>
<span class="sourceLineNo">385</span> }<a name="line.385"></a>
<span class="sourceLineNo">386</span> }<a name="line.386"></a>
<span class="sourceLineNo">387</span>}<a name="line.387"></a>
<span class="sourceLineNo">388</span><a name="line.388"></a>
<span class="sourceLineNo">389</span>// End Level.java<a name="line.389"></a>
</pre>
</div>
</body>
</html>
|