blob: fd93065ca3b58c2ae73ee5032eb487617389ce9c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>LabelToNode (Apache Jena ARQ)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: module: org.apache.jena.arq, package: org.apache.jena.riot.lang, class: LabelToNode">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/LabelToNode.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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../module-summary.html">org.apache.jena.arq</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jena.riot.lang</a></div>
<h1 title="Class LabelToNode" class="title">Class LabelToNode</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="../system/MapWithScope.html" title="class in org.apache.jena.riot.system">org.apache.jena.riot.system.MapWithScope</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>org.apache.jena.graph.Node,<wbr>org.apache.jena.graph.Node&gt;
<div class="inheritance">org.apache.jena.riot.lang.LabelToNode</div>
</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LabelToNode</span>
<span class="extends-implements">extends <a href="../system/MapWithScope.html" title="class in org.apache.jena.riot.system">MapWithScope</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>org.apache.jena.graph.Node,<wbr>org.apache.jena.graph.Node&gt;</span></div>
<div class="block">Allocation of Nodes (blank nodes usually) based on the graph and scope.
There are various different policies.
See <a href="../system/SyntaxLabels.html#createLabelToNode()"><code>SyntaxLabels.createLabelToNode()</code></a> for getting a default setup;
some of the others are for testing and debugging and may not generate
legal RDF overall (e.g. reparsing the same file gets the same bNodes)</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.jena.riot.system.MapWithScope">Nested classes/interfaces inherited from class&nbsp;org.apache.jena.riot.system.<a href="../system/MapWithScope.html" title="class in org.apache.jena.riot.system">MapWithScope</a></h2>
<code><a href="../system/MapWithScope.Allocator.html" title="interface in org.apache.jena.riot.system">MapWithScope.Allocator</a>&lt;<a href="../system/MapWithScope.Allocator.html" title="type parameter in MapWithScope.Allocator">A</a>,<wbr><a href="../system/MapWithScope.Allocator.html" title="type parameter in MapWithScope.Allocator">B</a>,<wbr><a href="../system/MapWithScope.Allocator.html" title="type parameter in MapWithScope.Allocator">S</a>&gt;, <a href="../system/MapWithScope.ScopePolicy.html" title="interface in org.apache.jena.riot.system">MapWithScope.ScopePolicy</a>&lt;<a href="../system/MapWithScope.ScopePolicy.html" title="type parameter in MapWithScope.ScopePolicy">A</a>,<wbr><a href="../system/MapWithScope.ScopePolicy.html" title="type parameter in MapWithScope.ScopePolicy">B</a>,<wbr><a href="../system/MapWithScope.ScopePolicy.html" title="type parameter in MapWithScope.ScopePolicy">S</a>&gt;</code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.jena.riot.system.MapWithScope.ScopePolicy,org.apache.jena.riot.system.MapWithScope.Allocator)" class="member-name-link">LabelToNode</a><wbr>(<a href="../system/MapWithScope.ScopePolicy.html" title="interface in org.apache.jena.riot.system">MapWithScope.ScopePolicy</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>org.apache.jena.graph.Node,<wbr>org.apache.jena.graph.Node&gt;&nbsp;scopePolicy,
<a href="../system/MapWithScope.Allocator.html" title="interface in org.apache.jena.riot.system">MapWithScope.Allocator</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>org.apache.jena.graph.Node,<wbr>org.apache.jena.graph.Node&gt;&nbsp;allocator)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createIncremental()" class="member-name-link">createIncremental</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Allocation, globally scoped, that uses a incrementing field to create new nodes</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createScopeByDocumentHash()" class="member-name-link">createScopeByDocumentHash</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Allocation from a single scope; just the label matters.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createScopeByDocumentHash(java.util.UUID)" class="member-name-link">createScopeByDocumentHash</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&nbsp;seed)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Allocation from a single scope; just the label matters.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createScopeByGraph()" class="member-name-link">createScopeByGraph</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Allocation scoped by graph and label.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createScopeGlobal()" class="member-name-link">createScopeGlobal</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Allocation, with a map from seen label to node.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createUseLabelAsGiven()" class="member-name-link">createUseLabelAsGiven</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Allocation using syntax label; output is unsafe for reading (use
<a href="#createUseLabelEncoded()"><code>createUseLabelEncoded()</code></a> for output-input).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createUseLabelEncoded()" class="member-name-link">createUseLabelEncoded</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Allocation using an encoded syntax label
(i.e.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.riot.system.MapWithScope">Methods inherited from class&nbsp;org.apache.jena.riot.system.<a href="../system/MapWithScope.html" title="class in org.apache.jena.riot.system">MapWithScope</a></h3>
<code><a href="../system/MapWithScope.html#clear()">clear</a>, <a href="../system/MapWithScope.html#create()">create</a>, <a href="../system/MapWithScope.html#get(S,A)">get</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.jena.riot.system.MapWithScope.ScopePolicy,org.apache.jena.riot.system.MapWithScope.Allocator)">
<h3>LabelToNode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LabelToNode</span><wbr><span class="parameters">(<a href="../system/MapWithScope.ScopePolicy.html" title="interface in org.apache.jena.riot.system">MapWithScope.ScopePolicy</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>org.apache.jena.graph.Node,<wbr>org.apache.jena.graph.Node&gt;&nbsp;scopePolicy,
<a href="../system/MapWithScope.Allocator.html" title="interface in org.apache.jena.riot.system">MapWithScope.Allocator</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>org.apache.jena.graph.Node,<wbr>org.apache.jena.graph.Node&gt;&nbsp;allocator)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="createScopeByDocumentHash()">
<h3>createScopeByDocumentHash</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></span>&nbsp;<span class="element-name">createScopeByDocumentHash</span>()</div>
<div class="block">Allocation from a single scope; just the label matters.
This is the RDF syntax correct policy.
See <a href="#createScopeGlobal()"><code>createScopeGlobal()</code></a> for some history.</div>
</section>
</li>
<li>
<section class="detail" id="createScopeByDocumentHash(java.util.UUID)">
<h3>createScopeByDocumentHash</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></span>&nbsp;<span class="element-name">createScopeByDocumentHash</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&nbsp;seed)</span></div>
<div class="block">Allocation from a single scope; just the label matters. Use this policy if repeated runs must give identical allocations</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>seed</code> - Seed</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createScopeGlobal()">
<h3>createScopeGlobal</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></span>&nbsp;<span class="element-name">createScopeGlobal</span>()</div>
<div class="block">Allocation, with a map from seen label to node. It uses the jena-core blank
node allocator and a map from label to blank node. This style works for any
blank node allocation style but the map can grow to arbitrary size.
<p>
This was the policy up to Jena 2.10.0 but it occasionally ran into problems at
very large scale because it generates and remembers a new UUIDs for new each
blank node. The policy changed to <a href="#createScopeByDocumentHash()"><code>createScopeByDocumentHash()</code></a> which
calculates the blank node label needed without needing to retain previous
allocations.</div>
</section>
</li>
<li>
<section class="detail" id="createScopeByGraph()">
<h3>createScopeByGraph</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></span>&nbsp;<span class="element-name">createScopeByGraph</span>()</div>
<div class="block">Allocation scoped by graph and label.</div>
</section>
</li>
<li>
<section class="detail" id="createUseLabelAsGiven()">
<h3>createUseLabelAsGiven</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></span>&nbsp;<span class="element-name">createUseLabelAsGiven</span>()</div>
<div class="block">Allocation using syntax label; output is unsafe for reading (use
<a href="#createUseLabelEncoded()"><code>createUseLabelEncoded()</code></a> for output-input).
The reverse operation is provided by <a href="../out/NodeToLabel.html#createBNodeByLabelAsGiven()"><code>NodeToLabel.createBNodeByLabelAsGiven()</code></a>
but the pair is <em>unsafe</em> for output-input. Use encoded labels for that.
The main purpose of this LabelToNode is to preserve the used label for debugging.</div>
</section>
</li>
<li>
<section class="detail" id="createUseLabelEncoded()">
<h3>createUseLabelEncoded</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></span>&nbsp;<span class="element-name">createUseLabelEncoded</span>()</div>
<div class="block">Allocation using an encoded syntax label
(i.e. _:B&lt;encoded&gt; format from <a href="../out/NodeFmtLib.html#encodeBNodeLabel(java.lang.String)"><code>NodeFmtLib.encodeBNodeLabel(java.lang.String)</code></a>).
The reverse operation is provided by <a href="../out/NodeToLabel.html#createBNodeByLabelEncoded()"><code>NodeToLabel.createBNodeByLabelEncoded()</code></a>.
This pair should be used to write out and recover blank node by internal id.</div>
</section>
</li>
<li>
<section class="detail" id="createIncremental()">
<h3>createIncremental</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LabelToNode.html" title="class in org.apache.jena.riot.lang">LabelToNode</a></span>&nbsp;<span class="element-name">createIncremental</span>()</div>
<div class="block">Allocation, globally scoped, that uses a incrementing field to create new nodes</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Licensed under the Apache License, Version 2.0</small></p>
</footer>
</div>
</div>
</body>
</html>