/usr/share/doc/libolap4j-java/api/org/olap4j/metadata/Member.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 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 | <!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:53 UTC 2013 -->
<title>Member (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="Member (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><a href="../../../org/olap4j/metadata/Measure.Aggregator.html" title="enum in org.olap4j.metadata"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/olap4j/metadata/Member.TreeOp.html" title="enum in org.olap4j.metadata"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/olap4j/metadata/Member.html" target="_top">Frames</a></li>
<li><a href="Member.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><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.metadata</div>
<h2 title="Interface Member" class="title">Interface Member</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../org/olap4j/metadata/MetadataElement.html" title="interface in org.olap4j.metadata">MetadataElement</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../org/olap4j/metadata/Measure.html" title="interface in org.olap4j.metadata">Measure</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../src-html/org/olap4j/metadata/Member.html#line.34">Member</a>
extends <a href="../../../org/olap4j/metadata/MetadataElement.html" title="interface in org.olap4j.metadata">MetadataElement</a></pre>
<div class="block"><code>Member</code> is a data value in an OLAP Dimension.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Aug 22, 2006</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: Member.java 482 2012-01-05 23:27:27Z jhyde $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>jhyde</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.TreeOp.html" title="enum in org.olap4j.metadata">Member.TreeOp</a></strong></code>
<div class="block">Enumeration of tree operations which can be used when querying
members.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.Type.html" title="enum in org.olap4j.metadata">Member.Type</a></strong></code>
<div class="block">Enumeration of types of members.</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><a href="/usr/share/doc/default-jdk-doc/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getAncestorMembers()">getAncestorMembers</a></strong>()</code>
<div class="block">Returns array of all members which are ancestor to <code>this</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getChildMemberCount()">getChildMemberCount</a></strong>()</code>
<div class="block">Returns the number of children this Member has.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/olap4j/metadata/NamedList.html" title="interface in org.olap4j.metadata">NamedList</a><? extends <a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getChildMembers()">getChildMembers</a></strong>()</code>
<div class="block">Returns the children of this Member, indexed by name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getDataMember()">getDataMember</a></strong>()</code>
<div class="block">Returns the system-generated data member that is associated with a
non-leaf member of a dimension.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getDepth()">getDepth</a></strong>()</code>
<div class="block">Returns the depth of this member.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/olap4j/metadata/Dimension.html" title="interface in org.olap4j.metadata">Dimension</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getDimension()">getDimension</a></strong>()</code>
<div class="block">Returns the Dimension of this Member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/olap4j/mdx/ParseTreeNode.html" title="interface in org.olap4j.mdx">ParseTreeNode</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getExpression()">getExpression</a></strong>()</code>
<div class="block">Expression by which this member is derived, if it is a calculated
member.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/olap4j/metadata/Hierarchy.html" title="interface in org.olap4j.metadata">Hierarchy</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getHierarchy()">getHierarchy</a></strong>()</code>
<div class="block">Returns the Hierarchy of this Member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/olap4j/metadata/Level.html" title="interface in org.olap4j.metadata">Level</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getLevel()">getLevel</a></strong>()</code>
<div class="block">Returns the Level of this Member.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/olap4j/metadata/Member.Type.html" title="enum in org.olap4j.metadata">Member.Type</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getMemberType()">getMemberType</a></strong>()</code>
<div class="block">Returns the type of this Member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getOrdinal()">getOrdinal</a></strong>()</code>
<div class="block">Returns the ordinal of the member.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getParentMember()">getParentMember</a></strong>()</code>
<div class="block">Returns the parent of this Member, or null if it has no parent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/olap4j/metadata/NamedList.html" title="interface in org.olap4j.metadata">NamedList</a><<a href="../../../org/olap4j/metadata/Property.html" title="interface in org.olap4j.metadata">Property</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getProperties()">getProperties</a></strong>()</code>
<div class="block">Returns the definitions of the properties this member may have.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getPropertyFormattedValue(org.olap4j.metadata.Property)">getPropertyFormattedValue</a></strong>(<a href="../../../org/olap4j/metadata/Property.html" title="interface in org.olap4j.metadata">Property</a> property)</code>
<div class="block">Returns the formatted value of a given property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getPropertyValue(org.olap4j.metadata.Property)">getPropertyValue</a></strong>(<a href="../../../org/olap4j/metadata/Property.html" title="interface in org.olap4j.metadata">Property</a> property)</code>
<div class="block">Returns the value of a given property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#getSolveOrder()">getSolveOrder</a></strong>()</code>
<div class="block">Returns the solve order of this member in a formula.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#isAll()">isAll</a></strong>()</code>
<div class="block">Returns whether this Member represents the aggregation of all members
in its Dimension.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#isCalculated()">isCalculated</a></strong>()</code>
<div class="block">Returns whether this member is calculated using a formula.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#isCalculatedInQuery()">isCalculatedInQuery</a></strong>()</code>
<div class="block">Returns whether this member is computed from a <code>WITH MEMBER</code>
clause in an MDX query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#isChildOrEqualTo(org.olap4j.metadata.Member)">isChildOrEqualTo</a></strong>(<a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a> member)</code>
<div class="block">Returns whether <code>member</code> is equal to, a child of, or a
descendent of this Member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#isHidden()">isHidden</a></strong>()</code>
<div class="block">Returns whether this member is 'hidden', as per the rules which define
a ragged hierarchy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/metadata/Member.html#setProperty(org.olap4j.metadata.Property, java.lang.Object)">setProperty</a></strong>(<a href="../../../org/olap4j/metadata/Property.html" title="interface in org.olap4j.metadata">Property</a> property,
<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> value)</code>
<div class="block">Sets a property of this member to a given value.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.olap4j.metadata.MetadataElement">
<!-- -->
</a>
<h3>Methods inherited from interface org.olap4j.metadata.<a href="../../../org/olap4j/metadata/MetadataElement.html" title="interface in org.olap4j.metadata">MetadataElement</a></h3>
<code><a href="../../../org/olap4j/metadata/MetadataElement.html#getCaption()">getCaption</a>, <a href="../../../org/olap4j/metadata/MetadataElement.html#getDescription()">getDescription</a>, <a href="../../../org/olap4j/metadata/MetadataElement.html#getName()">getName</a>, <a href="../../../org/olap4j/metadata/MetadataElement.html#getUniqueName()">getUniqueName</a>, <a href="../../../org/olap4j/metadata/MetadataElement.html#isVisible()">isVisible</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getChildMembers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildMembers</h4>
<pre><a href="../../../org/olap4j/metadata/NamedList.html" title="interface in org.olap4j.metadata">NamedList</a><? extends <a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a>> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.53">getChildMembers</a>()
throws <a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></pre>
<div class="block">Returns the children of this Member, indexed by name.
<p>If access-control is in place, the list does not contain inaccessible
children.
<p>If the member has no children, returns an empty list: the result is
never null.
<p>The caller should assume that the list is immutable;
if the caller modifies the list, behavior is undefined.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>children of this member</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></code> - if database error occurs</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/olap4j/OlapDatabaseMetaData.html#getMembers(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Set)"><code>OlapDatabaseMetaData.getMembers(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Set<org.olap4j.metadata.Member.TreeOp>)</code></a></dd></dl>
</li>
</ul>
<a name="getChildMemberCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildMemberCount</h4>
<pre>int <a href="../../../src-html/org/olap4j/metadata/Member.html#line.65">getChildMemberCount</a>()
throws <a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></pre>
<div class="block">Returns the number of children this Member has.
<p>This method has the same effect as
<code>getChildMembers().size()</code>, but is typically less expensive.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>number of children</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></code> - if database error occurs</dd></dl>
</li>
</ul>
<a name="getParentMember()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentMember</h4>
<pre><a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.72">getParentMember</a>()</pre>
<div class="block">Returns the parent of this Member, or null if it has no parent.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Parent member, or null if member has no parent</dd></dl>
</li>
</ul>
<a name="getLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLevel</h4>
<pre><a href="../../../org/olap4j/metadata/Level.html" title="interface in org.olap4j.metadata">Level</a> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.81">getLevel</a>()</pre>
<div class="block">Returns the Level of this Member.
<p>Never returns null.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Level which this Member belongs to</dd></dl>
</li>
</ul>
<a name="getHierarchy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHierarchy</h4>
<pre><a href="../../../org/olap4j/metadata/Hierarchy.html" title="interface in org.olap4j.metadata">Hierarchy</a> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.91">getHierarchy</a>()</pre>
<div class="block">Returns the Hierarchy of this Member.
<p>Never returns null.
Result is always the same as <code>getLevel().getHierarchy()</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Hierarchy which this Member belongs to</dd></dl>
</li>
</ul>
<a name="getDimension()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDimension</h4>
<pre><a href="../../../org/olap4j/metadata/Dimension.html" title="interface in org.olap4j.metadata">Dimension</a> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.101">getDimension</a>()</pre>
<div class="block">Returns the Dimension of this Member.
<p>Never returns null. Result is always the same as
<code>getLevel().getHierarchy().getDimension()</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Dimension which this Member belongs to</dd></dl>
</li>
</ul>
<a name="getMemberType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemberType</h4>
<pre><a href="../../../org/olap4j/metadata/Member.Type.html" title="enum in org.olap4j.metadata">Member.Type</a> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.110">getMemberType</a>()</pre>
<div class="block">Returns the type of this Member.
<p>Never returns null.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>What kind of member this is</dd></dl>
</li>
</ul>
<a name="isAll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAll</h4>
<pre>boolean <a href="../../../src-html/org/olap4j/metadata/Member.html#line.125">isAll</a>()</pre>
<div class="block">Returns whether this Member represents the aggregation of all members
in its Dimension.
<p>An 'all' member is always the root of its Hierarchy; that is,
its parent member is the null member, and
<a href="../../../org/olap4j/metadata/Hierarchy.html#getRootMembers()"><code>Hierarchy.getRootMembers()</code></a> returns the 'all'
member and no others. Some hierarchies do not have an 'all' member.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether this Member is the 'all' member of its Dimension</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/olap4j/metadata/Hierarchy.html#hasAll()"><code>Hierarchy.hasAll()</code></a></dd></dl>
</li>
</ul>
<a name="isChildOrEqualTo(org.olap4j.metadata.Member)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isChildOrEqualTo</h4>
<pre>boolean <a href="../../../src-html/org/olap4j/metadata/Member.html#line.164">isChildOrEqualTo</a>(<a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a> member)</pre>
<div class="block">Returns whether <code>member</code> is equal to, a child of, or a
descendent of this Member.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>member</code> - Member</dd>
<dt><span class="strong">Returns:</span></dt><dd>Whether the given Member is a descendent of this Member</dd></dl>
</li>
</ul>
<a name="isCalculated()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCalculated</h4>
<pre>boolean <a href="../../../src-html/org/olap4j/metadata/Member.html#line.178">isCalculated</a>()</pre>
<div class="block">Returns whether this member is calculated using a formula.
<p>Examples of calculated members include
those defined using a <code>WITH MEMBER</code> clause in an MDX query
(<a href="../../../org/olap4j/metadata/Member.html#getMemberType()"><code>getMemberType()</code></a> will return <a href="../../../org/olap4j/metadata/Member.Type.html#FORMULA"><code>Member.Type.FORMULA</code></a> for these),
or a calculated member defined in a cube.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Whether this Member is calculated</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/olap4j/metadata/Member.html#isCalculatedInQuery()"><code>isCalculatedInQuery()</code></a></dd></dl>
</li>
</ul>
<a name="getSolveOrder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSolveOrder</h4>
<pre>int <a href="../../../src-html/org/olap4j/metadata/Member.html#line.185">getSolveOrder</a>()</pre>
<div class="block">Returns the solve order of this member in a formula.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>solve order of this Member</dd></dl>
</li>
</ul>
<a name="getExpression()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpression</h4>
<pre><a href="../../../org/olap4j/mdx/ParseTreeNode.html" title="interface in org.olap4j.mdx">ParseTreeNode</a> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.193">getExpression</a>()</pre>
<div class="block">Expression by which this member is derived, if it is a calculated
member. If the member is not calulated, returns null.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>expression for this member</dd></dl>
</li>
</ul>
<a name="getAncestorMembers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAncestorMembers</h4>
<pre><a href="/usr/share/doc/default-jdk-doc/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a>> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.200">getAncestorMembers</a>()</pre>
<div class="block">Returns array of all members which are ancestor to <code>this</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ancestor Members</dd></dl>
</li>
</ul>
<a name="isCalculatedInQuery()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCalculatedInQuery</h4>
<pre>boolean <a href="../../../src-html/org/olap4j/metadata/Member.html#line.211">isCalculatedInQuery</a>()</pre>
<div class="block">Returns whether this member is computed from a <code>WITH MEMBER</code>
clause in an MDX query. (Calculated members can also be calculated in a
cube.)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Whether this member is calculated in a query</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/olap4j/metadata/Member.html#isCalculated()"><code>isCalculated()</code></a></dd></dl>
</li>
</ul>
<a name="getPropertyValue(org.olap4j.metadata.Property)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyValue</h4>
<pre><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> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.232">getPropertyValue</a>(<a href="../../../org/olap4j/metadata/Property.html" title="interface in org.olap4j.metadata">Property</a> property)
throws <a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></pre>
<div class="block">Returns the value of a given property.
<p>Returns null if the property is not set.</p>
<p>Every member has certain system properties such as "name" and
"caption" (the full list is described in the
<a href="../../../org/olap4j/metadata/Property.StandardMemberProperty.html" title="enum in org.olap4j.metadata"><code>Property.StandardMemberProperty</code></a>
enumeration), as well as extra properties defined for its Level
(see <a href="../../../org/olap4j/metadata/Level.html#getProperties()"><code>Level.getProperties()</code></a>).</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - Property</dd>
<dt><span class="strong">Returns:</span></dt><dd>formatted value of the given property</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></code> - if database error occurs</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/olap4j/metadata/Member.html#getPropertyFormattedValue(org.olap4j.metadata.Property)"><code>getPropertyFormattedValue(Property)</code></a></dd></dl>
</li>
</ul>
<a name="getPropertyFormattedValue(org.olap4j.metadata.Property)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyFormattedValue</h4>
<pre><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> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.253">getPropertyFormattedValue</a>(<a href="../../../org/olap4j/metadata/Property.html" title="interface in org.olap4j.metadata">Property</a> property)
throws <a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></pre>
<div class="block">Returns the formatted value of a given property.
<p>Returns null if the property is not set.</p>
<p>Every member has certain system properties such as "name" and
"caption" (the full list is described in the
<a href="../../../org/olap4j/metadata/Property.StandardMemberProperty.html" title="enum in org.olap4j.metadata"><code>Property.StandardMemberProperty</code></a>
enumeration), as well as extra properties defined for its Level
(see <a href="../../../org/olap4j/metadata/Level.html#getProperties()"><code>Level.getProperties()</code></a>).</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - Property</dd>
<dt><span class="strong">Returns:</span></dt><dd>formatted value of the given property</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></code> - if database error occurs</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/olap4j/metadata/Member.html#getPropertyValue(org.olap4j.metadata.Property)"><code>getPropertyValue(Property)</code></a></dd></dl>
</li>
</ul>
<a name="setProperty(org.olap4j.metadata.Property, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>void <a href="../../../src-html/org/olap4j/metadata/Member.html#line.271">setProperty</a>(<a href="../../../org/olap4j/metadata/Property.html" title="interface in org.olap4j.metadata">Property</a> property,
<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> value)
throws <a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></pre>
<div class="block">Sets a property of this member to a given value.
<p>Every member has certain system properties such as "name" and
"caption" (the full list is described in the
<a href="../../../org/olap4j/metadata/Property.StandardMemberProperty.html" title="enum in org.olap4j.metadata"><code>Property.StandardMemberProperty</code></a>
enumeration), as well as extra properties defined for its Level
(see <a href="../../../org/olap4j/metadata/Level.html#getProperties()"><code>Level.getProperties()</code></a>).</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - property</dd><dd><code>value</code> - Property value</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></code> - if the value not valid for this property
(for example, a String value assigned to a Boolean property)</dd></dl>
</li>
</ul>
<a name="getProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre><a href="../../../org/olap4j/metadata/NamedList.html" title="interface in org.olap4j.metadata">NamedList</a><<a href="../../../org/olap4j/metadata/Property.html" title="interface in org.olap4j.metadata">Property</a>> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.282">getProperties</a>()</pre>
<div class="block">Returns the definitions of the properties this member may have.
<p>For many providers, properties are defined against a Level, so result
of this method will be identical to
<code>member.getLevel().<a href="../../../org/olap4j/metadata/Level.html#getProperties()"><code>getProperties</code></a>()</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>properties of this Member</dd></dl>
</li>
</ul>
<a name="getOrdinal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrdinal</h4>
<pre>int <a href="../../../src-html/org/olap4j/metadata/Member.html#line.289">getOrdinal</a>()</pre>
<div class="block">Returns the ordinal of the member.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ordinal of this Member</dd></dl>
</li>
</ul>
<a name="isHidden()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHidden</h4>
<pre>boolean <a href="../../../src-html/org/olap4j/metadata/Member.html#line.297">isHidden</a>()</pre>
<div class="block">Returns whether this member is 'hidden', as per the rules which define
a ragged hierarchy.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether this member is a hidden member of a ragged hierarchy</dd></dl>
</li>
</ul>
<a name="getDepth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDepth</h4>
<pre>int <a href="../../../src-html/org/olap4j/metadata/Member.html#line.308">getDepth</a>()</pre>
<div class="block">Returns the depth of this member.
<p>In regular hierarchies, this is as the same as the level's depth,
but in parent-child and ragged hierarchies the value may be
different.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>depth of this Member</dd></dl>
</li>
</ul>
<a name="getDataMember()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDataMember</h4>
<pre><a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata">Member</a> <a href="../../../src-html/org/olap4j/metadata/Member.html#line.319">getDataMember</a>()</pre>
<div class="block">Returns the system-generated data member that is associated with a
non-leaf member of a dimension.
<p>Returns this member if this member is a leaf member, or if the
non-leaf member does not have an associated data member.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>system-generated data member</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><a href="../../../org/olap4j/metadata/Measure.Aggregator.html" title="enum in org.olap4j.metadata"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/olap4j/metadata/Member.TreeOp.html" title="enum in org.olap4j.metadata"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/olap4j/metadata/Member.html" target="_top">Frames</a></li>
<li><a href="Member.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><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|