blob: 7df4996c13042004cc59b362544a237df7f215a0 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TransformOrderByDistinctApplication (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.sparql.algebra.optimize, class: TransformOrderByDistinctApplication">
<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/TransformOrderByDistinctApplication.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&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.sparql.algebra.optimize</a></div>
<h1 title="Class TransformOrderByDistinctApplication" class="title">Class TransformOrderByDistinctApplication</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="../TransformCopy.html" title="class in org.apache.jena.sparql.algebra">org.apache.jena.sparql.algebra.TransformCopy</a>
<div class="inheritance">org.apache.jena.sparql.algebra.optimize.TransformOrderByDistinctApplication</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../Transform.html" title="interface in org.apache.jena.sparql.algebra">Transform</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TransformOrderByDistinctApplication</span>
<span class="extends-implements">extends <a href="../TransformCopy.html" title="class in org.apache.jena.sparql.algebra">TransformCopy</a></span></div>
<div class="block"><p>
Improved optimization for <code>ORDER BY</code> plus <code>DISTINCT</code> or
<code>REDUCED</code> combinations, see JENA-441 for original proposal and
discussion.
</p>
<p>
This optimization is enabled by default as with most ARQ optimizations and
may be disabled by setting the symbol
<a href="../../../query/ARQ.html#optOrderByDistinctApplication"><code>ARQ.optOrderByDistinctApplication</code></a> to false.
</p>
<h3>Optimization Applicability</h3>
<p>
This is a limited optimization that applies in the case where you have a
query that meets the following conditions:
</p>
<ul>
<li>Uses both <code>ORDER BY</code> and <code>DISTINCT</code> or <code>REDUCED</code> on the
same level of the query</li>
<li>There is a fixed list of variables to project i.e. not <code>SELECT *</code></li>
<li><code>ORDER BY</code> conditions only use variables present in the project
list</li>
</ul>
<p>
Essentially this takes algebras of the following form:
</p>
<pre>
(distinct
(project (?var)
(order (?var)
... )))
</pre>
<p>
And produces algebra of the following form:
</p>
<pre>
(order (?var)
(distinct
(project (?var)
... )))
</pre>
<p>
In the general case this in unsafe because it would change the semantics of
the query since <code>ORDER BY</code> can access variables that are not projected.
However if the conditions outlined are met then this optimization is safe,
the algebras will be semantically equivalent and the resulting form likely
significantly more performant, of course YMMV depending on how much data you
are querying.
</p></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.jena.sparql.algebra.TransformCopy">Fields inherited from class&nbsp;org.apache.jena.sparql.algebra.<a href="../TransformCopy.html" title="class in org.apache.jena.sparql.algebra">TransformCopy</a></h3>
<code><a href="../TransformCopy.html#COPY_ALWAYS">COPY_ALWAYS</a>, <a href="../TransformCopy.html#COPY_ONLY_ON_CHANGE">COPY_ONLY_ON_CHANGE</a></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()" class="member-name-link">TransformOrderByDistinctApplication</a>()</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-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-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-tab2 method-summary-table-tab4"><code><a href="../Op.html" title="interface in org.apache.jena.sparql.algebra">Op</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transform(org.apache.jena.sparql.algebra.op.OpDistinct,org.apache.jena.sparql.algebra.Op)" class="member-name-link">transform</a><wbr>(<a href="../op/OpDistinct.html" title="class in org.apache.jena.sparql.algebra.op">OpDistinct</a>&nbsp;opDistinct,
<a href="../Op.html" title="interface in org.apache.jena.sparql.algebra">Op</a>&nbsp;subOp)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Op.html" title="interface in org.apache.jena.sparql.algebra">Op</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transform(org.apache.jena.sparql.algebra.op.OpReduced,org.apache.jena.sparql.algebra.Op)" class="member-name-link">transform</a><wbr>(<a href="../op/OpReduced.html" title="class in org.apache.jena.sparql.algebra.op">OpReduced</a>&nbsp;opReduced,
<a href="../Op.html" title="interface in org.apache.jena.sparql.algebra">Op</a>&nbsp;subOp)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.sparql.algebra.TransformCopy">Methods inherited from class&nbsp;org.apache.jena.sparql.algebra.<a href="../TransformCopy.html" title="class in org.apache.jena.sparql.algebra">TransformCopy</a></h3>
<code><a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpAssign,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpBGP)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpConditional,org.apache.jena.sparql.algebra.Op,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpDatasetNames)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpDiff,org.apache.jena.sparql.algebra.Op,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpDisjunction,java.util.List)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpExt)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpExtend,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpFilter,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpGraph,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpGroup,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpJoin,org.apache.jena.sparql.algebra.Op,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpLabel,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpLateral,org.apache.jena.sparql.algebra.Op,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpLeftJoin,org.apache.jena.sparql.algebra.Op,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpList,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpMinus,org.apache.jena.sparql.algebra.Op,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpNull)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpOrder,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpPath)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpProcedure,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpProject,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpPropFunc,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpQuad)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpQuadBlock)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpQuadPattern)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpSequence,java.util.List)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpService,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpSlice,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpTable)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpTopN,org.apache.jena.sparql.algebra.Op)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpTriple)">transform</a>, <a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpUnion,org.apache.jena.sparql.algebra.Op,org.apache.jena.sparql.algebra.Op)">transform</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;()">
<h3>TransformOrderByDistinctApplication</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">TransformOrderByDistinctApplication</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="transform(org.apache.jena.sparql.algebra.op.OpDistinct,org.apache.jena.sparql.algebra.Op)">
<h3>transform</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../Op.html" title="interface in org.apache.jena.sparql.algebra">Op</a></span>&nbsp;<span class="element-name">transform</span><wbr><span class="parameters">(<a href="../op/OpDistinct.html" title="class in org.apache.jena.sparql.algebra.op">OpDistinct</a>&nbsp;opDistinct,
<a href="../Op.html" title="interface in org.apache.jena.sparql.algebra">Op</a>&nbsp;subOp)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transform.html#transform(org.apache.jena.sparql.algebra.op.OpDistinct,org.apache.jena.sparql.algebra.Op)">transform</a></code>&nbsp;in interface&nbsp;<code><a href="../Transform.html" title="interface in org.apache.jena.sparql.algebra">Transform</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpDistinct,org.apache.jena.sparql.algebra.Op)">transform</a></code>&nbsp;in class&nbsp;<code><a href="../TransformCopy.html" title="class in org.apache.jena.sparql.algebra">TransformCopy</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transform(org.apache.jena.sparql.algebra.op.OpReduced,org.apache.jena.sparql.algebra.Op)">
<h3>transform</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../Op.html" title="interface in org.apache.jena.sparql.algebra">Op</a></span>&nbsp;<span class="element-name">transform</span><wbr><span class="parameters">(<a href="../op/OpReduced.html" title="class in org.apache.jena.sparql.algebra.op">OpReduced</a>&nbsp;opReduced,
<a href="../Op.html" title="interface in org.apache.jena.sparql.algebra">Op</a>&nbsp;subOp)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transform.html#transform(org.apache.jena.sparql.algebra.op.OpReduced,org.apache.jena.sparql.algebra.Op)">transform</a></code>&nbsp;in interface&nbsp;<code><a href="../Transform.html" title="interface in org.apache.jena.sparql.algebra">Transform</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../TransformCopy.html#transform(org.apache.jena.sparql.algebra.op.OpReduced,org.apache.jena.sparql.algebra.Op)">transform</a></code>&nbsp;in class&nbsp;<code><a href="../TransformCopy.html" title="class in org.apache.jena.sparql.algebra">TransformCopy</a></code></dd>
</dl>
</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>