/usr/share/doc/libolap4j-java/api/org/olap4j/AllocationPolicy.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Sat Aug 17 11:43:52 UTC 2013 -->
<title>AllocationPolicy (olap4j, version 1.0.1.500)</title>
<meta name="date" content="2013-08-17">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AllocationPolicy (olap4j, version 1.0.1.500)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../org/olap4j/Axis.html" title="interface in org.olap4j"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/olap4j/AllocationPolicy.html" target="_top">Frames</a></li>
<li><a href="AllocationPolicy.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#enum_constant_summary">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.olap4j</div>
<h2 title="Enum AllocationPolicy" class="title">Enum AllocationPolicy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a>></li>
<li>
<ul class="inheritance">
<li>org.olap4j.AllocationPolicy</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="/usr/share/doc/default-jdk-doc/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a>></dd>
</dl>
<hr>
<br>
<pre>public enum <a href="../../src-html/org/olap4j/AllocationPolicy.html#line.32">AllocationPolicy</a>
extends <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a>></pre>
<div class="block">Enumeration of the policies that can be used to modify the values of
child cells when their parent cell is modified in a writeback operation.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Aug 22, 2006</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: AllocationPolicy.java 482 2012-01-05 23:27:27Z jhyde $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>jhyde</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../org/olap4j/Cell.html#setValue(java.lang.Object, org.olap4j.AllocationPolicy, java.lang.Object...)"><code>Cell.setValue(java.lang.Object, org.olap4j.AllocationPolicy, java.lang.Object...)</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum_constant_summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../org/olap4j/AllocationPolicy.html#EQUAL_ALLOCATION">EQUAL_ALLOCATION</a></strong></code>
<div class="block">Every atomic cell that contributes to the updated cell will be
assigned an equal value that is:
<atomic cell value> =
<value> / Count(atomic cells contained in <tuple>)
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../org/olap4j/AllocationPolicy.html#EQUAL_INCREMENT">EQUAL_INCREMENT</a></strong></code>
<div class="block">Every atomic cell that contributes to the updated cell will be
changed according to:
<atomic cell value> = <atomic cell value> +
(<value> - <existing value>) /
Count(atomic cells contained in <tuple>)
</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../org/olap4j/AllocationPolicy.html#WEIGHTED_ALLOCATION">WEIGHTED_ALLOCATION</a></strong></code>
<div class="block">Every atomic cell that contributes to the updated cell will be
assigned an equal value that is:
<atomic cell value> =
<value> * <weight value expression>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../org/olap4j/AllocationPolicy.html#WEIGHTED_INCREMENT">WEIGHTED_INCREMENT</a></strong></code>
<div class="block">Every atomic cell that contributes to the updated cell will be
changed according to:
<atomic cell value> = <atomic cell value> +
(<value> - <existing value>) *
<weight value expression>
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a></code></td>
<td class="colLast"><code><strong><a href="../../org/olap4j/AllocationPolicy.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../org/olap4j/AllocationPolicy.html#values()">values</a></strong>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class, java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum_constant_detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a name="EQUAL_ALLOCATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EQUAL_ALLOCATION</h4>
<pre>public static final <a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a> <a href="../../src-html/org/olap4j/AllocationPolicy.html#line.42">EQUAL_ALLOCATION</a></pre>
<div class="block">Every atomic cell that contributes to the updated cell will be
assigned an equal value that is:
<blockquote>
<atomic cell value> =
<value> / Count(atomic cells contained in <tuple>)
</blockquote></div>
</li>
</ul>
<a name="EQUAL_INCREMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EQUAL_INCREMENT</h4>
<pre>public static final <a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a> <a href="../../src-html/org/olap4j/AllocationPolicy.html#line.54">EQUAL_INCREMENT</a></pre>
<div class="block">Every atomic cell that contributes to the updated cell will be
changed according to:
<blockquote>
<atomic cell value> = <atomic cell value> +
(<value> - <existing value>) /
Count(atomic cells contained in <tuple>)
</blockquote></div>
</li>
</ul>
<a name="WEIGHTED_ALLOCATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WEIGHTED_ALLOCATION</h4>
<pre>public static final <a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a> <a href="../../src-html/org/olap4j/AllocationPolicy.html#line.81">WEIGHTED_ALLOCATION</a></pre>
<div class="block">Every atomic cell that contributes to the updated cell will be
assigned an equal value that is:
<blockquote>
<atomic cell value> =
<value> * <weight value expression>
</blockquote>
<p>Takes an optional argument, <code>weight_value_expression</code>.
If <code>weight_value_expression</code> is not provided, the following
expression is assigned to it by default:
<blockquote>
<weight value expression> =
<atomic cell value> / <existing value>
<blockquote>
<p>The value of <code>weight value expression</code> should be expressed
as a value between 0 and 1. This value specifies the ratio of the
allocated value you want to assign to the atomic cells that are
affected by the allocation. It is the client application programmer's
responsibilffity to create expressions whose rollup aggregate values
will equal the allocated value of the expression.</div>
</li>
</ul>
<a name="WEIGHTED_INCREMENT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WEIGHTED_INCREMENT</h4>
<pre>public static final <a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a> <a href="../../src-html/org/olap4j/AllocationPolicy.html#line.109">WEIGHTED_INCREMENT</a></pre>
<div class="block">Every atomic cell that contributes to the updated cell will be
changed according to:
<blockquote>
<atomic cell value> = <atomic cell value> +
(<value> - <existing value>) *
<weight value expression>
</blockquote>
<p>Takes an optional argument, <code>weight_value_expression</code>.
If <code>weight_value_expression</code> is not provided, the following
expression is assigned to it by default:
<blockquote>
<weight value expression> =
<atomic cell value> / <existing value>
<blockquote>
<p>The value of <code>weight value expression</code> should be expressed
as a value between 0 and 1. This value specifies the ratio of the
allocated value you want to assign to the atomic cells that are
affected by the allocation. It is the client application programmer's
responsibility to create expressions whose rollup aggregate values
will equal the allocated value of the expression.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static <a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a>[] <a href="../../src-html/org/olap4j/AllocationPolicy.html#line.112">values</a>()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (AllocationPolicy c : AllocationPolicy.values())
System.out.println(c);
</pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
the order they are declared</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static <a href="../../org/olap4j/AllocationPolicy.html" title="enum in org.olap4j">AllocationPolicy</a> <a href="../../src-html/org/olap4j/AllocationPolicy.html#line.112">valueOf</a>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant
with the specified name</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><a href="http://sourceforge.net/projects/olap4j"><img src="http://sourceforge.net/sflogo.php?group_id=168953&type=1" width="88" height="31" border="0" alt="SourceForge.net_Logo"></a></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../org/olap4j/Axis.html" title="interface in org.olap4j"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/olap4j/AllocationPolicy.html" target="_top">Frames</a></li>
<li><a href="AllocationPolicy.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#enum_constant_summary">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|