blob: 04e64d6dff2188d7e23f360a82c63d21d1445a40 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>DistinctDataNet (Apache Jena ARQ)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: module: org.apache.jena.arq, package: org.apache.jena.atlas.data, class: DistinctDataNet">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/DistinctDataNet.html">Use</a></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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../module-summary.html">org.apache.jena.arq</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jena.atlas.data</a></div>
<h1 title="Class DistinctDataNet" class="title">Class DistinctDataNet&lt;E&gt;</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="AbstractDataBag.html" title="class in org.apache.jena.atlas.data">org.apache.jena.atlas.data.AbstractDataBag</a>&lt;E&gt;
<div class="inheritance"><a href="SortedDataBag.html" title="class in org.apache.jena.atlas.data">org.apache.jena.atlas.data.SortedDataBag</a>&lt;E&gt;
<div class="inheritance"><a href="DistinctDataBag.html" title="class in org.apache.jena.atlas.data">org.apache.jena.atlas.data.DistinctDataBag</a>&lt;E&gt;
<div class="inheritance">org.apache.jena.atlas.data.DistinctDataNet&lt;E&gt;</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;E&gt;</code>, <code><a href="DataBag.html" title="interface in org.apache.jena.atlas.data">DataBag</a>&lt;E&gt;</code>, <code>org.apache.jena.atlas.lib.Closeable</code>, <code>org.apache.jena.atlas.lib.Sink&lt;E&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DistinctDataNet&lt;E&gt;</span>
<span class="extends-implements">extends <a href="DistinctDataBag.html" title="class in org.apache.jena.atlas.data">DistinctDataBag</a>&lt;E&gt;</span></div>
<div class="block">This class is like <a href="DistinctDataBag.html" title="class in org.apache.jena.atlas.data"><code>DistinctDataBag</code></a> except that you are informed if the
item you just added was known to be distinct. This will normally only work until
the first spill. After that, the system may not be able to tell for sure, and will
thus return false. When you are finished adding items, you may call
<a href="#netIterator()"><code>netIterator()</code></a> to get any distinct items that are in the spill files but
were not indicated as distinct previously.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.jena.atlas.data.ThresholdPolicy,org.apache.jena.atlas.data.SerializationFactory,java.util.Comparator)" class="member-name-link">DistinctDataNet</a><wbr>(<a href="ThresholdPolicy.html" title="interface in org.apache.jena.atlas.data">ThresholdPolicy</a>&lt;<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&gt;&nbsp;policy,
<a href="SerializationFactory.html" title="interface in org.apache.jena.atlas.data">SerializationFactory</a>&lt;<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&gt;&nbsp;serializerFactory,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&gt;&nbsp;comparator)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#netAdd(E)" class="member-name-link">netAdd</a><wbr>(<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&nbsp;item)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#netIterator()" class="member-name-link">netIterator</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns an iterator to all additional items that are distinct but were not
reported to be so at the time <a href="#netAdd(E)"><code>netAdd(Object)</code></a> was invoked.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.atlas.data.DistinctDataBag">Methods inherited from class&nbsp;org.apache.jena.atlas.data.<a href="DistinctDataBag.html" title="class in org.apache.jena.atlas.data">DistinctDataBag</a></h3>
<code><a href="DistinctDataBag.html#isDistinct()">isDistinct</a>, <a href="DistinctDataBag.html#isSorted()">isSorted</a>, <a href="DistinctDataBag.html#iterator()">iterator</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.atlas.data.SortedDataBag">Methods inherited from class&nbsp;org.apache.jena.atlas.data.<a href="SortedDataBag.html" title="class in org.apache.jena.atlas.data">SortedDataBag</a></h3>
<code><a href="SortedDataBag.html#add(E)">add</a>, <a href="SortedDataBag.html#cancel()">cancel</a>, <a href="SortedDataBag.html#close()">close</a>, <a href="SortedDataBag.html#flush()">flush</a>, <a href="SortedDataBag.html#isCancelled()">isCancelled</a>, <a href="SortedDataBag.html#isClosed()">isClosed</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.atlas.data.AbstractDataBag">Methods inherited from class&nbsp;org.apache.jena.atlas.data.<a href="AbstractDataBag.html" title="class in org.apache.jena.atlas.data">AbstractDataBag</a></h3>
<code><a href="AbstractDataBag.html#isEmpty()">isEmpty</a>, <a href="AbstractDataBag.html#send(E)">send</a>, <a href="AbstractDataBag.html#size()">size</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.atlas.data.DataBag">Methods inherited from interface&nbsp;org.apache.jena.atlas.data.<a href="DataBag.html" title="interface in org.apache.jena.atlas.data">DataBag</a></h3>
<code><a href="DataBag.html#addAll(java.lang.Iterable)">addAll</a>, <a href="DataBag.html#addAll(java.util.Iterator)">addAll</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Iterable">Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="external-link">forEach</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#spliterator()" title="class or interface in java.lang" class="external-link">spliterator</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.jena.atlas.data.ThresholdPolicy,org.apache.jena.atlas.data.SerializationFactory,java.util.Comparator)">
<h3>DistinctDataNet</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DistinctDataNet</span><wbr><span class="parameters">(<a href="ThresholdPolicy.html" title="interface in org.apache.jena.atlas.data">ThresholdPolicy</a>&lt;<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&gt;&nbsp;policy,
<a href="SerializationFactory.html" title="interface in org.apache.jena.atlas.data">SerializationFactory</a>&lt;<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&gt;&nbsp;serializerFactory,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&gt;&nbsp;comparator)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="netAdd(E)">
<h3 id="netAdd(java.lang.Object)">netAdd</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">netAdd</span><wbr><span class="parameters">(<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&nbsp;item)</span></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if the item added is known to be distinct.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="netIterator()">
<h3>netIterator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="DistinctDataNet.html" title="type parameter in DistinctDataNet">E</a>&gt;</span>&nbsp;<span class="element-name">netIterator</span>()</div>
<div class="block">Returns an iterator to all additional items that are distinct but were not
reported to be so at the time <a href="#netAdd(E)"><code>netAdd(Object)</code></a> was invoked.
<p>
If you do not exhaust the iterator, you should call
<code>Iter.close(Iterator)</code> to be sure any
open file handles are closed.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Licensed under the Apache License, Version 2.0</small></p>
</footer>
</div>
</div>
</body>
</html>