blob: 147736dc5831bf635b8f3fac04ea234d222d5ec1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RDFChanges (Apache Jena - RDF Patch 5.0.0)</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.rdfpatch, package: org.apache.jena.rdfpatch, interface: RDFChanges">
<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/RDFChanges.html">Use</a></li>
<li><a href="package-tree.html">Tree</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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.rdfpatch</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jena.rdfpatch</a></div>
<h1 title="Interface RDFChanges" class="title">Interface RDFChanges</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="changes/RDFChangesApply.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesApply</a></code>, <code><a href="changes/RDFChangesApplyGraph.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesApplyGraph</a></code>, <code><a href="changes/RDFChangesBase.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesBase</a></code>, <code><a href="changes/RDFChangesCollector.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesCollector</a></code>, <code><a href="changes/RDFChangesCounter.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesCounter</a></code>, <code><a href="changes/RDFChangesExternalTxn.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesExternalTxn</a></code>, <code><a href="changes/RDFChangesLog.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesLog</a></code>, <code><a href="changes/RDFChangesLogSummary.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesLogSummary</a></code>, <code><a href="filelog/RDFChangesManagedOutput.html" title="class in org.apache.jena.rdfpatch.filelog">RDFChangesManagedOutput</a></code>, <code><a href="changes/RDFChangesN.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesN</a></code>, <code><a href="changes/RDFChangesNoOp.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesNoOp</a></code>, <code><a href="changes/RDFChangesOnStartFinish.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesOnStartFinish</a></code>, <code><a href="system/RDFChangesSuppressEmpty.html" title="class in org.apache.jena.rdfpatch.system">RDFChangesSuppressEmpty</a></code>, <code><a href="changes/RDFChangesWrapper.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesWrapper</a></code>, <code><a href="binary/RDFChangesWriterBinary.html" title="class in org.apache.jena.rdfpatch.binary">RDFChangesWriterBinary</a></code>, <code><a href="text/RDFChangesWriterText.html" title="class in org.apache.jena.rdfpatch.text">RDFChangesWriterText</a></code>, <code><a href="changes/RDFChangesWriteUpdate.html" title="class in org.apache.jena.rdfpatch.changes">RDFChangesWriteUpdate</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RDFChanges</span></div>
<div class="block">Interface for a stream of changes to to an RDF Dataset, or RDF Graph.
For an RDF graph, the "graph name" will be null.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#add(org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node)" class="member-name-link">add</a><wbr>(org.apache.jena.graph.Node&nbsp;g,
org.apache.jena.graph.Node&nbsp;s,
org.apache.jena.graph.Node&nbsp;p,
org.apache.jena.graph.Node&nbsp;o)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Notification that a quad or triple is added.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addPrefix(org.apache.jena.graph.Node,java.lang.String,java.lang.String)" class="member-name-link">addPrefix</a><wbr>(org.apache.jena.graph.Node&nbsp;gn,
<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>&nbsp;prefix,
<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>&nbsp;uriStr)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Add a prefix.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#delete(org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node)" class="member-name-link">delete</a><wbr>(org.apache.jena.graph.Node&nbsp;g,
org.apache.jena.graph.Node&nbsp;s,
org.apache.jena.graph.Node&nbsp;p,
org.apache.jena.graph.Node&nbsp;o)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Notification that a quad or triple is deleted.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#deletePrefix(org.apache.jena.graph.Node,java.lang.String)" class="member-name-link">deletePrefix</a><wbr>(org.apache.jena.graph.Node&nbsp;gn,
<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>&nbsp;prefix)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Delete a prefix.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#finish()" class="member-name-link">finish</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Finish processing.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#header(java.lang.String,org.apache.jena.graph.Node)" class="member-name-link">header</a><wbr>(<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>&nbsp;field,
org.apache.jena.graph.Node&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Header field.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#segment()" class="member-name-link">segment</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Segment marker.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#start()" class="member-name-link">start</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Start processing.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#txnAbort()" class="member-name-link">txnAbort</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Indicator that a transaction aborts</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#txnBegin()" class="member-name-link">txnBegin</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Indicator that a transaction begins, or becomes a write transaction.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#txnCommit()" class="member-name-link">txnCommit</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Indicator that a transaction commits.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="header(java.lang.String,org.apache.jena.graph.Node)">
<h3>header</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">header</span><wbr><span class="parameters">(<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>&nbsp;field,
org.apache.jena.graph.Node&nbsp;value)</span></div>
<div class="block">Header field.
Headers are metadata about the changes being made.</div>
</section>
</li>
<li>
<section class="detail" id="add(org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node)">
<h3>add</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">add</span><wbr><span class="parameters">(org.apache.jena.graph.Node&nbsp;g,
org.apache.jena.graph.Node&nbsp;s,
org.apache.jena.graph.Node&nbsp;p,
org.apache.jena.graph.Node&nbsp;o)</span></div>
<div class="block">Notification that a quad or triple is added.
A stream of Triples outside a dataset will have null for the graph name.
Inside an RDF Dataset, it may be more natural to use "urn:x-arq:DefaultGraph" or "urn:x-arq:DefaultGraphNode"
in which case test with <code>Quad.isDefaultGraph(Node)</code>.
<p>
It is not defined whether the add happens before or after this notification all.</div>
</section>
</li>
<li>
<section class="detail" id="delete(org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node)">
<h3>delete</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">delete</span><wbr><span class="parameters">(org.apache.jena.graph.Node&nbsp;g,
org.apache.jena.graph.Node&nbsp;s,
org.apache.jena.graph.Node&nbsp;p,
org.apache.jena.graph.Node&nbsp;o)</span></div>
<div class="block">Notification that a quad or triple is deleted.
A stream of Triples outside a dataset will have null for the graph name.
Inside an RDF Dataset, it may be more natural to use "urn:x-arq:DefaultGraph" or "urn:x-arq:DefaultGraphNode"
in which case test with <code>Quad.isDefaultGraph(Node)</code>.
<p>
It is not defined whether the delete happens before or after this notification all.</div>
</section>
</li>
<li>
<section class="detail" id="addPrefix(org.apache.jena.graph.Node,java.lang.String,java.lang.String)">
<h3>addPrefix</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">addPrefix</span><wbr><span class="parameters">(org.apache.jena.graph.Node&nbsp;gn,
<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>&nbsp;prefix,
<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>&nbsp;uriStr)</span></div>
<div class="block">Add a prefix. The graph name follows the same rules as <a href="#add(org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node)"><code>add(org.apache.jena.graph.Node, org.apache.jena.graph.Node, org.apache.jena.graph.Node, org.apache.jena.graph.Node)</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="deletePrefix(org.apache.jena.graph.Node,java.lang.String)">
<h3>deletePrefix</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">deletePrefix</span><wbr><span class="parameters">(org.apache.jena.graph.Node&nbsp;gn,
<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>&nbsp;prefix)</span></div>
<div class="block">Delete a prefix. The graph name follows the same rules as <a href="#add(org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node,org.apache.jena.graph.Node)"><code>add(org.apache.jena.graph.Node, org.apache.jena.graph.Node, org.apache.jena.graph.Node, org.apache.jena.graph.Node)</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="txnBegin()">
<h3>txnBegin</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">txnBegin</span>()</div>
<div class="block">Indicator that a transaction begins, or becomes a write transaction.</div>
</section>
</li>
<li>
<section class="detail" id="txnCommit()">
<h3>txnCommit</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">txnCommit</span>()</div>
<div class="block">Indicator that a transaction commits.
If this throws an exception, the transaction will be aborted locally and not commit after all.</div>
</section>
</li>
<li>
<section class="detail" id="txnAbort()">
<h3>txnAbort</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">txnAbort</span>()</div>
<div class="block">Indicator that a transaction aborts</div>
</section>
</li>
<li>
<section class="detail" id="segment()">
<h3>segment</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">segment</span>()</div>
<div class="block">Segment marker.
<p>
A segment is a number of transactions; the grouping rationale is not defined by RDF Patch.
<p>
It might be used to indicate a logical collection of change transactions in a long stream of transactions.
<p>
There is no guarantee it will be used.
<p>
Segments must contain complete transactions.<br/>
Segments must not span start-finish pairs.</div>
</section>
</li>
<li>
<section class="detail" id="start()">
<h3>start</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">start</span>()</div>
<div class="block">Start processing.
The exact meaning is implementation dependent.
This should be paired with a <a href="#finish()"><code>finish()</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="finish()">
<h3>finish</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">finish</span>()</div>
<div class="block">Finish processing.
The exact meaning is implementation dependent.
This should be paired with a <a href="#start()"><code>start()</code></a>.</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>