| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FunctionBase (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.function, class: FunctionBase"> |
| <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/FunctionBase.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="../../../../../module-summary.html">org.apache.jena.arq</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jena.sparql.function</a></div> |
| <h1 title="Class FunctionBase" class="title">Class FunctionBase</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.function.FunctionBase</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="Function.html" title="interface in org.apache.jena.sparql.function">Function</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="library/AFN_AdjustToTimezone.html" title="class in org.apache.jena.sparql.function.library">AFN_AdjustToTimezone</a></code>, <code><a href="library/leviathan/cartesian.html" title="class in org.apache.jena.sparql.function.library.leviathan">cartesian</a></code>, <code><a href="library/context.html" title="class in org.apache.jena.sparql.function.library">context</a></code>, <code><a href="library/execTime.html" title="class in org.apache.jena.sparql.function.library">execTime</a></code>, <code><a href="library/FN_AdjustDatetimeToTimezone.html" title="class in org.apache.jena.sparql.function.library">FN_AdjustDatetimeToTimezone</a></code>, <code><a href="library/FN_AdjustDateToTimezone.html" title="class in org.apache.jena.sparql.function.library">FN_AdjustDateToTimezone</a></code>, <code><a href="library/FN_AdjustTimeToTimezone.html" title="class in org.apache.jena.sparql.function.library">FN_AdjustTimeToTimezone</a></code>, <code><a href="library/FN_Apply.html" title="class in org.apache.jena.sparql.function.library">FN_Apply</a></code>, <code><a href="library/FN_Error.html" title="class in org.apache.jena.sparql.function.library">FN_Error</a></code>, <code><a href="library/FN_FormatNumber.html" title="class in org.apache.jena.sparql.function.library">FN_FormatNumber</a></code>, <code><a href="library/FN_Round.html" title="class in org.apache.jena.sparql.function.library">FN_Round</a></code>, <code><a href="library/FN_Round_Half_Even.html" title="class in org.apache.jena.sparql.function.library">FN_Round_Half_Even</a></code>, <code><a href="library/FN_StrConcat.html" title="class in org.apache.jena.sparql.function.library">FN_StrConcat</a></code>, <code><a href="library/FN_StrNormalizeUnicode.html" title="class in org.apache.jena.sparql.function.library">FN_StrNormalizeUnicode</a></code>, <code><a href="library/FN_StrReplace.html" title="class in org.apache.jena.sparql.function.library">FN_StrReplace</a></code>, <code><a href="library/FN_StrSubstring.html" title="class in org.apache.jena.sparql.function.library">FN_StrSubstring</a></code>, <code><a href="FunctionBase0.html" title="class in org.apache.jena.sparql.function">FunctionBase0</a></code>, <code><a href="FunctionBase1.html" title="class in org.apache.jena.sparql.function">FunctionBase1</a></code>, <code><a href="FunctionBase2.html" title="class in org.apache.jena.sparql.function">FunctionBase2</a></code>, <code><a href="FunctionBase3.html" title="class in org.apache.jena.sparql.function">FunctionBase3</a></code>, <code><a href="FunctionBase4.html" title="class in org.apache.jena.sparql.function">FunctionBase4</a></code>, <code><a href="FunctionBase5.html" title="class in org.apache.jena.sparql.function">FunctionBase5</a></code>, <code><a href="library/leviathan/log.html" title="class in org.apache.jena.sparql.function.library.leviathan">log</a></code>, <code><a href="library/leviathan/rnd.html" title="class in org.apache.jena.sparql.function.library.leviathan">rnd</a></code>, <code><a href="scripting/ScriptFunction.html" title="class in org.apache.jena.sparql.function.scripting">ScriptFunction</a></code>, <code><a href="library/sprintf.html" title="class in org.apache.jena.sparql.function.library">sprintf</a></code>, <code><a href="library/strjoin.html" title="class in org.apache.jena.sparql.function.library">strjoin</a></code>, <code><a href="library/substring.html" title="class in org.apache.jena.sparql.function.library">substring</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">FunctionBase</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> |
| implements <a href="Function.html" title="interface in org.apache.jena.sparql.function">Function</a></span></div> |
| <div class="block">Implementation root for custom function evaluation.</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">FunctionBase</a>()</code></div> |
| <div class="col-last even-row-color"> </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-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><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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build(java.lang.String,org.apache.jena.sparql.expr.ExprList,org.apache.jena.sparql.util.Context)" class="member-name-link">build</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> uri, |
| <a href="../expr/ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a> args, |
| <a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a> context)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Called during query plan construction immediately after the |
| construction of the extension instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#checkBuild(java.lang.String,org.apache.jena.sparql.expr.ExprList)" class="member-name-link">checkBuild</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> uri, |
| <a href="../expr/ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a> args)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="../expr/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-tab2 method-summary-table-tab3"><code><a href="#exec(java.util.List)" class="member-name-link">exec</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../expr/NodeValue.html" title="class in org.apache.jena.sparql.expr">NodeValue</a>> args)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Function call to a list of evaluated argument values</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../expr/NodeValue.html" title="class in org.apache.jena.sparql.expr">NodeValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#exec(org.apache.jena.sparql.engine.binding.Binding,org.apache.jena.sparql.expr.ExprList,java.lang.String,org.apache.jena.sparql.function.FunctionEnv)" class="member-name-link">exec</a><wbr>(<a href="../engine/binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a> binding, |
| <a href="../expr/ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a> args, |
| <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> uri, |
| <a href="FunctionEnv.html" title="interface in org.apache.jena.sparql.function">FunctionEnv</a> env)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Call a function.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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="<init>()"> |
| <h3>FunctionBase</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FunctionBase</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="build(java.lang.String,org.apache.jena.sparql.expr.ExprList,org.apache.jena.sparql.util.Context)"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">build</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> uri, |
| <a href="../expr/ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a> args, |
| <a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a> context)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Function.html#build(java.lang.String,org.apache.jena.sparql.expr.ExprList,org.apache.jena.sparql.util.Context)">Function</a></code></span></div> |
| <div class="block">Called during query plan construction immediately after the |
| construction of the extension instance. |
| A function can throw <a href="../expr/ExprException.html" title="class in org.apache.jena.sparql.expr"><code>ExprException</code></a> if something is wrong (like wrong number of arguments).</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Function.html#build(java.lang.String,org.apache.jena.sparql.expr.ExprList,org.apache.jena.sparql.util.Context)">build</a></code> in interface <code><a href="Function.html" title="interface in org.apache.jena.sparql.function">Function</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - The function URI</dd> |
| <dd><code>args</code> - The parsed arguments</dd> |
| <dd><code>context</code> - The build context.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="exec(org.apache.jena.sparql.engine.binding.Binding,org.apache.jena.sparql.expr.ExprList,java.lang.String,org.apache.jena.sparql.function.FunctionEnv)"> |
| <h3>exec</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../expr/NodeValue.html" title="class in org.apache.jena.sparql.expr">NodeValue</a></span> <span class="element-name">exec</span><wbr><span class="parameters">(<a href="../engine/binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a> binding, |
| <a href="../expr/ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a> args, |
| <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> uri, |
| <a href="FunctionEnv.html" title="interface in org.apache.jena.sparql.function">FunctionEnv</a> env)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Function.html#exec(org.apache.jena.sparql.engine.binding.Binding,org.apache.jena.sparql.expr.ExprList,java.lang.String,org.apache.jena.sparql.function.FunctionEnv)">Function</a></code></span></div> |
| <div class="block">Call a function. |
| The argument list will not be null but may have the wrong number of arguments. |
| FunctionBase provides a more convenient way to implement a function. |
| Functions can throw <a href="../expr/ExprEvalException.html" title="class in org.apache.jena.sparql.expr"><code>ExprEvalException</code></a> if something goes wrong.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Function.html#exec(org.apache.jena.sparql.engine.binding.Binding,org.apache.jena.sparql.expr.ExprList,java.lang.String,org.apache.jena.sparql.function.FunctionEnv)">exec</a></code> in interface <code><a href="Function.html" title="interface in org.apache.jena.sparql.function">Function</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>binding</code> - The current solution</dd> |
| <dd><code>args</code> - A list of unevaluated expressions</dd> |
| <dd><code>uri</code> - The name of this</dd> |
| <dd><code>env</code> - The execution context</dd> |
| <dt>Returns:</dt> |
| <dd>NodeValue - a value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="exec(java.util.List)"> |
| <h3>exec</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="../expr/NodeValue.html" title="class in org.apache.jena.sparql.expr">NodeValue</a></span> <span class="element-name">exec</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../expr/NodeValue.html" title="class in org.apache.jena.sparql.expr">NodeValue</a>> args)</span></div> |
| <div class="block">Function call to a list of evaluated argument values</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkBuild(java.lang.String,org.apache.jena.sparql.expr.ExprList)"> |
| <h3>checkBuild</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">checkBuild</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> uri, |
| <a href="../expr/ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a> args)</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> |
