| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FunctionEnvBase (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: FunctionEnvBase"> |
| <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/FunctionEnvBase.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 FunctionEnvBase" class="title">Class FunctionEnvBase</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.FunctionEnvBase</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="FunctionEnv.html" title="interface in org.apache.jena.sparql.function">FunctionEnv</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FunctionEnvBase</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="FunctionEnv.html" title="interface in org.apache.jena.sparql.function">FunctionEnv</a></span></div> |
| <div class="block">Environment passed to functions -- see also <a href="../engine/ExecutionContext.html" title="class in org.apache.jena.sparql.engine"><code>ExecutionContext</code></a></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">FunctionEnvBase</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.jena.sparql.engine.ExecutionContext)" class="member-name-link">FunctionEnvBase</a><wbr>(<a href="../engine/ExecutionContext.html" title="class in org.apache.jena.sparql.engine">ExecutionContext</a> execCxt)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.jena.sparql.util.Context)" class="member-name-link">FunctionEnvBase</a><wbr>(<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"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.jena.sparql.util.Context,org.apache.jena.graph.Graph,org.apache.jena.sparql.core.DatasetGraph)" class="member-name-link">FunctionEnvBase</a><wbr>(<a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a> context, |
| org.apache.jena.graph.Graph activeGraph, |
| <a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a> dataset)</code></div> |
| <div class="col-last odd-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-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>org.apache.jena.graph.Graph</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getActiveGraph()" class="member-name-link">getActiveGraph</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the active graph (the one matching is against at this point in the query.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the context for this function call</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataset()" class="member-name-link">getDataset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the dataset for the query</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>FunctionEnvBase</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FunctionEnvBase</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.jena.sparql.util.Context)"> |
| <h3>FunctionEnvBase</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FunctionEnvBase</span><wbr><span class="parameters">(<a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a> context)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.jena.sparql.engine.ExecutionContext)"> |
| <h3>FunctionEnvBase</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FunctionEnvBase</span><wbr><span class="parameters">(<a href="../engine/ExecutionContext.html" title="class in org.apache.jena.sparql.engine">ExecutionContext</a> execCxt)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.jena.sparql.util.Context,org.apache.jena.graph.Graph,org.apache.jena.sparql.core.DatasetGraph)"> |
| <h3>FunctionEnvBase</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FunctionEnvBase</span><wbr><span class="parameters">(<a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a> context, |
| org.apache.jena.graph.Graph activeGraph, |
| <a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a> dataset)</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="getActiveGraph()"> |
| <h3>getActiveGraph</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.jena.graph.Graph</span> <span class="element-name">getActiveGraph</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="FunctionEnv.html#getActiveGraph()">FunctionEnv</a></code></span></div> |
| <div class="block">Return the active graph (the one matching is against at this point in the query. |
| May be null if unknown or not applicable - for example, doing quad store access or |
| when sorting.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="FunctionEnv.html#getActiveGraph()">getActiveGraph</a></code> in interface <code><a href="FunctionEnv.html" title="interface in org.apache.jena.sparql.function">FunctionEnv</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext()"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a></span> <span class="element-name">getContext</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="FunctionEnv.html#getContext()">FunctionEnv</a></code></span></div> |
| <div class="block">Return the context for this function call</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="FunctionEnv.html#getContext()">getContext</a></code> in interface <code><a href="FunctionEnv.html" title="interface in org.apache.jena.sparql.function">FunctionEnv</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataset()"> |
| <h3>getDataset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a></span> <span class="element-name">getDataset</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="FunctionEnv.html#getDataset()">FunctionEnv</a></code></span></div> |
| <div class="block">Return the dataset for the query</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="FunctionEnv.html#getDataset()">getDataset</a></code> in interface <code><a href="FunctionEnv.html" title="interface in org.apache.jena.sparql.function">FunctionEnv</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> |
