|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
|
|
|
<html lang="en"> |
|
<head> |
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
|
<title>ElementQuery (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="ElementQuery (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)"; |
|
} |
|
} |
|
catch(err) { |
|
} |
|
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
|
var altColor = "altColor"; |
|
var rowColor = "rowColor"; |
|
var tableTab = "tableTab"; |
|
var activeTableTab = "activeTableTab"; |
|
</script> |
|
<noscript> |
|
<div>JavaScript is disabled on your browser.</div> |
|
</noscript> |
|
|
|
<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/ElementQuery.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/BaseQuery.html" title="class in org.janusgraph.graphdb.query"><span class="typeNameLink">Prev Class</span></a></li> |
|
<li><a href="../../../../org/janusgraph/graphdb/query/JanusGraphPredicateUtils.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/ElementQuery.html" target="_top">Frames</a></li> |
|
<li><a href="ElementQuery.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"> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</script> |
|
</div> |
|
<div> |
|
<ul class="subNavList"> |
|
<li>Summary: </li> |
|
<li>Nested | </li> |
|
<li>Field | </li> |
|
<li>Constr | </li> |
|
<li><a href="#method.summary">Method</a></li> |
|
</ul> |
|
<ul class="subNavList"> |
|
<li>Detail: </li> |
|
<li>Field | </li> |
|
<li>Constr | </li> |
|
<li><a href="#method.detail">Method</a></li> |
|
</ul> |
|
</div> |
|
<a name="skip.navbar.top"> |
|
|
|
</a></div> |
|
|
|
|
|
<div class="header"> |
|
<div class="subTitle">org.janusgraph.graphdb.query</div> |
|
<h2 title="Interface ElementQuery" class="title">Interface ElementQuery<R extends <a href="../../../../org/janusgraph/core/JanusGraphElement.html" title="interface in org.janusgraph.core">JanusGraphElement</a>,B extends <a href="../../../../org/janusgraph/graphdb/query/BackendQuery.html" title="interface in org.janusgraph.graphdb.query">BackendQuery</a><B>></h2> |
|
</div> |
|
<div class="contentContainer"> |
|
<div class="description"> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<dl> |
|
<dt>All Superinterfaces:</dt> |
|
<dd><a href="../../../../org/janusgraph/graphdb/query/profile/ProfileObservable.html" title="interface in org.janusgraph.graphdb.query.profile">ProfileObservable</a>, <a href="../../../../org/janusgraph/graphdb/query/Query.html" title="interface in org.janusgraph.graphdb.query">Query</a></dd> |
|
</dl> |
|
<dl> |
|
<dt>All Known Implementing Classes:</dt> |
|
<dd><a href="../../../../org/janusgraph/graphdb/query/graph/GraphCentricQuery.html" title="class in org.janusgraph.graphdb.query.graph">GraphCentricQuery</a>, <a href="../../../../org/janusgraph/graphdb/query/vertex/VertexCentricQuery.html" title="class in org.janusgraph.graphdb.query.vertex">VertexCentricQuery</a></dd> |
|
</dl> |
|
<hr> |
|
<br> |
|
<pre>public interface <span class="typeNameLabel">ElementQuery<R extends <a href="../../../../org/janusgraph/core/JanusGraphElement.html" title="interface in org.janusgraph.core">JanusGraphElement</a>,B extends <a href="../../../../org/janusgraph/graphdb/query/BackendQuery.html" title="interface in org.janusgraph.graphdb.query">BackendQuery</a><B>></span> |
|
extends <a href="../../../../org/janusgraph/graphdb/query/Query.html" title="interface in org.janusgraph.graphdb.query">Query</a>, <a href="../../../../org/janusgraph/graphdb/query/profile/ProfileObservable.html" title="interface in org.janusgraph.graphdb.query.profile">ProfileObservable</a></pre> |
|
<div class="block">A query that returns <a href="../../../../org/janusgraph/core/JanusGraphElement.html" title="interface in org.janusgraph.core"><code>JanusGraphElement</code></a>s. This query can consist of multiple sub-queries that together |
|
form the desired result set.</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"> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="field.summary"> |
|
|
|
</a> |
|
<h3>Field Summary</h3> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="fields.inherited.from.class.org.janusgraph.graphdb.query.Query"> |
|
|
|
</a> |
|
<h3>Fields inherited from interface org.janusgraph.graphdb.query.<a href="../../../../org/janusgraph/graphdb/query/Query.html" title="interface in org.janusgraph.graphdb.query">Query</a></h3> |
|
<code><a href="../../../../org/janusgraph/graphdb/query/Query.html#NO_LIMIT">NO_LIMIT</a></code></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
|
|
<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></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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html" title="type parameter in ElementQuery">R</a>></code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html#getSortOrder--">getSortOrder</a></span>()</code> |
|
<div class="block">Returns the expected sort order of this query if any was specified.</div> |
|
</td> |
|
</tr> |
|
<tr id="i1" class="rowColor"> |
|
<td class="colFirst"><code><a href="../../../../org/janusgraph/graphdb/query/BackendQueryHolder.html" title="class in org.janusgraph.graphdb.query">BackendQueryHolder</a><<a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html" title="type parameter in ElementQuery">B</a>></code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html#getSubQuery-int-">getSubQuery</a></span>(int position)</code> |
|
<div class="block">Returns the backend query at the given position that comprises this ElementQuery</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/ElementQuery.html#hasDuplicateResults--">hasDuplicateResults</a></span>()</code> |
|
<div class="block">Whether the combination of the individual sub-queries can result in duplicate |
|
results.</div> |
|
</td> |
|
</tr> |
|
<tr id="i3" class="rowColor"> |
|
<td class="colFirst"><code>boolean</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html#isEmpty--">isEmpty</a></span>()</code> |
|
<div class="block">Whether the result set of this query is empty</div> |
|
</td> |
|
</tr> |
|
<tr id="i4" class="altColor"> |
|
<td class="colFirst"><code>boolean</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html#isSorted--">isSorted</a></span>()</code> |
|
<div class="block">Whether this query expects the results to be in a particular sort order.</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/janusgraph/graphdb/query/ElementQuery.html#matches-R-">matches</a></span>(<a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html" title="type parameter in ElementQuery">R</a> element)</code> |
|
<div class="block">Whether the given element matches the conditions of this query.</div> |
|
</td> |
|
</tr> |
|
<tr id="i6" class="altColor"> |
|
<td class="colFirst"><code>int</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html#numSubQueries--">numSubQueries</a></span>()</code> |
|
<div class="block">Returns the number of sub-queries this query is comprised of.</div> |
|
</td> |
|
</tr> |
|
</table> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="methods.inherited.from.class.org.janusgraph.graphdb.query.Query"> |
|
|
|
</a> |
|
<h3>Methods inherited from interface org.janusgraph.graphdb.query.<a href="../../../../org/janusgraph/graphdb/query/Query.html" title="interface in org.janusgraph.graphdb.query">Query</a></h3> |
|
<code><a href="../../../../org/janusgraph/graphdb/query/Query.html#getLimit--">getLimit</a>, <a href="../../../../org/janusgraph/graphdb/query/Query.html#hasLimit--">hasLimit</a></code></li> |
|
</ul> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="methods.inherited.from.class.org.janusgraph.graphdb.query.profile.ProfileObservable"> |
|
|
|
</a> |
|
<h3>Methods inherited from interface org.janusgraph.graphdb.query.profile.<a href="../../../../org/janusgraph/graphdb/query/profile/ProfileObservable.html" title="interface in org.janusgraph.graphdb.query.profile">ProfileObservable</a></h3> |
|
<code><a href="../../../../org/janusgraph/graphdb/query/profile/ProfileObservable.html#getProfiler--">getProfiler</a>, <a href="../../../../org/janusgraph/graphdb/query/profile/ProfileObservable.html#observeWith-org.janusgraph.graphdb.query.profile.QueryProfiler-">observeWith</a>, <a href="../../../../org/janusgraph/graphdb/query/profile/ProfileObservable.html#observeWith-org.janusgraph.graphdb.query.profile.QueryProfiler-boolean-">observeWith</a></code></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</div> |
|
<div class="details"> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="method.detail"> |
|
|
|
</a> |
|
<h3>Method Detail</h3> |
|
<a name="hasDuplicateResults--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>hasDuplicateResults</h4> |
|
<pre>boolean hasDuplicateResults()</pre> |
|
<div class="block">Whether the combination of the individual sub-queries can result in duplicate |
|
results. Indicates to the query executor whether the results need to be de-duplicated</div> |
|
<dl> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
<dd>true, if duplicate results are possible, else false</dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="isEmpty--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>isEmpty</h4> |
|
<pre>boolean isEmpty()</pre> |
|
<div class="block">Whether the result set of this query is empty</div> |
|
<dl> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="numSubQueries--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>numSubQueries</h4> |
|
<pre>int numSubQueries()</pre> |
|
<div class="block">Returns the number of sub-queries this query is comprised of.</div> |
|
<dl> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="getSubQuery-int-"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>getSubQuery</h4> |
|
<pre><a href="../../../../org/janusgraph/graphdb/query/BackendQueryHolder.html" title="class in org.janusgraph.graphdb.query">BackendQueryHolder</a><<a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html" title="type parameter in ElementQuery">B</a>> getSubQuery(int position)</pre> |
|
<div class="block">Returns the backend query at the given position that comprises this ElementQuery</div> |
|
<dl> |
|
<dt><span class="paramLabel">Parameters:</span></dt> |
|
<dd><code>position</code> - </dd> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="matches-org.janusgraph.core.JanusGraphElement-"> |
|
|
|
</a><a name="matches-R-"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>matches</h4> |
|
<pre>boolean matches(<a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html" title="type parameter in ElementQuery">R</a> element)</pre> |
|
<div class="block">Whether the given element matches the conditions of this query. |
|
<p> |
|
Used for result filtering if the result set returned by the query executor is not fitted.</div> |
|
<dl> |
|
<dt><span class="paramLabel">Parameters:</span></dt> |
|
<dd><code>element</code> - </dd> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="isSorted--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>isSorted</h4> |
|
<pre>boolean isSorted()</pre> |
|
<div class="block">Whether this query expects the results to be in a particular sort order.</div> |
|
<dl> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="getSortOrder--"> |
|
|
|
</a> |
|
<ul class="blockListLast"> |
|
<li class="blockList"> |
|
<h4>getSortOrder</h4> |
|
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html" title="type parameter in ElementQuery">R</a>> getSortOrder()</pre> |
|
<div class="block">Returns the expected sort order of this query if any was specified. Check <a href="../../../../org/janusgraph/graphdb/query/ElementQuery.html#isSorted--"><code>isSorted()</code></a> first.</div> |
|
<dl> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
</dl> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</div> |
|
</div> |
|
|
|
|
|
<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/ElementQuery.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/BaseQuery.html" title="class in org.janusgraph.graphdb.query"><span class="typeNameLink">Prev Class</span></a></li> |
|
<li><a href="../../../../org/janusgraph/graphdb/query/JanusGraphPredicateUtils.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/ElementQuery.html" target="_top">Frames</a></li> |
|
<li><a href="ElementQuery.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"> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</script> |
|
</div> |
|
<div> |
|
<ul class="subNavList"> |
|
<li>Summary: </li> |
|
<li>Nested | </li> |
|
<li>Field | </li> |
|
<li>Constr | </li> |
|
<li><a href="#method.summary">Method</a></li> |
|
</ul> |
|
<ul class="subNavList"> |
|
<li>Detail: </li> |
|
<li>Field | </li> |
|
<li>Constr | </li> |
|
<li><a href="#method.detail">Method</a></li> |
|
</ul> |
|
</div> |
|
<a name="skip.navbar.bottom"> |
|
|
|
</a></div> |
|
|
|
<p class="legalCopy"><small>Copyright © 2012–2023. All rights reserved.</small></p> |
|
</body> |
|
</html> |
|
|