AMLSim
/
jars
/janusgraph-1.0.0
/javadocs
/org
/janusgraph
/graphdb
/tinkerpop
/optimize
/JanusGraphTraversalUtil.html
| <!-- NewPage --> | |
| <html lang="en"> | |
| <head> | |
| <!-- Generated by javadoc (1.8.0_382) on Sat Oct 21 16:38:49 UTC 2023 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>JanusGraphTraversalUtil (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="JanusGraphTraversalUtil (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9}; | |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/JanusGraphTraversalUtil.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>Prev Class</li> | |
| <li><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/MultiQueryPositions.html" title="class in org.janusgraph.graphdb.tinkerpop.optimize"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html" target="_top">Frames</a></li> | |
| <li><a href="JanusGraphTraversalUtil.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><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.tinkerpop.optimize</div> | |
| <h2 title="Class JanusGraphTraversalUtil" class="title">Class JanusGraphTraversalUtil</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.tinkerpop.optimize.JanusGraphTraversalUtil</li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <hr> | |
| <br> | |
| <pre>public class <span class="typeNameLabel">JanusGraphTraversalUtil</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></pre> | |
| <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"> | |
| <!-- ======== 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/tinkerpop/optimize/JanusGraphTraversalUtil.html#JanusGraphTraversalUtil--">JanusGraphTraversalUtil</a></span>()</code> </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static org.apache.tinkerpop.gremlin.process.traversal.Step<?,?></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#findMostOuterEligibleStart-org.apache.tinkerpop.gremlin.process.traversal.Step-">findMostOuterEligibleStart</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</code> | |
| <div class="block">In case `step` can be considered as eligible start step then | |
| this method returns the most outer eligible parent step.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/MultiQueryPositions.html" title="class in org.janusgraph.graphdb.tinkerpop.optimize">MultiQueryPositions</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getAllMultiQueryPositionsForMultiQueriable-org.janusgraph.graphdb.tinkerpop.optimize.step.MultiQueriable-boolean-boolean-">getAllMultiQueryPositionsForMultiQueriable</a></span>(<a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/step/MultiQueriable.html" title="interface in org.janusgraph.graphdb.tinkerpop.optimize.step">MultiQueriable</a><?,?> multiQueriable, | |
| boolean multiNestedRepeatEligible, | |
| boolean multiNestedRepeatNextIterationEligible)</code> | |
| <div class="block">Backtraces the traversal for the position where a MultiQueriable step would expect its corresponding | |
| JanusGraphMultiQueryStep(s).</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><org.apache.tinkerpop.gremlin.process.traversal.Step></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getEndMultiQueryPosition-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-">getEndMultiQueryPosition</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin repeatTraversal)</code> | |
| <div class="block">Returns multi query position for the end of the traversal.</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../org/janusgraph/graphdb/database/StandardJanusGraph.html" title="class in org.janusgraph.graphdb.database">StandardJanusGraph</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getJanusGraph-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-">getJanusGraph</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<?,?> traversal)</code> </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../org/janusgraph/graphdb/transaction/StandardJanusGraphTx.html" title="class in org.janusgraph.graphdb.transaction">StandardJanusGraphTx</a>></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getJanusGraphTx-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-">getJanusGraphTx</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<?,?> traversal)</code> </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../org/janusgraph/core/JanusGraphVertex.html" title="interface in org.janusgraph.core">JanusGraphVertex</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getJanusGraphVertex-org.apache.tinkerpop.gremlin.structure.Element-">getJanusGraphVertex</a></span>(org.apache.tinkerpop.gremlin.structure.Element v)</code> </td> | |
| </tr> | |
| <tr id="i6" class="altColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../org/janusgraph/core/JanusGraphVertex.html" title="interface in org.janusgraph.core">JanusGraphVertex</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getJanusGraphVertex-org.apache.tinkerpop.gremlin.process.traversal.Traverser-">getJanusGraphVertex</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Traverser<? extends org.apache.tinkerpop.gremlin.structure.Element> traverser)</code> </td> | |
| </tr> | |
| <tr id="i7" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><org.apache.tinkerpop.gremlin.process.traversal.Step></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getLocalMultiQueryPositionForStep-org.apache.tinkerpop.gremlin.process.traversal.Step-">getLocalMultiQueryPositionForStep</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</code> | |
| <div class="block">For a MultiQuery compatible step, this method searches the correct position in the step's traversal at which | |
| a <code>JanusGraphMultiQueryStep</code> should be inserted.</div> | |
| </td> | |
| </tr> | |
| <tr id="i8" class="altColor"> | |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getLocalNonMultiQueryProvidedBatchSize-org.janusgraph.graphdb.tinkerpop.optimize.step.MultiQueriable-">getLocalNonMultiQueryProvidedBatchSize</a></span>(<a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/step/MultiQueriable.html" title="interface in org.janusgraph.graphdb.tinkerpop.optimize.step">MultiQueriable</a><?,?> multiQueriable)</code> | |
| <div class="block">Returns local barrier step size if that barrier step is not generated by JanusGraphMultiQueryStep.</div> | |
| </td> | |
| </tr> | |
| <tr id="i9" class="rowColor"> | |
| <td class="colFirst"><code>static org.apache.tinkerpop.gremlin.process.traversal.Step</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getNextNonIdentityStep-org.apache.tinkerpop.gremlin.process.traversal.Step-">getNextNonIdentityStep</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Step start)</code> </td> | |
| </tr> | |
| <tr id="i10" class="altColor"> | |
| <td class="colFirst"><code>static <S> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><S></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getPreviousStepOfClass-java.lang.Class-org.apache.tinkerpop.gremlin.process.traversal.Step-">getPreviousStepOfClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><S> stepClass, | |
| org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> start)</code> | |
| <div class="block">Starting at the given step, this method searches the traversal backwards to find the most recent step which | |
| matches the given class.</div> | |
| </td> | |
| </tr> | |
| <tr id="i11" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.tinkerpop.gremlin.process.traversal.Step></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getSteps-java.util.function.Predicate-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-">getSteps</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a><org.apache.tinkerpop.gremlin.process.traversal.Step> predicate, | |
| org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<?,?> traversal)</code> | |
| <div class="block">Returns a list of steps from the traversal, which match a given predicate.</div> | |
| </td> | |
| </tr> | |
| <tr id="i12" class="altColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../org/janusgraph/core/JanusGraphTransaction.html" title="interface in org.janusgraph.core">JanusGraphTransaction</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#getTx-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-">getTx</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<?,?> traversal)</code> </td> | |
| </tr> | |
| <tr id="i13" class="rowColor"> | |
| <td class="colFirst"><code>static boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#isEdgeReturnStep-org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphVertexStep-">isEdgeReturnStep</a></span>(<a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/step/JanusGraphVertexStep.html" title="class in org.janusgraph.graphdb.tinkerpop.optimize.step">JanusGraphVertexStep</a> vertexStep)</code> </td> | |
| </tr> | |
| <tr id="i14" class="altColor"> | |
| <td class="colFirst"><code>static boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#isLegalMultiQueryPosition-org.apache.tinkerpop.gremlin.process.traversal.Step-">isLegalMultiQueryPosition</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</code> | |
| <div class="block">This method closely matches the behavior implemented in <code>LazyBarrierStrategy</code> which ensures that | |
| no <code>NoOpBarrierStep</code>s are inserted if path labels are required.</div> | |
| </td> | |
| </tr> | |
| <tr id="i15" class="rowColor"> | |
| <td class="colFirst"><code>static boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#isMultiQueryCompatibleParent-org.apache.tinkerpop.gremlin.process.traversal.Step-">isMultiQueryCompatibleParent</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</code> </td> | |
| </tr> | |
| <tr id="i16" class="altColor"> | |
| <td class="colFirst"><code>static boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#isStartStep-org.apache.tinkerpop.gremlin.process.traversal.Step-">isStartStep</a></span>(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</code> | |
| <div class="block">Checks if the provided step is the start step of its Traversal skipping any `IdentityStep`, `NoOpBarrierStep`, | |
| `SideEffectStep`, `ProfileStep`, and `JanusGraphMultiQueryStep` steps at the beginning.</div> | |
| </td> | |
| </tr> | |
| <tr id="i17" class="rowColor"> | |
| <td class="colFirst"><code>static boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html#isVertexReturnStep-org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphVertexStep-">isVertexReturnStep</a></span>(<a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/step/JanusGraphVertexStep.html" title="class in org.janusgraph.graphdb.tinkerpop.optimize.step">JanusGraphVertexStep</a> vertexStep)</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> | |
| </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="JanusGraphTraversalUtil--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>JanusGraphTraversalUtil</h4> | |
| <pre>public JanusGraphTraversalUtil()</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="getJanusGraph-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJanusGraph</h4> | |
| <pre>public static <a href="../../../../../org/janusgraph/graphdb/database/StandardJanusGraph.html" title="class in org.janusgraph.graphdb.database">StandardJanusGraph</a> getJanusGraph(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<?,?> traversal)</pre> | |
| </li> | |
| </ul> | |
| <a name="getJanusGraphTx-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJanusGraphTx</h4> | |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../org/janusgraph/graphdb/transaction/StandardJanusGraphTx.html" title="class in org.janusgraph.graphdb.transaction">StandardJanusGraphTx</a>> getJanusGraphTx(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<?,?> traversal)</pre> | |
| </li> | |
| </ul> | |
| <a name="getJanusGraphVertex-org.apache.tinkerpop.gremlin.structure.Element-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJanusGraphVertex</h4> | |
| <pre>public static <a href="../../../../../org/janusgraph/core/JanusGraphVertex.html" title="interface in org.janusgraph.core">JanusGraphVertex</a> getJanusGraphVertex(org.apache.tinkerpop.gremlin.structure.Element v)</pre> | |
| </li> | |
| </ul> | |
| <a name="getJanusGraphVertex-org.apache.tinkerpop.gremlin.process.traversal.Traverser-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJanusGraphVertex</h4> | |
| <pre>public static <a href="../../../../../org/janusgraph/core/JanusGraphVertex.html" title="interface in org.janusgraph.core">JanusGraphVertex</a> getJanusGraphVertex(org.apache.tinkerpop.gremlin.process.traversal.Traverser<? extends org.apache.tinkerpop.gremlin.structure.Element> traverser)</pre> | |
| </li> | |
| </ul> | |
| <a name="isEdgeReturnStep-org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphVertexStep-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isEdgeReturnStep</h4> | |
| <pre>public static boolean isEdgeReturnStep(<a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/step/JanusGraphVertexStep.html" title="class in org.janusgraph.graphdb.tinkerpop.optimize.step">JanusGraphVertexStep</a> vertexStep)</pre> | |
| </li> | |
| </ul> | |
| <a name="isVertexReturnStep-org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphVertexStep-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isVertexReturnStep</h4> | |
| <pre>public static boolean isVertexReturnStep(<a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/step/JanusGraphVertexStep.html" title="class in org.janusgraph.graphdb.tinkerpop.optimize.step">JanusGraphVertexStep</a> vertexStep)</pre> | |
| </li> | |
| </ul> | |
| <a name="getNextNonIdentityStep-org.apache.tinkerpop.gremlin.process.traversal.Step-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getNextNonIdentityStep</h4> | |
| <pre>public static org.apache.tinkerpop.gremlin.process.traversal.Step getNextNonIdentityStep(org.apache.tinkerpop.gremlin.process.traversal.Step start)</pre> | |
| </li> | |
| </ul> | |
| <a name="getTx-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getTx</h4> | |
| <pre>public static <a href="../../../../../org/janusgraph/core/JanusGraphTransaction.html" title="interface in org.janusgraph.core">JanusGraphTransaction</a> getTx(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<?,?> traversal)</pre> | |
| </li> | |
| </ul> | |
| <a name="findMostOuterEligibleStart-org.apache.tinkerpop.gremlin.process.traversal.Step-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>findMostOuterEligibleStart</h4> | |
| <pre>public static org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> findMostOuterEligibleStart(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</pre> | |
| <div class="block">In case `step` can be considered as eligible start step then | |
| this method returns the most outer eligible parent step. | |
| The most outer eligible parent for the provided `step` is | |
| the one which is directly or indirectly includes the provided `step` | |
| and satisfies the following criteria: | |
| <br> | |
| - It includes the maximum number of nested eligible parents for the provided `step`. | |
| - All the nested parents, including the provided `step` must be considered as `start` steps | |
| of their respective traversals. | |
| - Each such nested parent of the provided `step` must be parentToChildProxyStep (determined by | |
| `isParentToChildProxyStep(nextStep)` method). | |
| <br> | |
| In case `step` don't have any eligible parents then the provided `step` will be returned.</div> | |
| </li> | |
| </ul> | |
| <a name="isMultiQueryCompatibleParent-org.apache.tinkerpop.gremlin.process.traversal.Step-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isMultiQueryCompatibleParent</h4> | |
| <pre>public static boolean isMultiQueryCompatibleParent(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</pre> | |
| </li> | |
| </ul> | |
| <a name="getAllMultiQueryPositionsForMultiQueriable-org.janusgraph.graphdb.tinkerpop.optimize.step.MultiQueriable-boolean-boolean-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getAllMultiQueryPositionsForMultiQueriable</h4> | |
| <pre>public static <a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/MultiQueryPositions.html" title="class in org.janusgraph.graphdb.tinkerpop.optimize">MultiQueryPositions</a> getAllMultiQueryPositionsForMultiQueriable(<a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/step/MultiQueriable.html" title="interface in org.janusgraph.graphdb.tinkerpop.optimize.step">MultiQueriable</a><?,?> multiQueriable, | |
| boolean multiNestedRepeatEligible, | |
| boolean multiNestedRepeatNextIterationEligible)</pre> | |
| <div class="block">Backtraces the traversal for the position where a MultiQueriable step would expect its corresponding | |
| JanusGraphMultiQueryStep(s). In case of MultiQueriables nested in RepeatSteps, multiple destinations | |
| are returned.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>multiQueriable</code> - The MultiQuery compatible step whose MultiQueryStep positions shall be searched.</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>The step before which the MultiQueryStep is located or expected.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getEndMultiQueryPosition-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getEndMultiQueryPosition</h4> | |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><org.apache.tinkerpop.gremlin.process.traversal.Step> getEndMultiQueryPosition(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin repeatTraversal)</pre> | |
| <div class="block">Returns multi query position for the end of the traversal. | |
| This can be useful in case by the end of the traversal, vertices should be registered for prefetching | |
| in some other places.</div> | |
| </li> | |
| </ul> | |
| <a name="getLocalMultiQueryPositionForStep-org.apache.tinkerpop.gremlin.process.traversal.Step-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getLocalMultiQueryPositionForStep</h4> | |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><org.apache.tinkerpop.gremlin.process.traversal.Step> getLocalMultiQueryPositionForStep(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</pre> | |
| <div class="block">For a MultiQuery compatible step, this method searches the correct position in the step's traversal at which | |
| a <code>JanusGraphMultiQueryStep</code> should be inserted. Only the traversal of the given step is considered, | |
| parent and child traversals are not taken into account.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>step</code> - The MultiQuery compatible step.</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>The step before which a <code>JanusGraphMultiQueryStep</code> should be inserted.</dd> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/step/JanusGraphMultiQueryStep.html" title="class in org.janusgraph.graphdb.tinkerpop.optimize.step"><code>JanusGraphMultiQueryStep</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getLocalNonMultiQueryProvidedBatchSize-org.janusgraph.graphdb.tinkerpop.optimize.step.MultiQueriable-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getLocalNonMultiQueryProvidedBatchSize</h4> | |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> getLocalNonMultiQueryProvidedBatchSize(<a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/step/MultiQueriable.html" title="interface in org.janusgraph.graphdb.tinkerpop.optimize.step">MultiQueriable</a><?,?> multiQueriable)</pre> | |
| <div class="block">Returns local barrier step size if that barrier step is not generated by JanusGraphMultiQueryStep.</div> | |
| </li> | |
| </ul> | |
| <a name="isStartStep-org.apache.tinkerpop.gremlin.process.traversal.Step-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isStartStep</h4> | |
| <pre>public static boolean isStartStep(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</pre> | |
| <div class="block">Checks if the provided step is the start step of its Traversal skipping any `IdentityStep`, `NoOpBarrierStep`, | |
| `SideEffectStep`, `ProfileStep`, and `JanusGraphMultiQueryStep` steps at the beginning.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>step</code> - Step to check.</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>`true` if the step can be considered as the start of its traversal. `false` otherwise.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="isLegalMultiQueryPosition-org.apache.tinkerpop.gremlin.process.traversal.Step-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isLegalMultiQueryPosition</h4> | |
| <pre>public static boolean isLegalMultiQueryPosition(org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> step)</pre> | |
| <div class="block">This method closely matches the behavior implemented in <code>LazyBarrierStrategy</code> which ensures that | |
| no <code>NoOpBarrierStep</code>s are inserted if path labels are required. Since the same limitation applies | |
| to <code>JanusGraphMultiQueryStep</code>s, the definition of legal positions for this step is the same.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>step</code> - The step which follows the JanusGraphMultiQueryStep to be inserted.</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd><code>true</code> if no path labels are required for this position, otherwise <code>false</code>.</dd> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><code>LazyBarrierStrategy</code></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getPreviousStepOfClass-java.lang.Class-org.apache.tinkerpop.gremlin.process.traversal.Step-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getPreviousStepOfClass</h4> | |
| <pre>public static <S> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><S> getPreviousStepOfClass(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><S> stepClass, | |
| org.apache.tinkerpop.gremlin.process.traversal.Step<?,?> start)</pre> | |
| <div class="block">Starting at the given step, this method searches the traversal backwards to find the most recent step which | |
| matches the given class. Only the traversal of the given step is scanned and parent or child traversals are | |
| not taken into account.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Type Parameters:</span></dt> | |
| <dd><code>S</code> - The class of the requested step.</dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>stepClass</code> - The class of the requested step.</dd> | |
| <dd><code>start</code> - The step from which the search is started.</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>An Optional which contains the requested step if it was found.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getSteps-java.util.function.Predicate-org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>getSteps</h4> | |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.tinkerpop.gremlin.process.traversal.Step> getSteps(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a><org.apache.tinkerpop.gremlin.process.traversal.Step> predicate, | |
| org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<?,?> traversal)</pre> | |
| <div class="block">Returns a list of steps from the traversal, which match a given predicate.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>predicate</code> - Whether or not a step should be in the returned list.</dd> | |
| <dd><code>traversal</code> - The traversal whose steps should be used.</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>The list of matching steps.</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/JanusGraphTraversalUtil.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>Prev Class</li> | |
| <li><a href="../../../../../org/janusgraph/graphdb/tinkerpop/optimize/MultiQueryPositions.html" title="class in org.janusgraph.graphdb.tinkerpop.optimize"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/janusgraph/graphdb/tinkerpop/optimize/JanusGraphTraversalUtil.html" target="_top">Frames</a></li> | |
| <li><a href="JanusGraphTraversalUtil.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><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> | |