Google Git
Sign in
apache / beam-site / aa4899384bfb3460196adf6331c744cb480b96df / . / javadoc / 2.38.0 / org / apache / beam / sdk / io / range / OffsetRangeTracker.html
blob: ee73c067644627e5f4905eb591f59bd038c4e365 [file] [log] [blame]
<!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 -->
<title>OffsetRangeTracker (Apache Beam 2.38.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OffsetRangeTracker (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/apache/beam/sdk/io/range/OffsetRange.Coder.html" title="class in org.apache.beam.sdk.io.range"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/range/OffsetRangeTracker.html" target="_top">Frames</a></li>
<li><a href="OffsetRangeTracker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.apache.beam.sdk.io.range</div>
<h2 title="Class OffsetRangeTracker" class="title">Class OffsetRangeTracker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.range.OffsetRangeTracker</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range">RangeTracker</a>&lt;java.lang.Long&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">OffsetRangeTracker</span>
extends java.lang.Object
implements <a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range">RangeTracker</a>&lt;java.lang.Long&gt;</pre>
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range"><code>RangeTracker</code></a> for non-negative positions of type <code>long</code>.
<p>Not to be confused with <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn"><code>OffsetRangeTracker</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#OFFSET_INFINITY">OFFSET_INFINITY</a></span></code>
<div class="block">Offset corresponding to infinity.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#OffsetRangeTracker-long-long-">OffsetRangeTracker</a></span>(long&nbsp;startOffset,
long&nbsp;stopOffset)</code>
<div class="block">Creates an <code>OffsetRangeTracker</code> for the specified range.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#getFractionConsumed--">getFractionConsumed</a></span>()</code>
<div class="block">Returns the approximate fraction of positions in the source that have been consumed by
successful <a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#tryReturnRecordAt-boolean-PositionT-"><code>RangeTracker.tryReturnRecordAt(boolean, PositionT)</code></a> calls, or 0.0 if no such calls have happened.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#getPositionForFractionConsumed-double-">getPositionForFractionConsumed</a></span>(double&nbsp;fraction)</code>
<div class="block">Returns a position <code>P</code> such that the range <code>[start, P)</code> represents approximately
the given fraction of the range <code>[start, end)</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#getSplitPointsProcessed--">getSplitPointsProcessed</a></span>()</code>
<div class="block">Returns the total number of split points that have been processed.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#getStartPosition--">getStartPosition</a></span>()</code>
<div class="block">Returns the starting position of the current range, inclusive.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#getStopPosition--">getStopPosition</a></span>()</code>
<div class="block">Returns the ending position of the current range, exclusive.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#isDone--">isDone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#isStarted--">isStarted</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#markDone--">markDone</a></span>()</code>
<div class="block">Marks this range tracker as being done.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#tryReturnRecordAt-boolean-long-">tryReturnRecordAt</a></span>(boolean&nbsp;isAtSplitPoint,
long&nbsp;recordStart)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#tryReturnRecordAt-boolean-java.lang.Long-">tryReturnRecordAt</a></span>(boolean&nbsp;isAtSplitPoint,
java.lang.Long&nbsp;recordStart)</code>
<div class="block">Atomically determines whether a record at the given position can be returned and updates
internal state.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#trySplitAtPosition-long-">trySplitAtPosition</a></span>(long&nbsp;splitOffset)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#trySplitAtPosition-java.lang.Long-">trySplitAtPosition</a></span>(java.lang.Long&nbsp;splitOffset)</code>
<div class="block">Atomically splits the current range [<a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStartPosition--"><code>RangeTracker.getStartPosition()</code></a>, <a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStopPosition--"><code>RangeTracker.getStopPosition()</code></a>) into
a "primary" part [<a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStartPosition--"><code>RangeTracker.getStartPosition()</code></a>, <code>splitPosition</code>) and a "residual" part
[<code>splitPosition</code>, <a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStopPosition--"><code>RangeTracker.getStopPosition()</code></a>), assuming the current last-consumed position
is within [<a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStartPosition--"><code>RangeTracker.getStartPosition()</code></a>, splitPosition) (i.e., <code>splitPosition</code> has not been
consumed yet).</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="OFFSET_INFINITY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OFFSET_INFINITY</h4>
<pre>public static final&nbsp;long OFFSET_INFINITY</pre>
<div class="block">Offset corresponding to infinity. This can only be used as the upper-bound of a range, and
indicates reading all of the records until the end without specifying exactly what the end is.
<p>Infinite ranges cannot be split because it is impossible to estimate progress within them.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.beam.sdk.io.range.OffsetRangeTracker.OFFSET_INFINITY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="OffsetRangeTracker-long-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OffsetRangeTracker</h4>
<pre>public&nbsp;OffsetRangeTracker(long&nbsp;startOffset,
long&nbsp;stopOffset)</pre>
<div class="block">Creates an <code>OffsetRangeTracker</code> for the specified range.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isStarted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStarted</h4>
<pre>public&nbsp;boolean&nbsp;isStarted()</pre>
</li>
</ul>
<a name="isDone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDone</h4>
<pre>public&nbsp;boolean&nbsp;isDone()</pre>
</li>
</ul>
<a name="getStartPosition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartPosition</h4>
<pre>public&nbsp;java.lang.Long&nbsp;getStartPosition()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStartPosition--">RangeTracker</a></code></span></div>
<div class="block">Returns the starting position of the current range, inclusive.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStartPosition--">getStartPosition</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range">RangeTracker</a>&lt;java.lang.Long&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getStopPosition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStopPosition</h4>
<pre>public&nbsp;java.lang.Long&nbsp;getStopPosition()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStopPosition--">RangeTracker</a></code></span></div>
<div class="block">Returns the ending position of the current range, exclusive.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStopPosition--">getStopPosition</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range">RangeTracker</a>&lt;java.lang.Long&gt;</code></dd>
</dl>
</li>
</ul>
<a name="tryReturnRecordAt-boolean-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryReturnRecordAt</h4>
<pre>public&nbsp;boolean&nbsp;tryReturnRecordAt(boolean&nbsp;isAtSplitPoint,
java.lang.Long&nbsp;recordStart)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#tryReturnRecordAt-boolean-PositionT-">RangeTracker</a></code></span></div>
<div class="block">Atomically determines whether a record at the given position can be returned and updates
internal state. In particular:
<ul>
<li>If <code>isAtSplitPoint</code> is <code>true</code>, and <code>recordStart</code> is outside the current
range, returns <code>false</code>;
<li>Otherwise, updates the last-consumed position to <code>recordStart</code> and returns <code>true</code>.
</ul>
<p>This method MUST be called on all split point records. It may be called on every record.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#tryReturnRecordAt-boolean-PositionT-">tryReturnRecordAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range">RangeTracker</a>&lt;java.lang.Long&gt;</code></dd>
</dl>
</li>
</ul>
<a name="tryReturnRecordAt-boolean-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryReturnRecordAt</h4>
<pre>public&nbsp;boolean&nbsp;tryReturnRecordAt(boolean&nbsp;isAtSplitPoint,
long&nbsp;recordStart)</pre>
</li>
</ul>
<a name="trySplitAtPosition-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trySplitAtPosition</h4>
<pre>public&nbsp;boolean&nbsp;trySplitAtPosition(java.lang.Long&nbsp;splitOffset)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#trySplitAtPosition-PositionT-">RangeTracker</a></code></span></div>
<div class="block">Atomically splits the current range [<a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStartPosition--"><code>RangeTracker.getStartPosition()</code></a>, <a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStopPosition--"><code>RangeTracker.getStopPosition()</code></a>) into
a "primary" part [<a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStartPosition--"><code>RangeTracker.getStartPosition()</code></a>, <code>splitPosition</code>) and a "residual" part
[<code>splitPosition</code>, <a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStopPosition--"><code>RangeTracker.getStopPosition()</code></a>), assuming the current last-consumed position
is within [<a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getStartPosition--"><code>RangeTracker.getStartPosition()</code></a>, splitPosition) (i.e., <code>splitPosition</code> has not been
consumed yet).
<p>Updates the current range to be the primary and returns <code>true</code>. This means that all
further calls on the current object will interpret their arguments relative to the primary
range.
<p>If the split position has already been consumed, or if no <a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#tryReturnRecordAt-boolean-PositionT-"><code>RangeTracker.tryReturnRecordAt(boolean, PositionT)</code></a> call
was made yet, returns <code>false</code>. The second condition is to prevent dynamic splitting
during reader start-up.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#trySplitAtPosition-PositionT-">trySplitAtPosition</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range">RangeTracker</a>&lt;java.lang.Long&gt;</code></dd>
</dl>
</li>
</ul>
<a name="trySplitAtPosition-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trySplitAtPosition</h4>
<pre>public&nbsp;boolean&nbsp;trySplitAtPosition(long&nbsp;splitOffset)</pre>
</li>
</ul>
<a name="getPositionForFractionConsumed-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPositionForFractionConsumed</h4>
<pre>public&nbsp;long&nbsp;getPositionForFractionConsumed(double&nbsp;fraction)</pre>
<div class="block">Returns a position <code>P</code> such that the range <code>[start, P)</code> represents approximately
the given fraction of the range <code>[start, end)</code>. Assumes that the density of records in
the range is approximately uniform.</div>
</li>
</ul>
<a name="getFractionConsumed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFractionConsumed</h4>
<pre>public&nbsp;double&nbsp;getFractionConsumed()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getFractionConsumed--">RangeTracker</a></code></span></div>
<div class="block">Returns the approximate fraction of positions in the source that have been consumed by
successful <a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#tryReturnRecordAt-boolean-PositionT-"><code>RangeTracker.tryReturnRecordAt(boolean, PositionT)</code></a> calls, or 0.0 if no such calls have happened.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html#getFractionConsumed--">getFractionConsumed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range">RangeTracker</a>&lt;java.lang.Long&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getSplitPointsProcessed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSplitPointsProcessed</h4>
<pre>public&nbsp;long&nbsp;getSplitPointsProcessed()</pre>
<div class="block">Returns the total number of split points that have been processed.
<p>A split point at a particular offset has been seen if there has been a corresponding call to
<a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#tryReturnRecordAt-boolean-long-"><code>tryReturnRecordAt(boolean, long)</code></a> with <code>isAtSplitPoint</code> true. It has been
processed if there has been a <em>subsequent</em> call to <a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#tryReturnRecordAt-boolean-long-"><code>tryReturnRecordAt(boolean,
long)</code></a> with <code>isAtSplitPoint</code> true and at a larger offset.
<p>Note that for correctness when implementing <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getSplitPointsConsumed--"><code>BoundedSource.BoundedReader.getSplitPointsConsumed()</code></a>,
if a reader finishes before <a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#tryReturnRecordAt-boolean-long-"><code>tryReturnRecordAt(boolean, long)</code></a> returns false, the reader
should add an additional call to <a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRangeTracker.html#markDone--"><code>markDone()</code></a>. This will indicate that processing for
the last seen split point has been finished.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html" title="class in org.apache.beam.sdk.io"><code>for a {@link BoundedReader} implemented using
{@link OffsetRangeTracker}.</code></a></dd>
</dl>
</li>
</ul>
<a name="markDone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>markDone</h4>
<pre>public&nbsp;boolean&nbsp;markDone()</pre>
<div class="block">Marks this range tracker as being done. Specifically, this will mark the current split point,
if one exists, as being finished.
<p>Always returns false, so that it can be used in an implementation of <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--"><code>Source.Reader.start()</code></a> or <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--"><code>Source.Reader.advance()</code></a> as follows:
<pre><code>
public boolean start() {
return startImpl() &amp;&amp; rangeTracker.tryReturnRecordAt(isAtSplitPoint, position)
|| rangeTracker.markDone();
}
</code></pre></div>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRange.Coder.html" title="class in org.apache.beam.sdk.io.range"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/range/RangeTracker.html" title="interface in org.apache.beam.sdk.io.range"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/range/OffsetRangeTracker.html" target="_top">Frames</a></li>
<li><a href="OffsetRangeTracker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>