blob: 9f04358aae8dd104a5d06261aa5b4839f10b72df [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ExprLib (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.expr, class: ExprLib">
<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/ExprLib.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>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.sparql.expr</a></div>
<h1 title="Class ExprLib" class="title">Class ExprLib</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">org.apache.jena.sparql.expr.ExprLib</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">ExprLib</span>
<span class="extends-implements">extends <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></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== 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">ExprLib</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-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="NodeValue.html" title="class in org.apache.jena.sparql.expr">NodeValue</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#evalOrNull(org.apache.jena.sparql.expr.Expr,org.apache.jena.sparql.engine.binding.Binding,org.apache.jena.sparql.function.FunctionEnv)" class="member-name-link">evalOrNull</a><wbr>(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr,
<a href="../engine/binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a>&nbsp;binding,
<a href="../function/FunctionEnv.html" title="interface in org.apache.jena.sparql.function">FunctionEnv</a>&nbsp;functionEnv)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Evaluate or return null.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#foldConstants(org.apache.jena.sparql.expr.Expr)" class="member-name-link">foldConstants</a><wbr>(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Attempt to fold any sub-expressions of the Expr.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isAssignmentSafeEquality(org.apache.jena.sparql.expr.Expr)" class="member-name-link">isAssignmentSafeEquality</a><wbr>(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Decide whether an expression is safe for using a graph substitution.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isAssignmentSafeEquality(org.apache.jena.sparql.expr.Expr,boolean,boolean)" class="member-name-link">isAssignmentSafeEquality</a><wbr>(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr,
boolean&nbsp;graphHasStringEquality,
boolean&nbsp;graphHasNumercialValueEquality)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isStable(org.apache.jena.sparql.expr.Expr)" class="member-name-link">isStable</a><wbr>(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Some "functions" are non-deterministic (unstable) -
calling them with the same arguments
does not yields the same answer each time.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#nodeToExpr(org.apache.jena.graph.Node)" class="member-name-link">nodeToExpr</a><wbr>(org.apache.jena.graph.Node&nbsp;n)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Go from a node to an expression.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#replaceAggregateByVariable(org.apache.jena.sparql.expr.Expr)" class="member-name-link">replaceAggregateByVariable</a><wbr>(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">transform an expression that may involve aggregates into one that just uses the variable for the aggregate</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#rewriteTriple(org.apache.jena.graph.Triple)" class="member-name-link">rewriteTriple</a><wbr>(org.apache.jena.graph.Triple&nbsp;t)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</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>ExprLib</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ExprLib</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="evalOrNull(org.apache.jena.sparql.expr.Expr,org.apache.jena.sparql.engine.binding.Binding,org.apache.jena.sparql.function.FunctionEnv)">
<h3>evalOrNull</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="NodeValue.html" title="class in org.apache.jena.sparql.expr">NodeValue</a></span>&nbsp;<span class="element-name">evalOrNull</span><wbr><span class="parameters">(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr,
<a href="../engine/binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a>&nbsp;binding,
<a href="../function/FunctionEnv.html" title="interface in org.apache.jena.sparql.function">FunctionEnv</a>&nbsp;functionEnv)</span></div>
<div class="block">Evaluate or return null.
<p>
This is better (faster) than the simple implementation
which captures <a href="ExprEvalException.html" title="class in org.apache.jena.sparql.expr"><code>ExprEvalException</code></a> and returns null.</div>
</section>
</li>
<li>
<section class="detail" id="foldConstants(org.apache.jena.sparql.expr.Expr)">
<h3>foldConstants</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a></span>&nbsp;<span class="element-name">foldConstants</span><wbr><span class="parameters">(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr)</span></div>
<div class="block">Attempt to fold any sub-expressions of the Expr.
Return an expression that is equivalent to the argument but maybe simpler.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>expr</code> - </dd>
<dt>Returns:</dt>
<dd>Expression</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="replaceAggregateByVariable(org.apache.jena.sparql.expr.Expr)">
<h3>replaceAggregateByVariable</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a></span>&nbsp;<span class="element-name">replaceAggregateByVariable</span><wbr><span class="parameters">(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr)</span></div>
<div class="block">transform an expression that may involve aggregates into one that just uses the variable for the aggregate</div>
</section>
</li>
<li>
<section class="detail" id="isAssignmentSafeEquality(org.apache.jena.sparql.expr.Expr)">
<h3>isAssignmentSafeEquality</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isAssignmentSafeEquality</span><wbr><span class="parameters">(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr)</span></div>
<div class="block">Decide whether an expression is safe for using a graph substitution.
Need to be careful about value-like tests when the graph is not
matched in a value fashion.</div>
</section>
</li>
<li>
<section class="detail" id="isAssignmentSafeEquality(org.apache.jena.sparql.expr.Expr,boolean,boolean)">
<h3>isAssignmentSafeEquality</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isAssignmentSafeEquality</span><wbr><span class="parameters">(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr,
boolean&nbsp;graphHasStringEquality,
boolean&nbsp;graphHasNumercialValueEquality)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>graphHasStringEquality</code> - True if the graph triple matching equates xsd:string and plain literal</dd>
<dd><code>graphHasNumercialValueEquality</code> - True if the graph triple matching equates numeric values</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isStable(org.apache.jena.sparql.expr.Expr)">
<h3>isStable</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isStable</span><wbr><span class="parameters">(<a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a>&nbsp;expr)</span></div>
<div class="block">Some "functions" are non-deterministic (unstable) -
calling them with the same arguments
does not yields the same answer each time.
Therefore how and when they are called
matters.
Functions: RAND, UUID, StrUUID, BNode
NOW() is safe.</div>
</section>
</li>
<li>
<section class="detail" id="nodeToExpr(org.apache.jena.graph.Node)">
<h3>nodeToExpr</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a></span>&nbsp;<span class="element-name">nodeToExpr</span><wbr><span class="parameters">(org.apache.jena.graph.Node&nbsp;n)</span></div>
<div class="block">Go from a node to an expression.</div>
</section>
</li>
<li>
<section class="detail" id="rewriteTriple(org.apache.jena.graph.Triple)">
<h3>rewriteTriple</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a></span>&nbsp;<span class="element-name">rewriteTriple</span><wbr><span class="parameters">(org.apache.jena.graph.Triple&nbsp;t)</span></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>