/usr/share/doc/libolap4j-java/api/org/olap4j/mdx/ParseRegion.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 | <!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>ParseRegion (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="ParseRegion (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/mdx/ParameterNode.html" title="class in org.olap4j.mdx"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/olap4j/mdx/ParseRegion.RegionAndSource.html" title="class in org.olap4j.mdx"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/olap4j/mdx/ParseRegion.html" target="_top">Frames</a></li>
<li><a href="ParseRegion.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.mdx</div>
<h2 title="Class ParseRegion" class="title">Class ParseRegion</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>org.olap4j.mdx.ParseRegion</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.45">ParseRegion</a>
extends <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></pre>
<div class="block">Region of parser source code.
<p>The main purpose of a ParseRegion is to give detailed locations in
error messages and warnings from the parsing and validation process.
<p>A region has a start and end line number and column number. A region is
a point if the start and end positions are the same.
<p>The line and column number are one-based, because that is what end-users
understand.
<p>A region's end-points are inclusive. For example, in the code
<blockquote><pre>SELECT FROM [Sales]</pre></blockquote>
the <code>SELECT</code> token has region [1:1, 1:6].
<p>Regions are immutable.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Id: ParseRegion.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">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.RegionAndSource.html" title="class in org.olap4j.mdx">ParseRegion.RegionAndSource</a></strong></code>
<div class="block">Combination of a region within an MDX statement with the source text
of the whole MDX statement.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#ParseRegion(int, int)">ParseRegion</a></strong>(int line,
int column)</code>
<div class="block">Creates a ParseRegion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#ParseRegion(int, int, int, int)">ParseRegion</a></strong>(int startLine,
int startColumn,
int endLine,
int endColumn)</code>
<div class="block">Creates a ParseRegion.</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/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/mdx/ParseRegion.html#annotate(java.lang.String)">annotate</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> source)</code>
<div class="block">Generates a string of the source code annotated with caret symbols ("^")
at the beginning and end of the region.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#equals(java.lang.Object)">equals</a></strong>(<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> obj)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/olap4j/mdx/ParseRegion.RegionAndSource.html" title="class in org.olap4j.mdx">ParseRegion.RegionAndSource</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#findPos(java.lang.String)">findPos</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> code)</code>
<div class="block">Looks for one or two carets in an MDX string, and if present, converts
them into a parser position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#getEndColumn()">getEndColumn</a></strong>()</code>
<div class="block">Return ending column number (1-based).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#getEndLine()">getEndLine</a></strong>()</code>
<div class="block">Return ending line number (1-based).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#getStartColumn()">getStartColumn</a></strong>()</code>
<div class="block">Return starting column number (1-based).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#getStartLine()">getStartLine</a></strong>()</code>
<div class="block">Return starting line number (1-based).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#isPoint()">isPoint</a></strong>()</code>
<div class="block">Returns whether this region has the same start and end point.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/olap4j/mdx/ParseRegion.html" title="class in org.olap4j.mdx">ParseRegion</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#plusAll(java.lang.Iterable)">plusAll</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../org/olap4j/mdx/ParseRegion.html" title="class in org.olap4j.mdx">ParseRegion</a>> regions)</code>
<div class="block">Combines this region with a list of parse tree nodes to create a
region which spans from the first point in the first to the last point
in the other.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/olap4j/mdx/ParseRegion.html" title="class in org.olap4j.mdx">ParseRegion</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/olap4j/mdx/ParseRegion.html#sum(java.lang.Iterable)">sum</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../org/olap4j/mdx/ParseRegion.html" title="class in org.olap4j.mdx">ParseRegion</a>> nodes)</code>
<div class="block">Combines the parser positions of a list of nodes to create a position
which spans from the beginning of the first to the end of the last.</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/mdx/ParseRegion.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a string representation of this ParseRegion.</div>
</td>
</tr>
</table>
<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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ParseRegion(int, int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ParseRegion</h4>
<pre>public <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.64">ParseRegion</a>(int startLine,
int startColumn,
int endLine,
int endColumn)</pre>
<div class="block">Creates a ParseRegion.
<p>All lines and columns are 1-based and inclusive. For example, the
token "select" in "select from [Sales]" has a region [1:1, 1:6].</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startLine</code> - Line of the beginning of the region</dd><dd><code>startColumn</code> - Column of the beginning of the region</dd><dd><code>endLine</code> - Line of the end of the region</dd><dd><code>endColumn</code> - Column of the end of the region</dd></dl>
</li>
</ul>
<a name="ParseRegion(int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ParseRegion</h4>
<pre>public <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.86">ParseRegion</a>(int line,
int column)</pre>
<div class="block">Creates a ParseRegion.
All lines and columns are 1-based.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>line</code> - Line of the beginning and end of the region</dd><dd><code>column</code> - Column of the beginning and end of the region</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getStartLine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartLine</h4>
<pre>public int <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.98">getStartLine</a>()</pre>
<div class="block">Return starting line number (1-based).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>1-based starting line number</dd></dl>
</li>
</ul>
<a name="getStartColumn()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartColumn</h4>
<pre>public int <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.107">getStartColumn</a>()</pre>
<div class="block">Return starting column number (1-based).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>1-based starting column number</dd></dl>
</li>
</ul>
<a name="getEndLine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndLine</h4>
<pre>public int <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.116">getEndLine</a>()</pre>
<div class="block">Return ending line number (1-based).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>1-based ending line number</dd></dl>
</li>
</ul>
<a name="getEndColumn()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndColumn</h4>
<pre>public int <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.125">getEndColumn</a>()</pre>
<div class="block">Return ending column number (1-based).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>1-based starting endings column number</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public <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/mdx/ParseRegion.html#line.138">toString</a>()</pre>
<div class="block">Returns a string representation of this ParseRegion.
<p>Regions are of the form
<code>[startLine:startColumn, endLine:endColumn]</code>, or
<code>[startLine:startColumn]</code> for point regions.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <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></dd>
<dt><span class="strong">Returns:</span></dt><dd>string representation of this ParseRegion</dd></dl>
</li>
</ul>
<a name="isPoint()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPoint</h4>
<pre>public boolean <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.151">isPoint</a>()</pre>
<div class="block">Returns whether this region has the same start and end point.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether this region has the same start and end point</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.155">hashCode</a>()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <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></dd>
</dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.162">equals</a>(<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> obj)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <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></dd>
</dl>
</li>
</ul>
<a name="plusAll(java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plusAll</h4>
<pre>public <a href="../../../org/olap4j/mdx/ParseRegion.html" title="class in org.olap4j.mdx">ParseRegion</a> <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.182">plusAll</a>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../org/olap4j/mdx/ParseRegion.html" title="class in org.olap4j.mdx">ParseRegion</a>> regions)</pre>
<div class="block">Combines this region with a list of parse tree nodes to create a
region which spans from the first point in the first to the last point
in the other.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regions</code> - Collection of source code regions</dd>
<dt><span class="strong">Returns:</span></dt><dd>region which represents the span of the given regions</dd></dl>
</li>
</ul>
<a name="sum(java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sum</h4>
<pre>public static <a href="../../../org/olap4j/mdx/ParseRegion.html" title="class in org.olap4j.mdx">ParseRegion</a> <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.199">sum</a>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../org/olap4j/mdx/ParseRegion.html" title="class in org.olap4j.mdx">ParseRegion</a>> nodes)</pre>
<div class="block">Combines the parser positions of a list of nodes to create a position
which spans from the beginning of the first to the end of the last.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nodes</code> - Collection of parse tree nodes</dd>
<dt><span class="strong">Returns:</span></dt><dd>region which represents the span of the given nodes</dd></dl>
</li>
</ul>
<a name="findPos(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findPos</h4>
<pre>public static <a href="../../../org/olap4j/mdx/ParseRegion.RegionAndSource.html" title="class in org.olap4j.mdx">ParseRegion.RegionAndSource</a> <a href="../../../src-html/org/olap4j/mdx/ParseRegion.html#line.255">findPos</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> code)</pre>
<div class="block">Looks for one or two carets in an MDX string, and if present, converts
them into a parser position.
<p>Examples:
<ul>
<li>findPos("xxx^yyy") yields {"xxxyyy", position 3, line 1 column 4}
<li>findPos("xxxyyy") yields {"xxxyyy", null}
<li>findPos("xxx^yy^y") yields {"xxxyyy", position 3, line 4 column 4
through line 1 column 6}
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>code</code> - Source code</dd>
<dt><span class="strong">Returns:</span></dt><dd>object containing source code annotated with region</dd></dl>
</li>
</ul>
<a name="annotate(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>annotate</h4>
<pre>public <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/mdx/ParseRegion.html#line.368">annotate</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> source)</pre>
<div class="block">Generates a string of the source code annotated with caret symbols ("^")
at the beginning and end of the region.
<p>For example, for the region <code>(1, 9, 1, 12)</code> and source
<code>"values (foo)"</code>,
yields the string <code>"values (^foo^)"</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source code</dd>
<dt><span class="strong">Returns:</span></dt><dd>Source code annotated with position</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/mdx/ParameterNode.html" title="class in org.olap4j.mdx"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/olap4j/mdx/ParseRegion.RegionAndSource.html" title="class in org.olap4j.mdx"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/olap4j/mdx/ParseRegion.html" target="_top">Frames</a></li>
<li><a href="ParseRegion.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|