|
<!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>InternalElement (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="InternalElement (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)"; |
|
} |
|
} |
|
catch(err) { |
|
} |
|
|
|
var methods = {"i0":6,"i1":18,"i2":6,"i3":6,"i4":6,"i5":6}; |
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/InternalElement.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/internal/ElementLifeCycle.Event.html" title="enum in org.janusgraph.graphdb.internal"><span class="typeNameLink">Prev Class</span></a></li> |
|
<li><a href="../../../../org/janusgraph/graphdb/internal/InternalRelation.html" title="interface in org.janusgraph.graphdb.internal"><span class="typeNameLink">Next Class</span></a></li> |
|
</ul> |
|
<ul class="navList"> |
|
<li><a href="../../../../index.html?org/janusgraph/graphdb/internal/InternalElement.html" target="_top">Frames</a></li> |
|
<li><a href="InternalElement.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.internal</div> |
|
<h2 title="Interface InternalElement" class="title">Interface InternalElement</h2> |
|
</div> |
|
<div class="contentContainer"> |
|
<div class="description"> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<dl> |
|
<dt>All Superinterfaces:</dt> |
|
<dd>org.apache.tinkerpop.gremlin.structure.Element, <a href="../../../../org/janusgraph/core/Idfiable.html" title="interface in org.janusgraph.core">Idfiable</a>, <a href="../../../../org/janusgraph/core/JanusGraphElement.html" title="interface in org.janusgraph.core">JanusGraphElement</a>, <a href="../../../../org/janusgraph/util/datastructures/Removable.html" title="interface in org.janusgraph.util.datastructures">Removable</a></dd> |
|
</dl> |
|
<dl> |
|
<dt>All Known Subinterfaces:</dt> |
|
<dd><a href="../../../../org/janusgraph/graphdb/internal/InternalRelation.html" title="interface in org.janusgraph.graphdb.internal">InternalRelation</a>, <a href="../../../../org/janusgraph/graphdb/internal/InternalRelationType.html" title="interface in org.janusgraph.graphdb.internal">InternalRelationType</a>, <a href="../../../../org/janusgraph/graphdb/internal/InternalVertex.html" title="interface in org.janusgraph.graphdb.internal">InternalVertex</a>, <a href="../../../../org/janusgraph/graphdb/relations/StandardRelation.html" title="interface in org.janusgraph.graphdb.relations">StandardRelation</a>, <a href="../../../../org/janusgraph/graphdb/types/system/SystemRelationType.html" title="interface in org.janusgraph.graphdb.types.system">SystemRelationType</a></dd> |
|
</dl> |
|
<dl> |
|
<dt>All Known Implementing Classes:</dt> |
|
<dd><a href="../../../../org/janusgraph/graphdb/relations/AbstractEdge.html" title="class in org.janusgraph.graphdb.relations">AbstractEdge</a>, <a href="../../../../org/janusgraph/graphdb/internal/AbstractElement.html" title="class in org.janusgraph.graphdb.internal">AbstractElement</a>, <a href="../../../../org/janusgraph/graphdb/relations/AbstractTypedRelation.html" title="class in org.janusgraph.graphdb.relations">AbstractTypedRelation</a>, <a href="../../../../org/janusgraph/graphdb/vertices/AbstractVertex.html" title="class in org.janusgraph.graphdb.vertices">AbstractVertex</a>, <a href="../../../../org/janusgraph/graphdb/relations/AbstractVertexProperty.html" title="class in org.janusgraph.graphdb.relations">AbstractVertexProperty</a>, <a href="../../../../org/janusgraph/graphdb/types/system/BaseKey.html" title="class in org.janusgraph.graphdb.types.system">BaseKey</a>, <a href="../../../../org/janusgraph/graphdb/types/system/BaseLabel.html" title="class in org.janusgraph.graphdb.types.system">BaseLabel</a>, <a href="../../../../org/janusgraph/graphdb/types/system/BaseRelationType.html" title="class in org.janusgraph.graphdb.types.system">BaseRelationType</a>, <a href="../../../../org/janusgraph/graphdb/types/system/BaseVertexLabel.html" title="class in org.janusgraph.graphdb.types.system">BaseVertexLabel</a>, <a href="../../../../org/janusgraph/graphdb/relations/CacheEdge.html" title="class in org.janusgraph.graphdb.relations">CacheEdge</a>, <a href="../../../../org/janusgraph/graphdb/vertices/CacheVertex.html" title="class in org.janusgraph.graphdb.vertices">CacheVertex</a>, <a href="../../../../org/janusgraph/graphdb/relations/CacheVertexProperty.html" title="class in org.janusgraph.graphdb.relations">CacheVertexProperty</a>, <a href="../../../../org/janusgraph/graphdb/types/vertices/EdgeLabelVertex.html" title="class in org.janusgraph.graphdb.types.vertices">EdgeLabelVertex</a>, <a href="../../../../org/janusgraph/graphdb/types/system/EmptyRelationType.html" title="class in org.janusgraph.graphdb.types.system">EmptyRelationType</a>, <a href="../../../../org/janusgraph/graphdb/types/system/EmptyVertex.html" title="class in org.janusgraph.graphdb.types.system">EmptyVertex</a>, <a href="../../../../org/janusgraph/graphdb/types/system/ImplicitKey.html" title="class in org.janusgraph.graphdb.types.system">ImplicitKey</a>, <a href="../../../../org/janusgraph/graphdb/types/vertices/JanusGraphSchemaVertex.html" title="class in org.janusgraph.graphdb.types.vertices">JanusGraphSchemaVertex</a>, <a href="../../../../org/janusgraph/graphdb/vertices/PreloadedVertex.html" title="class in org.janusgraph.graphdb.vertices">PreloadedVertex</a>, <a href="../../../../org/janusgraph/graphdb/types/vertices/PropertyKeyVertex.html" title="class in org.janusgraph.graphdb.types.vertices">PropertyKeyVertex</a>, <a href="../../../../org/janusgraph/graphdb/types/vertices/RelationTypeVertex.html" title="class in org.janusgraph.graphdb.types.vertices">RelationTypeVertex</a>, <a href="../../../../org/janusgraph/graphdb/relations/StandardEdge.html" title="class in org.janusgraph.graphdb.relations">StandardEdge</a>, <a href="../../../../org/janusgraph/graphdb/vertices/StandardVertex.html" title="class in org.janusgraph.graphdb.vertices">StandardVertex</a>, <a href="../../../../org/janusgraph/graphdb/relations/StandardVertexProperty.html" title="class in org.janusgraph.graphdb.relations">StandardVertexProperty</a>, <a href="../../../../org/janusgraph/graphdb/types/VertexLabelVertex.html" title="class in org.janusgraph.graphdb.types">VertexLabelVertex</a></dd> |
|
</dl> |
|
<hr> |
|
<br> |
|
<pre>public interface <span class="typeNameLabel">InternalElement</span> |
|
extends <a href="../../../../org/janusgraph/core/JanusGraphElement.html" title="interface in org.janusgraph.core">JanusGraphElement</a></pre> |
|
<div class="block">Internal Element interface adding methods that should only be used by JanusGraph</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="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.Element"> |
|
|
|
</a> |
|
<h3>Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Element</h3> |
|
<code>org.apache.tinkerpop.gremlin.structure.Element.Exceptions</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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>byte</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/internal/InternalElement.html#getLifeCycle--">getLifeCycle</a></span>()</code> </td> |
|
</tr> |
|
<tr id="i1" class="rowColor"> |
|
<td class="colFirst"><code>default <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/internal/InternalElement.html#graph--">graph</a></span>()</code> </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/internal/InternalElement.html#isInvisible--">isInvisible</a></span>()</code> |
|
<div class="block">Whether this element is invisible and should only be returned to queries that explicitly ask for invisible elements.</div> |
|
</td> |
|
</tr> |
|
<tr id="i3" class="rowColor"> |
|
<td class="colFirst"><code><a href="../../../../org/janusgraph/graphdb/internal/InternalElement.html" title="interface in org.janusgraph.graphdb.internal">InternalElement</a></code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/internal/InternalElement.html#it--">it</a></span>()</code> |
|
<div class="block">Returns this element in the context of the current transaction.</div> |
|
</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/internal/InternalElement.html#setId-java.lang.Object-">setId</a></span>(<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> id)</code> </td> |
|
</tr> |
|
<tr id="i5" class="rowColor"> |
|
<td class="colFirst"><code><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/internal/InternalElement.html#tx--">tx</a></span>()</code> |
|
<div class="block">Returns the transaction to which the element is currently bound or should be refreshed into</div> |
|
</td> |
|
</tr> |
|
</table> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="methods.inherited.from.class.org.janusgraph.core.JanusGraphElement"> |
|
|
|
</a> |
|
<h3>Methods inherited from interface org.janusgraph.core.<a href="../../../../org/janusgraph/core/JanusGraphElement.html" title="interface in org.janusgraph.core">JanusGraphElement</a></h3> |
|
<code><a href="../../../../org/janusgraph/core/JanusGraphElement.html#hasId--">hasId</a>, <a href="../../../../org/janusgraph/core/JanusGraphElement.html#id--">id</a>, <a href="../../../../org/janusgraph/core/JanusGraphElement.html#isLoaded--">isLoaded</a>, <a href="../../../../org/janusgraph/core/JanusGraphElement.html#isNew--">isNew</a>, <a href="../../../../org/janusgraph/core/JanusGraphElement.html#isRemoved--">isRemoved</a>, <a href="../../../../org/janusgraph/core/JanusGraphElement.html#property-java.lang.String-V-">property</a>, <a href="../../../../org/janusgraph/core/JanusGraphElement.html#remove--">remove</a>, <a href="../../../../org/janusgraph/core/JanusGraphElement.html#valueOrNull-org.janusgraph.core.PropertyKey-">valueOrNull</a></code></li> |
|
</ul> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="methods.inherited.from.class.org.apache.tinkerpop.gremlin.structure.Element"> |
|
|
|
</a> |
|
<h3>Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Element</h3> |
|
<code>keys, label, properties, property, value, values</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="it--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>it</h4> |
|
<pre><a href="../../../../org/janusgraph/graphdb/internal/InternalElement.html" title="interface in org.janusgraph.graphdb.internal">InternalElement</a> it()</pre> |
|
<div class="block">Returns this element in the context of the current transaction.</div> |
|
<dl> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="tx--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>tx</h4> |
|
<pre><a href="../../../../org/janusgraph/graphdb/transaction/StandardJanusGraphTx.html" title="class in org.janusgraph.graphdb.transaction">StandardJanusGraphTx</a> tx()</pre> |
|
<div class="block">Returns the transaction to which the element is currently bound or should be refreshed into</div> |
|
<dl> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="graph--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>graph</h4> |
|
<pre>default <a href="../../../../org/janusgraph/core/JanusGraphTransaction.html" title="interface in org.janusgraph.core">JanusGraphTransaction</a> graph()</pre> |
|
<dl> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code>graph</code> in interface <code>org.apache.tinkerpop.gremlin.structure.Element</code></dd> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code><a href="../../../../org/janusgraph/core/JanusGraphElement.html#graph--">graph</a></code> in interface <code><a href="../../../../org/janusgraph/core/JanusGraphElement.html" title="interface in org.janusgraph.core">JanusGraphElement</a></code></dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="setId-java.lang.Object-"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>setId</h4> |
|
<pre>void setId(<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> id)</pre> |
|
</li> |
|
</ul> |
|
<a name="getLifeCycle--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>getLifeCycle</h4> |
|
<pre>byte getLifeCycle()</pre> |
|
<dl> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
<dd>The lifecycle of this element</dd> |
|
<dt><span class="seeLabel">See Also:</span></dt> |
|
<dd><a href="../../../../org/janusgraph/graphdb/internal/ElementLifeCycle.html" title="class in org.janusgraph.graphdb.internal"><code>ElementLifeCycle</code></a></dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="isInvisible--"> |
|
|
|
</a> |
|
<ul class="blockListLast"> |
|
<li class="blockList"> |
|
<h4>isInvisible</h4> |
|
<pre>boolean isInvisible()</pre> |
|
<div class="block">Whether this element is invisible and should only be returned to queries that explicitly ask for invisible elements.</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/InternalElement.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/internal/ElementLifeCycle.Event.html" title="enum in org.janusgraph.graphdb.internal"><span class="typeNameLink">Prev Class</span></a></li> |
|
<li><a href="../../../../org/janusgraph/graphdb/internal/InternalRelation.html" title="interface in org.janusgraph.graphdb.internal"><span class="typeNameLink">Next Class</span></a></li> |
|
</ul> |
|
<ul class="navList"> |
|
<li><a href="../../../../index.html?org/janusgraph/graphdb/internal/InternalElement.html" target="_top">Frames</a></li> |
|
<li><a href="InternalElement.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> |
|
|