dingyiz
/

AMLSim

Model card Files Files and versions Community

AMLSim / jars /janusgraph-1.0.0 /javadocs /org /janusgraph /graphdb /query /LimitAdjustingIterator.html

dingyiz

Upload folder using huggingface_hub

2795186 verified 12 months ago

raw

history blame contribute delete

20.8 kB

	<!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 (1.8.0_382) on Sat Oct 21 16:38:48 UTC 2023 -->
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<title>LimitAdjustingIterator (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)</title>
	<meta name="date" content="2023-10-21">
	<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="LimitAdjustingIterator (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)";
	}
	}
	catch(err) {
	}
	//-->
	var methods = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":10};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/LimitAdjustingIterator.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">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li><a href="../../../../org/janusgraph/graphdb/query/JanusGraphPredicateUtils.html" title="class in org.janusgraph.graphdb.query"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../org/janusgraph/graphdb/query/MetricsQueryExecutor.html" title="class in org.janusgraph.graphdb.query"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../index.html?org/janusgraph/graphdb/query/LimitAdjustingIterator.html" target="_top">Frames</a></li>
	<li><a href="LimitAdjustingIterator.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>Nested \| </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.janusgraph.graphdb.query</div>
	<h2 title="Class LimitAdjustingIterator" class="title">Class LimitAdjustingIterator<R></h2>
	</div>
	<div class="contentContainer">
	<ul class="inheritance">
	<li><a href="https://docs.oracle.com/javase/8/docs/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.janusgraph.graphdb.query.LimitAdjustingIterator<R></li>
	</ul>
	</li>
	</ul>
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<dl>
	<dt>All Implemented Interfaces:</dt>
	<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><R>, org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<R></dd>
	</dl>
	<hr>
	<br>
	<pre>public abstract class <span class="typeNameLabel">LimitAdjustingIterator<R></span>
	extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
	implements org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<R></pre>
	<div class="block">An iterator implementation that wraps around another iterator to iterate it up to a given limit.
	The idea is that the wrapped iterator is based on data that is fairly expensive to retrieve (e.g. from a database).
	As such, we don't want to retrieve all of it but "just enough". However, if more data is requested, then we want
	the wrapped iterator to be updated (i.e. additional data be retrieved).
	<p>
	The limit for the wrapped iterator is updated by a factor of 2. When the iterator is updated, the iterator must be
	iterated through to the point of the last returned element. While this may seem expensive, it is less expensive than
	retrieving more than needed elements in the first place. However, this still means the initial currentLimit in the
	constructor should be chosen wisely.</div>
	<dl>
	<dt><span class="simpleTagLabel">Author:</span></dt>
	<dd>Matthias Broecheler (me@matthiasb.com)</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>
	<ul class="blockList">
	<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.tinkerpop.gremlin.structure.util.CloseableIterator">
	<!-- -->
	</a>
	<h3>Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.util.CloseableIterator</h3>
	<code>org.apache.tinkerpop.gremlin.structure.util.CloseableIterator.EmptyCloseableIterator<T></code></li>
	</ul>
	</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"> </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/janusgraph/graphdb/query/LimitAdjustingIterator.html#LimitAdjustingIterator-int-int-">LimitAdjustingIterator</a></span>(int maxLimit,
	int currentLimit)</code>
	<div class="block">Initializes this iterator with the current limit and the maximum number of elements that may be retrieved from the
	wrapped iterator.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html#close--">close</a></span>()</code> </td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html" title="type parameter in LimitAdjustingIterator">R</a>></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html#getNewIterator-int-">getNewIterator</a></span>(int newLimit)</code>
	<div class="block">This returns the wrapped iterator with up to the specified number of elements.</div>
	</td>
	</tr>
	<tr id="i2" class="altColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html#hasNext--">hasNext</a></span>()</code> </td>
	</tr>
	<tr id="i3" class="rowColor">
	<td class="colFirst"><code><a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html" title="type parameter in LimitAdjustingIterator">R</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html#next--">next</a></span>()</code> </td>
	</tr>
	<tr id="i4" class="altColor">
	<td class="colFirst"><code>void</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html#remove--">remove</a></span>()</code> </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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
	<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="methods.inherited.from.class.org.apache.tinkerpop.gremlin.structure.util.CloseableIterator">
	<!-- -->
	</a>
	<h3>Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.CloseableIterator</h3>
	<code>closeIterator, empty, of</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="methods.inherited.from.class.java.util.Iterator">
	<!-- -->
	</a>
	<h3>Methods inherited from interface java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></h3>
	<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#forEachRemaining-java.util.function.Consumer-" title="class or interface in java.util">forEachRemaining</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="LimitAdjustingIterator-int-int-">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>LimitAdjustingIterator</h4>
	<pre>public LimitAdjustingIterator(int maxLimit,
	int currentLimit)</pre>
	<div class="block">Initializes this iterator with the current limit and the maximum number of elements that may be retrieved from the
	wrapped iterator.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>maxLimit</code> - </dd>
	<dd><code>currentLimit</code> - </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="getNewIterator-int-">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getNewIterator</h4>
	<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html" title="type parameter in LimitAdjustingIterator">R</a>> getNewIterator(int newLimit)</pre>
	<div class="block">This returns the wrapped iterator with up to the specified number of elements.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>newLimit</code> - </dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	</dl>
	</li>
	</ul>
	<a name="hasNext--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>hasNext</h4>
	<pre>public boolean hasNext()</pre>
	<dl>
	<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
	<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#hasNext--" title="class or interface in java.util">hasNext</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html" title="type parameter in LimitAdjustingIterator">R</a>></code></dd>
	</dl>
	</li>
	</ul>
	<a name="next--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>next</h4>
	<pre>public <a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html" title="type parameter in LimitAdjustingIterator">R</a> next()</pre>
	<dl>
	<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
	<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#next--" title="class or interface in java.util">next</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html" title="type parameter in LimitAdjustingIterator">R</a>></code></dd>
	</dl>
	</li>
	</ul>
	<a name="remove--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>remove</h4>
	<pre>public void remove()</pre>
	<dl>
	<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
	<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#remove--" title="class or interface in java.util">remove</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html" title="type parameter in LimitAdjustingIterator">R</a>></code></dd>
	</dl>
	</li>
	</ul>
	<a name="close--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>close</h4>
	<pre>public void close()</pre>
	<dl>
	<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
	<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
	<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
	<dd><code>close</code> in interface <code>org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<<a href="../../../../org/janusgraph/graphdb/query/LimitAdjustingIterator.html" title="type parameter in LimitAdjustingIterator">R</a>></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="class-use/LimitAdjustingIterator.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">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li><a href="../../../../org/janusgraph/graphdb/query/JanusGraphPredicateUtils.html" title="class in org.janusgraph.graphdb.query"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../org/janusgraph/graphdb/query/MetricsQueryExecutor.html" title="class in org.janusgraph.graphdb.query"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../index.html?org/janusgraph/graphdb/query/LimitAdjustingIterator.html" target="_top">Frames</a></li>
	<li><a href="LimitAdjustingIterator.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>Nested \| </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 ======= -->
	<p class="legalCopy"><small>Copyright © 2012–2023. All rights reserved.</small></p>
	</body>
	</html>