/usr/share/doc/libolap4j-java/api/org/olap4j/query/Selection.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 | <!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>Selection (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="Selection (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/query/QueryNodeListener.html" title="interface in org.olap4j.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/olap4j/query/Selection.Operator.html" title="enum in org.olap4j.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/olap4j/query/Selection.html" target="_top">Frames</a></li>
<li><a href="Selection.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.query</div>
<h2 title="Interface Selection" class="title">Interface Selection</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <a href="../../../src-html/org/olap4j/query/Selection.html#line.47">Selection</a></pre>
<div class="block">A selection of members from an OLAP dimension hierarchy. The selection
is a conceptual list of members from a given hierarchy. Once a selection
object is created, one can decide to include or exclude this selection
of members from the resulting query.
<p>Concrete subclasses of this represent a real selection.
Selections include things such as 'children of', 'siblings of',
'descendents of' etc.
<p>This class is different from a <a href="../../../org/olap4j/metadata/Member.html" title="interface in org.olap4j.metadata"><code>Member</code></a> because it represents an
abstract member selection (e.g. children of widget' that may not represent
any members whereas a Member represents a single member that is known to
exist.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>May 30, 2007</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: Selection.java 482 2012-01-05 23:27:27Z jhyde $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>jdixon, jhyde, Luc Boudreau</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/query/Selection.Operator.html" title="enum in org.olap4j.query">Selection.Operator</a></strong></code>
<div class="block">Defines which selection operators are allowed, relative to
a root member.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/query/Selection.html#addContext(org.olap4j.query.Selection)">addContext</a></strong>(<a href="../../../org/olap4j/query/Selection.html" title="interface in org.olap4j.query">Selection</a> selection)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/query/Selection.html#addQueryNodeListener(org.olap4j.query.QueryNodeListener)">addQueryNodeListener</a></strong>(<a href="../../../org/olap4j/query/QueryNodeListener.html" title="interface in org.olap4j.query">QueryNodeListener</a> l)</code>
<div class="block">Registers a new listener for a QueryNode.</div>
</td>
</tr>
<tr class="altColor">
<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/query/Selection.html#getDimension()">getDimension</a></strong>()</code>
<div class="block">Parent Dimension of the root selection element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/olap4j/query/Selection.Operator.html" title="enum in org.olap4j.query">Selection.Operator</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/query/Selection.html#getOperator()">getOperator</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/olap4j/metadata/MetadataElement.html" title="interface in org.olap4j.metadata">MetadataElement</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/query/Selection.html#getRootElement()">getRootElement</a></strong>()</code>
<div class="block">Returns the root selection element of this selection.</div>
</td>
</tr>
<tr class="rowColor">
<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/query/Selection.html" title="interface in org.olap4j.query">Selection</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/query/Selection.html#getSelectionContext()">getSelectionContext</a></strong>()</code>
<div class="block">The selection context includes selections from other dimensions that
help determine the entire context of a selection, so drill down is
possible.</div>
</td>
</tr>
<tr class="altColor">
<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/query/Selection.html#getUniqueName()">getUniqueName</a></strong>()</code>
<div class="block">Unique name of the selection root.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/query/Selection.html#removeContext(org.olap4j.query.Selection)">removeContext</a></strong>(<a href="../../../org/olap4j/query/Selection.html" title="interface in org.olap4j.query">Selection</a> selection)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/query/Selection.html#removeQueryNodeListener(org.olap4j.query.QueryNodeListener)">removeQueryNodeListener</a></strong>(<a href="../../../org/olap4j/query/QueryNodeListener.html" title="interface in org.olap4j.query">QueryNodeListener</a> l)</code>
<div class="block">De-registers a new listener for a QueryNode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/query/Selection.html#setOperator(org.olap4j.query.Selection.Operator)">setOperator</a></strong>(<a href="../../../org/olap4j/query/Selection.Operator.html" title="enum in org.olap4j.query">Selection.Operator</a> operator)</code>
<div class="block">Set the selection operator to use.</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/query/Selection.html#visit()">visit</a></strong>()</code>
<div class="block">Visitor pattern-like function to convert
the selection into a ParseTreeNode.</div>
</td>
</tr>
</table>
</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="getUniqueName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUniqueName</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/query/Selection.html#line.53">getUniqueName</a>()</pre>
<div class="block">Unique name of the selection root.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The unique OLAP name of the selection root.</dd></dl>
</li>
</ul>
<a name="visit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visit</h4>
<pre><a href="../../../org/olap4j/mdx/ParseTreeNode.html" title="interface in org.olap4j.mdx">ParseTreeNode</a> <a href="../../../src-html/org/olap4j/query/Selection.html#line.62">visit</a>()</pre>
<div class="block">Visitor pattern-like function to convert
the selection into a ParseTreeNode. Typical
implementation should be:<br/>
<code>Olap4jNodeConverter.toOlap4j(member, operator);</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A parse tree node of the selection.</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/query/Selection.html#line.68">getDimension</a>()</pre>
<div class="block">Parent Dimension of the root selection element.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A dimension object.</dd></dl>
</li>
</ul>
<a name="getRootElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootElement</h4>
<pre><a href="../../../org/olap4j/metadata/MetadataElement.html" title="interface in org.olap4j.metadata">MetadataElement</a> <a href="../../../src-html/org/olap4j/query/Selection.html#line.74">getRootElement</a>()</pre>
<div class="block">Returns the root selection element of this selection.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The root metadata object.</dd></dl>
</li>
</ul>
<a name="getSelectionContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectionContext</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/query/Selection.html" title="interface in org.olap4j.query">Selection</a>> <a href="../../../src-html/org/olap4j/query/Selection.html#line.83">getSelectionContext</a>()</pre>
<div class="block">The selection context includes selections from other dimensions that
help determine the entire context of a selection, so drill down is
possible.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>list of selections</dd></dl>
</li>
</ul>
<a name="addContext(org.olap4j.query.Selection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContext</h4>
<pre>void <a href="../../../src-html/org/olap4j/query/Selection.html#line.85">addContext</a>(<a href="../../../org/olap4j/query/Selection.html" title="interface in org.olap4j.query">Selection</a> selection)</pre>
</li>
</ul>
<a name="removeContext(org.olap4j.query.Selection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContext</h4>
<pre>void <a href="../../../src-html/org/olap4j/query/Selection.html#line.87">removeContext</a>(<a href="../../../org/olap4j/query/Selection.html" title="interface in org.olap4j.query">Selection</a> selection)</pre>
</li>
</ul>
<a name="getOperator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperator</h4>
<pre><a href="../../../org/olap4j/query/Selection.Operator.html" title="enum in org.olap4j.query">Selection.Operator</a> <a href="../../../src-html/org/olap4j/query/Selection.html#line.89">getOperator</a>()</pre>
</li>
</ul>
<a name="setOperator(org.olap4j.query.Selection.Operator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOperator</h4>
<pre>void <a href="../../../src-html/org/olap4j/query/Selection.html#line.97">setOperator</a>(<a href="../../../org/olap4j/query/Selection.Operator.html" title="enum in org.olap4j.query">Selection.Operator</a> operator)</pre>
<div class="block">Set the selection operator to use.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>operator</code> - Operator to apply on the selection.</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 the operator cannot
be used on the root selection member.</dd></dl>
</li>
</ul>
<a name="addQueryNodeListener(org.olap4j.query.QueryNodeListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addQueryNodeListener</h4>
<pre>void <a href="../../../src-html/org/olap4j/query/QueryNode.html#line.36">addQueryNodeListener</a>(<a href="../../../org/olap4j/query/QueryNodeListener.html" title="interface in org.olap4j.query">QueryNodeListener</a> l)</pre>
<div class="block">Registers a new listener for a QueryNode.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>l</code> - The new listener object, implementation of QueryNodeListener</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/olap4j/query/QueryNodeListener.html" title="interface in org.olap4j.query"><code>QueryNodeListener</code></a></dd></dl>
</li>
</ul>
<a name="removeQueryNodeListener(org.olap4j.query.QueryNodeListener)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeQueryNodeListener</h4>
<pre>void <a href="../../../src-html/org/olap4j/query/QueryNode.html#line.45">removeQueryNodeListener</a>(<a href="../../../org/olap4j/query/QueryNodeListener.html" title="interface in org.olap4j.query">QueryNodeListener</a> l)</pre>
<div class="block">De-registers a new listener for a QueryNode.
If the listener object passed as a parameter was not registered,
the method will return silently.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>l</code> - The listener object to de-register.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/olap4j/query/QueryNodeListener.html" title="interface in org.olap4j.query"><code>QueryNodeListener</code></a></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/query/QueryNodeListener.html" title="interface in org.olap4j.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/olap4j/query/Selection.Operator.html" title="enum in org.olap4j.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/olap4j/query/Selection.html" target="_top">Frames</a></li>
<li><a href="Selection.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>
|