|
<!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>IndexRemoveJob (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="IndexRemoveJob (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)"; |
|
} |
|
} |
|
catch(err) { |
|
} |
|
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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> |
|
|
|
<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/IndexRemoveJob.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/olap/job/GhostVertexRemover.html" title="class in org.janusgraph.graphdb.olap.job"><span class="typeNameLink">Prev Class</span></a></li> |
|
<li><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRepairJob.html" title="class in org.janusgraph.graphdb.olap.job"><span class="typeNameLink">Next Class</span></a></li> |
|
</ul> |
|
<ul class="navList"> |
|
<li><a href="../../../../../index.html?org/janusgraph/graphdb/olap/job/IndexRemoveJob.html" target="_top">Frames</a></li> |
|
<li><a href="IndexRemoveJob.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |
|
|
|
|
|
<div class="header"> |
|
<div class="subTitle">org.janusgraph.graphdb.olap.job</div> |
|
<h2 title="Class IndexRemoveJob" class="title">Class IndexRemoveJob</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><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html" title="class in org.janusgraph.graphdb.olap.job">org.janusgraph.graphdb.olap.job.IndexUpdateJob</a></li> |
|
<li> |
|
<ul class="inheritance"> |
|
<li>org.janusgraph.graphdb.olap.job.IndexRemoveJob</li> |
|
</ul> |
|
</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/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanJob</a></dd> |
|
</dl> |
|
<hr> |
|
<br> |
|
<pre>public class <span class="typeNameLabel">IndexRemoveJob</span> |
|
extends <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html" title="class in org.janusgraph.graphdb.olap.job">IndexUpdateJob</a> |
|
implements <a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanJob</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"> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="field.summary"> |
|
|
|
</a> |
|
<h3>Field Summary</h3> |
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption> |
|
<tr> |
|
<th class="colFirst" scope="col">Modifier and Type</th> |
|
<th class="colLast" scope="col">Field and Description</th> |
|
</tr> |
|
<tr class="altColor"> |
|
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#DELETED_RECORDS_COUNT">DELETED_RECORDS_COUNT</a></span></code> </td> |
|
</tr> |
|
</table> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="fields.inherited.from.class.org.janusgraph.graphdb.olap.job.IndexUpdateJob"> |
|
|
|
</a> |
|
<h3>Fields inherited from class org.janusgraph.graphdb.olap.job.<a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html" title="class in org.janusgraph.graphdb.olap.job">IndexUpdateJob</a></h3> |
|
<code><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#FAILED_TX">FAILED_TX</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#index">index</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#INDEX_JOB_NS">INDEX_JOB_NS</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#INDEX_NAME">INDEX_NAME</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#INDEX_RELATION_TYPE">INDEX_RELATION_TYPE</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#indexName">indexName</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#indexRelationType">indexRelationType</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#indexRelationTypeName">indexRelationTypeName</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#jobStartTime">jobStartTime</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#log">log</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#managementSystem">managementSystem</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#SUCCESS_TX">SUCCESS_TX</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#writeTx">writeTx</a></code></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
|
|
<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="colFirst" scope="col">Modifier</th> |
|
<th class="colLast" scope="col">Constructor and Description</th> |
|
</tr> |
|
<tr class="altColor"> |
|
<td class="colFirst"><code> </code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#IndexRemoveJob--">IndexRemoveJob</a></span>()</code> </td> |
|
</tr> |
|
<tr class="rowColor"> |
|
<td class="colFirst"><code>protected </code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#IndexRemoveJob-org.janusgraph.graphdb.olap.job.IndexRemoveJob-">IndexRemoveJob</a></span>(<a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html" title="class in org.janusgraph.graphdb.olap.job">IndexRemoveJob</a> copy)</code> </td> |
|
</tr> |
|
<tr class="altColor"> |
|
<td class="colFirst"><code> </code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#IndexRemoveJob-org.janusgraph.core.JanusGraph-java.lang.String-java.lang.String-">IndexRemoveJob</a></span>(<a href="../../../../../org/janusgraph/core/JanusGraph.html" title="interface in org.janusgraph.core">JanusGraph</a> graph, |
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> indexName, |
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> indexType)</code> </td> |
|
</tr> |
|
</table> |
|
</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="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><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html" title="class in org.janusgraph.graphdb.olap.job">IndexRemoveJob</a></code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#clone--">clone</a></span>()</code> |
|
<div class="block">Returns a clone of this ScanJob.</div> |
|
</td> |
|
</tr> |
|
<tr id="i1" class="rowColor"> |
|
<td class="colFirst"><code><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><<a href="../../../../../org/janusgraph/diskstorage/StaticBuffer.html" title="interface in org.janusgraph.diskstorage">StaticBuffer</a>></code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#getKeyFilter--">getKeyFilter</a></span>()</code> |
|
<div class="block">A predicate that determines whether |
|
<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#process-org.janusgraph.diskstorage.StaticBuffer-java.util.Map-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-"><code>ScanJob.process(org.janusgraph.diskstorage.StaticBuffer, java.util.Map, ScanMetrics)</code></a> |
|
should be invoked for the given key.</div> |
|
</td> |
|
</tr> |
|
<tr id="i2" class="altColor"> |
|
<td class="colFirst"><code><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><<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/SliceQuery.html" title="class in org.janusgraph.diskstorage.keycolumnvalue">SliceQuery</a>></code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#getQueries--">getQueries</a></span>()</code> |
|
<div class="block">Returns one or more <code>SliceQuery</code> instances belonging to this <code>ScanJob</code>.</div> |
|
</td> |
|
</tr> |
|
<tr id="i3" class="rowColor"> |
|
<td class="colFirst"><code>void</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#process-org.janusgraph.diskstorage.StaticBuffer-java.util.Map-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">process</a></span>(<a href="../../../../../org/janusgraph/diskstorage/StaticBuffer.html" title="interface in org.janusgraph.diskstorage">StaticBuffer</a> key, |
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/SliceQuery.html" title="class in org.janusgraph.diskstorage.keycolumnvalue">SliceQuery</a>,<a href="../../../../../org/janusgraph/diskstorage/EntryList.html" title="interface in org.janusgraph.diskstorage">EntryList</a>> entries, |
|
<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanMetrics.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanMetrics</a> metrics)</code> |
|
<div class="block">Run this <code>ScanJob</code>'s computation on the supplied row-key and entries.</div> |
|
</td> |
|
</tr> |
|
<tr id="i4" class="altColor"> |
|
<td class="colFirst"><code>protected void</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#validateIndexStatus--">validateIndexStatus</a></span>()</code> </td> |
|
</tr> |
|
<tr id="i5" class="rowColor"> |
|
<td class="colFirst"><code>void</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#workerIterationEnd-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">workerIterationEnd</a></span>(<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanMetrics.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanMetrics</a> metrics)</code> |
|
<div class="block">Invoked after a block of computation (i.e.</div> |
|
</td> |
|
</tr> |
|
<tr id="i6" class="altColor"> |
|
<td class="colFirst"><code>void</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html#workerIterationStart-org.janusgraph.diskstorage.configuration.Configuration-org.janusgraph.diskstorage.configuration.Configuration-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">workerIterationStart</a></span>(<a href="../../../../../org/janusgraph/diskstorage/configuration/Configuration.html" title="interface in org.janusgraph.diskstorage.configuration">Configuration</a> config, |
|
<a href="../../../../../org/janusgraph/diskstorage/configuration/Configuration.html" title="interface in org.janusgraph.diskstorage.configuration">Configuration</a> graphConf, |
|
<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanMetrics.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanMetrics</a> metrics)</code> |
|
<div class="block">Invoked before a block of computation (i.e.</div> |
|
</td> |
|
</tr> |
|
</table> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="methods.inherited.from.class.org.janusgraph.graphdb.olap.job.IndexUpdateJob"> |
|
|
|
</a> |
|
<h3>Methods inherited from class org.janusgraph.graphdb.olap.job.<a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html" title="class in org.janusgraph.graphdb.olap.job">IndexUpdateJob</a></h3> |
|
<code><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#isGlobalGraphIndex--">isGlobalGraphIndex</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#isRelationTypeIndex--">isRelationTypeIndex</a>, <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#workerIterationStart-org.janusgraph.core.JanusGraph-org.janusgraph.diskstorage.configuration.Configuration-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">workerIterationStart</a></code></li> |
|
</ul> |
|
<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#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"> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="field.detail"> |
|
|
|
</a> |
|
<h3>Field Detail</h3> |
|
<a name="DELETED_RECORDS_COUNT"> |
|
|
|
</a> |
|
<ul class="blockListLast"> |
|
<li class="blockList"> |
|
<h4>DELETED_RECORDS_COUNT</h4> |
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DELETED_RECORDS_COUNT</pre> |
|
<dl> |
|
<dt><span class="seeLabel">See Also:</span></dt> |
|
<dd><a href="../../../../../constant-values.html#org.janusgraph.graphdb.olap.job.IndexRemoveJob.DELETED_RECORDS_COUNT">Constant Field Values</a></dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="constructor.detail"> |
|
|
|
</a> |
|
<h3>Constructor Detail</h3> |
|
<a name="IndexRemoveJob--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>IndexRemoveJob</h4> |
|
<pre>public IndexRemoveJob()</pre> |
|
</li> |
|
</ul> |
|
<a name="IndexRemoveJob-org.janusgraph.graphdb.olap.job.IndexRemoveJob-"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>IndexRemoveJob</h4> |
|
<pre>protected IndexRemoveJob(<a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html" title="class in org.janusgraph.graphdb.olap.job">IndexRemoveJob</a> copy)</pre> |
|
</li> |
|
</ul> |
|
<a name="IndexRemoveJob-org.janusgraph.core.JanusGraph-java.lang.String-java.lang.String-"> |
|
|
|
</a> |
|
<ul class="blockListLast"> |
|
<li class="blockList"> |
|
<h4>IndexRemoveJob</h4> |
|
<pre>public IndexRemoveJob(<a href="../../../../../org/janusgraph/core/JanusGraph.html" title="interface in org.janusgraph.core">JanusGraph</a> graph, |
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> indexName, |
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> indexType)</pre> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="method.detail"> |
|
|
|
</a> |
|
<h3>Method Detail</h3> |
|
<a name="workerIterationEnd-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>workerIterationEnd</h4> |
|
<pre>public void workerIterationEnd(<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanMetrics.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanMetrics</a> metrics)</pre> |
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#workerIterationEnd-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">ScanJob</a></code></span></div> |
|
<div class="block">Invoked after a block of computation (i.e. multiple process() calls) is handed to this particular ScanJob. |
|
Can be used to close any resources held by this job. This method is called exactly once for each after a block of computation. |
|
This method is semantically aligned with <code>VertexProgram.workerIterationEnd(Memory)</code> |
|
|
|
This method may not be called if there is no data to be processed. Correspondingly, the start method won't be called either. |
|
|
|
No-op default implementation.</div> |
|
<dl> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#workerIterationEnd-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">workerIterationEnd</a></code> in interface <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanJob</a></code></dd> |
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
|
<dd><code><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#workerIterationEnd-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">workerIterationEnd</a></code> in class <code><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html" title="class in org.janusgraph.graphdb.olap.job">IndexUpdateJob</a></code></dd> |
|
<dt><span class="paramLabel">Parameters:</span></dt> |
|
<dd><code>metrics</code> - <a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanMetrics.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan"><code>ScanMetrics</code></a> for this job</dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="workerIterationStart-org.janusgraph.diskstorage.configuration.Configuration-org.janusgraph.diskstorage.configuration.Configuration-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>workerIterationStart</h4> |
|
<pre>public void workerIterationStart(<a href="../../../../../org/janusgraph/diskstorage/configuration/Configuration.html" title="interface in org.janusgraph.diskstorage.configuration">Configuration</a> config, |
|
<a href="../../../../../org/janusgraph/diskstorage/configuration/Configuration.html" title="interface in org.janusgraph.diskstorage.configuration">Configuration</a> graphConf, |
|
<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanMetrics.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanMetrics</a> metrics)</pre> |
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#workerIterationStart-org.janusgraph.diskstorage.configuration.Configuration-org.janusgraph.diskstorage.configuration.Configuration-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">ScanJob</a></code></span></div> |
|
<div class="block">Invoked before a block of computation (i.e. multiple process() calls) is handed to this particular ScanJob. |
|
Can be used to initialize the iteration. This method is called exactly once for each before a block of computation. |
|
This method is semantically aligned with <code>VertexProgram.workerIterationStart(Memory)</code> |
|
|
|
This method may not be called if there is no data to be processed. Correspondingly, the end method won't be called either. |
|
|
|
No-op default implementation.</div> |
|
<dl> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#workerIterationStart-org.janusgraph.diskstorage.configuration.Configuration-org.janusgraph.diskstorage.configuration.Configuration-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">workerIterationStart</a></code> in interface <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanJob</a></code></dd> |
|
<dt><span class="paramLabel">Parameters:</span></dt> |
|
<dd><code>config</code> - configuration for this particular job</dd> |
|
<dd><code>graphConf</code> - configuration options for the entire graph against which this job is executed</dd> |
|
<dd><code>metrics</code> - <a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanMetrics.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan"><code>ScanMetrics</code></a> for this job</dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="validateIndexStatus--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>validateIndexStatus</h4> |
|
<pre>protected void validateIndexStatus()</pre> |
|
<dl> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html#validateIndexStatus--">validateIndexStatus</a></code> in class <code><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexUpdateJob.html" title="class in org.janusgraph.graphdb.olap.job">IndexUpdateJob</a></code></dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="process-org.janusgraph.diskstorage.StaticBuffer-java.util.Map-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>process</h4> |
|
<pre>public void process(<a href="../../../../../org/janusgraph/diskstorage/StaticBuffer.html" title="interface in org.janusgraph.diskstorage">StaticBuffer</a> key, |
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/SliceQuery.html" title="class in org.janusgraph.diskstorage.keycolumnvalue">SliceQuery</a>,<a href="../../../../../org/janusgraph/diskstorage/EntryList.html" title="interface in org.janusgraph.diskstorage">EntryList</a>> entries, |
|
<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanMetrics.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanMetrics</a> metrics)</pre> |
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#process-org.janusgraph.diskstorage.StaticBuffer-java.util.Map-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">ScanJob</a></code></span></div> |
|
<div class="block">Run this <code>ScanJob</code>'s computation on the supplied row-key and entries. |
|
<p> |
|
This method will be called by a client of this interface if and only if both |
|
of the following criteria are satisfied: |
|
<ul> |
|
<li> |
|
The predicate returned by <a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#getKeyFilter--"><code>ScanJob.getKeyFilter()</code></a> must evaluate to true |
|
on the <code>key</code>. |
|
</li> |
|
<li> |
|
The <code>entries</code> parameter must contain an entry whose key is the first |
|
<code>SliceQuery</code> returned by <a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#getQueries--"><code>ScanJob.getQueries()</code></a> and whose value |
|
is an <code>EntryList</code> with at least size one. In other words, the |
|
initial query in this job's query list must have matched at least once. |
|
</li> |
|
</ul> |
|
<p> |
|
Implementations may assume these two conditions are satisfied. Calling this |
|
method when either of these two conditions is false yields undefined behavior. |
|
|
|
<p> |
|
It is the caller's responsibility to construct an <code>entries</code> map that |
|
maps each <code>SliceQuery</code> to that query's matches. |
|
The caller is also responsible for truncating the <code>entries</code> values |
|
to honor <a href="../../../../../org/janusgraph/graphdb/query/BaseQuery.html#getLimit--"><code>BaseQuery.getLimit()</code></a> when <a href="../../../../../org/janusgraph/graphdb/query/BaseQuery.html#hasLimit--"><code>BaseQuery.hasLimit()</code></a> |
|
is true. Passing in an <code>entries</code> value longer than the limit set in |
|
its respective key yields undefined behavior. |
|
<p> |
|
This method may be called by concurrent threads in a single process.</div> |
|
<dl> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#process-org.janusgraph.diskstorage.StaticBuffer-java.util.Map-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-">process</a></code> in interface <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanJob</a></code></dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="getQueries--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>getQueries</h4> |
|
<pre>public <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><<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/SliceQuery.html" title="class in org.janusgraph.diskstorage.keycolumnvalue">SliceQuery</a>> getQueries()</pre> |
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#getQueries--">ScanJob</a></code></span></div> |
|
<div class="block">Returns one or more <code>SliceQuery</code> instances belonging to this <code>ScanJob</code>. |
|
<p> |
|
Before calling |
|
<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#process-org.janusgraph.diskstorage.StaticBuffer-java.util.Map-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-"><code>ScanJob.process(org.janusgraph.diskstorage.StaticBuffer, java.util.Map, ScanMetrics)</code></a>, |
|
users of this interface must check that the key in question contains at least one |
|
entry matching the initial <code>SliceQuery</code> returned by this method. See the javadoc |
|
for the <code>process</code> method for more information. |
|
<p> |
|
If this method returns more than one query, then the initial query's lower bound must |
|
be all zero bits and the initial query's upper bound must be all one bits (per the |
|
preconditions in <code>StandardScannerExecutor</code>, the reference <code>ScanJob</code> executor).</div> |
|
<dl> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#getQueries--">getQueries</a></code> in interface <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanJob</a></code></dd> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
<dd>one or more queries</dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="getKeyFilter--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>getKeyFilter</h4> |
|
<pre>public <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><<a href="../../../../../org/janusgraph/diskstorage/StaticBuffer.html" title="interface in org.janusgraph.diskstorage">StaticBuffer</a>> getKeyFilter()</pre> |
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#getKeyFilter--">ScanJob</a></code></span></div> |
|
<div class="block">A predicate that determines whether |
|
<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#process-org.janusgraph.diskstorage.StaticBuffer-java.util.Map-org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics-"><code>ScanJob.process(org.janusgraph.diskstorage.StaticBuffer, java.util.Map, ScanMetrics)</code></a> |
|
should be invoked for the given key. If the predicate returns true, |
|
then users of this interface should invoke <code>process</code> for the key and |
|
its associated entries. If the predicate returns false, then users of this |
|
interface need not invoke <code>process</code> for the key and its associated entries. |
|
<p> |
|
This is essentially an optimization that lets implementations of this interface |
|
signal to client code that a row can be safely skipped without affecting the |
|
execution of this <code>ScanJob</code>. |
|
<p> |
|
The returned predicate may be called by concurrent threads in a single process.</div> |
|
<dl> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#getKeyFilter--">getKeyFilter</a></code> in interface <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanJob</a></code></dd> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
<dd>a threadsafe predicate for edgestore keys</dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="clone--"> |
|
|
|
</a> |
|
<ul class="blockListLast"> |
|
<li class="blockList"> |
|
<h4>clone</h4> |
|
<pre>public <a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRemoveJob.html" title="class in org.janusgraph.graphdb.olap.job">IndexRemoveJob</a> clone()</pre> |
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#clone--">ScanJob</a></code></span></div> |
|
<div class="block">Returns a clone of this ScanJob. The clone will not yet be initialized for computation but all of |
|
its internal state (if any) must match that of the original copy.</div> |
|
<dl> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html#clone--">clone</a></code> in interface <code><a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan">ScanJob</a></code></dd> |
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
|
<dd><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></code> in class <code><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></code></dd> |
|
<dt><span class="returnLabel">Returns:</span></dt> |
|
<dd>A clone of this <a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/scan/ScanJob.html" title="interface in org.janusgraph.diskstorage.keycolumnvalue.scan"><code>ScanJob</code></a></dd> |
|
</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/IndexRemoveJob.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/olap/job/GhostVertexRemover.html" title="class in org.janusgraph.graphdb.olap.job"><span class="typeNameLink">Prev Class</span></a></li> |
|
<li><a href="../../../../../org/janusgraph/graphdb/olap/job/IndexRepairJob.html" title="class in org.janusgraph.graphdb.olap.job"><span class="typeNameLink">Next Class</span></a></li> |
|
</ul> |
|
<ul class="navList"> |
|
<li><a href="../../../../../index.html?org/janusgraph/graphdb/olap/job/IndexRemoveJob.html" target="_top">Frames</a></li> |
|
<li><a href="IndexRemoveJob.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |
|
|
|
<p class="legalCopy"><small>Copyright © 2012–2023. All rights reserved.</small></p> |
|
</body> |
|
</html> |
|
|