Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 3.1.0 / apidocs / org / apache / openjpa / kernel / exps / ExpressionParser.html
blob: e6a6de0456f198e5fcb73b1299431414078716dd [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_201) on Wed Apr 24 20:07:04 CEST 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ExpressionParser (OpenJPA Parent POM 3.1.0 API)</title>
<meta name="date" content="2019-04-24">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ExpressionParser (OpenJPA Parent POM 3.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ExpressionParser.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionFactory.html" title="interface in org.apache.openjpa.kernel.exps"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionVisitor.html" title="interface in org.apache.openjpa.kernel.exps"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/kernel/exps/ExpressionParser.html" target="_top">Frames</a></li>
<li><a href="ExpressionParser.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openjpa.kernel.exps</div>
<h2 title="Interface ExpressionParser" class="title">Interface ExpressionParser</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/persistence/criteria/CriteriaBuilderImpl.html" title="class in org.apache.openjpa.persistence.criteria">CriteriaBuilderImpl</a>, <a href="../../../../../org/apache/openjpa/kernel/jpql/JPQLParser.html" title="class in org.apache.openjpa.kernel.jpql">JPQLParser</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ExpressionParser</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Parser for query languages that will be used by a <code>ExpressionQuery</code>.
A QueryParser is responsible for translating from some string-based query
language into <a href="../../../../../org/apache/openjpa/kernel/exps/Expression.html" title="interface in org.apache.openjpa.kernel.exps"><code>Expression</code></a>s. Parsers should be stateless.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Marc Prud'hommeaux</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/kernel/exps/QueryExpressions.html" title="class in org.apache.openjpa.kernel.exps">QueryExpressions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionParser.html#eval-java.lang.Object-org.apache.openjpa.kernel.ExpressionStoreQuery-org.apache.openjpa.kernel.exps.ExpressionFactory-org.apache.openjpa.meta.ClassMetaData-">eval</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;parsed,
<a href="../../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</a>&nbsp;query,
<a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionFactory.html" title="interface in org.apache.openjpa.kernel.exps">ExpressionFactory</a>&nbsp;factory,
<a href="../../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;candidate)</code>
<div class="block">Parse the given query string.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionParser.html#eval-java.lang.String:A-org.apache.openjpa.kernel.ExpressionStoreQuery-org.apache.openjpa.kernel.exps.ExpressionFactory-org.apache.openjpa.meta.ClassMetaData-">eval</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;vals,
<a href="../../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</a>&nbsp;query,
<a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionFactory.html" title="interface in org.apache.openjpa.kernel.exps">ExpressionFactory</a>&nbsp;factory,
<a href="../../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;candidate)</code>
<div class="block">Parse the given value clauses.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionParser.html#getLanguage--">getLanguage</a></span>()</code>
<div class="block">Return a string key describing the language that this instance parses.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionParser.html#parse-java.lang.String-org.apache.openjpa.kernel.ExpressionStoreQuery-">parse</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ql,
<a href="../../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</a>&nbsp;query)</code>
<div class="block">Return a parsed intermediate form of the given query string.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionParser.html#populate-java.lang.Object-org.apache.openjpa.kernel.ExpressionStoreQuery-">populate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;parsed,
<a href="../../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</a>&nbsp;query)</code>
<div class="block">Use the parsed query form to set information such as candidate type,
result type, etc that was encoded in the query string.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLanguage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLanguage</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getLanguage()</pre>
<div class="block">Return a string key describing the language that this instance parses.</div>
</li>
</ul>
<a name="parse-java.lang.String-org.apache.openjpa.kernel.ExpressionStoreQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;parse(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ql,
<a href="../../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</a>&nbsp;query)</pre>
<div class="block">Return a parsed intermediate form of the given query string.</div>
</li>
</ul>
<a name="populate-java.lang.Object-org.apache.openjpa.kernel.ExpressionStoreQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>populate</h4>
<pre>void&nbsp;populate(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;parsed,
<a href="../../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</a>&nbsp;query)</pre>
<div class="block">Use the parsed query form to set information such as candidate type,
result type, etc that was encoded in the query string.</div>
</li>
</ul>
<a name="eval-java.lang.Object-org.apache.openjpa.kernel.ExpressionStoreQuery-org.apache.openjpa.kernel.exps.ExpressionFactory-org.apache.openjpa.meta.ClassMetaData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eval</h4>
<pre><a href="../../../../../org/apache/openjpa/kernel/exps/QueryExpressions.html" title="class in org.apache.openjpa.kernel.exps">QueryExpressions</a>&nbsp;eval(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;parsed,
<a href="../../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</a>&nbsp;query,
<a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionFactory.html" title="interface in org.apache.openjpa.kernel.exps">ExpressionFactory</a>&nbsp;factory,
<a href="../../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;candidate)</pre>
<div class="block">Parse the given query string.</div>
</li>
</ul>
<a name="eval-java.lang.String:A-org.apache.openjpa.kernel.ExpressionStoreQuery-org.apache.openjpa.kernel.exps.ExpressionFactory-org.apache.openjpa.meta.ClassMetaData-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>eval</h4>
<pre><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a>[]&nbsp;eval(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;vals,
<a href="../../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</a>&nbsp;query,
<a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionFactory.html" title="interface in org.apache.openjpa.kernel.exps">ExpressionFactory</a>&nbsp;factory,
<a href="../../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;candidate)</pre>
<div class="block">Parse the given value clauses.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ExpressionParser.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionFactory.html" title="interface in org.apache.openjpa.kernel.exps"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionVisitor.html" title="interface in org.apache.openjpa.kernel.exps"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/kernel/exps/ExpressionParser.html" target="_top">Frames</a></li>
<li><a href="ExpressionParser.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2019 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>