Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 3.0.0 / apidocs / org / apache / openjpa / jdbc / kernel / exps / package-summary.html
blob: 20645fb0b1488fa3af6f725659ef68b3e2742056 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:17 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.openjpa.jdbc.kernel.exps (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<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="org.apache.openjpa.jdbc.kernel.exps (OpenJPA Parent POM 3.0.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/jdbc/kernel/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/openjpa/jdbc/meta/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/openjpa/jdbc/kernel/exps/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.openjpa.jdbc.kernel.exps</h1>
<div class="docSummary">
<div class="block"><strong>OpenJPA-JDBC Expression Tree</strong></div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">FilterValue</a></td>
<td class="colLast">
<div class="block">The simplified public view of any non-operator in a query filter,
including constants, variables, and object fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCAggregateListener.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">JDBCAggregateListener</a></td>
<td class="colLast">
<div class="block">JDBC extension to the <a href="../../../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps"><code>AggregateListener</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">JDBCFilterListener</a></td>
<td class="colLast">
<div class="block">JDBC extension to the <a href="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps"><code>FilterListener</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Val.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">Val</a></td>
<td class="colLast">
<div class="block">A Value represents any non-operator in a query filter, including
constants, variables, and object fields.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Abs.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Abs</a></td>
<td class="colLast">
<div class="block">Absolute value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Args.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Args</a></td>
<td class="colLast">
<div class="block">A list of arguments to a multi-argument function.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/CoalesceExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps">CoalesceExpression</a></td>
<td class="colLast">
<div class="block">Coalesce expression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/CollectionParam.html" title="class in org.apache.openjpa.jdbc.kernel.exps">CollectionParam</a></td>
<td class="colLast">
<div class="block">A collection-valued input parameter in an in-expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/CollectionParam.ParamExpState.html" title="class in org.apache.openjpa.jdbc.kernel.exps">CollectionParam.ParamExpState</a></td>
<td class="colLast">
<div class="block">Expression state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Concat.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Concat</a></td>
<td class="colLast">
<div class="block">Concatenate one string with another.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/DatastoreFunction.html" title="class in org.apache.openjpa.jdbc.kernel.exps">DatastoreFunction</a></td>
<td class="colLast">
<div class="block">A unary operator that executes a datastore specific function with zero or more arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/ExpContext.html" title="class in org.apache.openjpa.jdbc.kernel.exps">ExpContext</a></td>
<td class="colLast">
<div class="block">Expression tree context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/ExpState.html" title="class in org.apache.openjpa.jdbc.kernel.exps">ExpState</a></td>
<td class="colLast">
<div class="block">Expression tree state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/GeneralCaseExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps">GeneralCaseExpression</a></td>
<td class="colLast">
<div class="block">General case expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/GetColumn.html" title="class in org.apache.openjpa.jdbc.kernel.exps">GetColumn</a></td>
<td class="colLast">
<div class="block">Returns the SQL alias of the named column for use in a query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/IndexOf.html" title="class in org.apache.openjpa.jdbc.kernel.exps">IndexOf</a></td>
<td class="colLast">
<div class="block">Find the index of one string within another.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCExpressionFactory.html" title="class in org.apache.openjpa.jdbc.kernel.exps">JDBCExpressionFactory</a></td>
<td class="colLast">
<div class="block">Expression factory implementation that can be used to execute queries
via SQL.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCStringContains.html" title="class in org.apache.openjpa.jdbc.kernel.exps">JDBCStringContains</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Use <code>matches()</code> instead.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCWildcardMatch.html" title="class in org.apache.openjpa.jdbc.kernel.exps">JDBCWildcardMatch</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Use <code>matches()</code> instead.</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Lit.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Lit</a></td>
<td class="colLast">
<div class="block">A literal value in a filter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/MapEntry.html" title="class in org.apache.openjpa.jdbc.kernel.exps">MapEntry</a></td>
<td class="colLast">
<div class="block">Returns the Map.Entry<K,V> of a map value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/MapEntry.EntryExpState.html" title="class in org.apache.openjpa.jdbc.kernel.exps">MapEntry.EntryExpState</a></td>
<td class="colLast">
<div class="block">Expression state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/MapKey.html" title="class in org.apache.openjpa.jdbc.kernel.exps">MapKey</a></td>
<td class="colLast">
<div class="block">Returns the key of a map value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/MapKey.KeyExpState.html" title="class in org.apache.openjpa.jdbc.kernel.exps">MapKey.KeyExpState</a></td>
<td class="colLast">
<div class="block">Expression state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Math.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Math</a></td>
<td class="colLast">
<div class="block">Value produced by a mathematical operation on two values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Null.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Null</a></td>
<td class="colLast">
<div class="block">A literal null value in a filter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/NullableAggregateUnaryOp.html" title="class in org.apache.openjpa.jdbc.kernel.exps">NullableAggregateUnaryOp</a></td>
<td class="colLast">
<div class="block">OPENJPA-1794
An aggregate unary operation that can indicate whether a null value from the data store
should be returned as null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/NullIfExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps">NullIfExpression</a></td>
<td class="colLast">
<div class="block">NullIf expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Param.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Param</a></td>
<td class="colLast">
<div class="block">A parameter in a filter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Param.ParamExpState.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Param.ParamExpState</a></td>
<td class="colLast">
<div class="block">Expression state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/PCPath.html" title="class in org.apache.openjpa.jdbc.kernel.exps">PCPath</a></td>
<td class="colLast">
<div class="block">A path represents a traversal into fields of a candidate object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/PCPath.PathExpState.html" title="class in org.apache.openjpa.jdbc.kernel.exps">PCPath.PathExpState</a></td>
<td class="colLast">
<div class="block">Expression state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/QueryExpressionsState.html" title="class in org.apache.openjpa.jdbc.kernel.exps">QueryExpressionsState</a></td>
<td class="colLast">
<div class="block">Struct to hold the state of a query expressions instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SelectConstructor.html" title="class in org.apache.openjpa.jdbc.kernel.exps">SelectConstructor</a></td>
<td class="colLast">
<div class="block">Turns parsed queries into selects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SimpleCaseExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps">SimpleCaseExpression</a></td>
<td class="colLast">
<div class="block">Simple case expression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html" title="class in org.apache.openjpa.jdbc.kernel.exps">SQLEmbed</a></td>
<td class="colLast">
<div class="block">Simple listener which embeds its SQL argument into the query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps">SQLExpression</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Use <a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><code>SQLEmbed</code></a> directly</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLValue.html" title="class in org.apache.openjpa.jdbc.kernel.exps">SQLValue</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Use <a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><code>SQLEmbed</code></a> directly</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Sqrt.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Sqrt</a></td>
<td class="colLast">
<div class="block">Square root.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/StringLength.html" title="class in org.apache.openjpa.jdbc.kernel.exps">StringLength</a></td>
<td class="colLast">
<div class="block">Returns the number of characters in a string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SubQ.html" title="class in org.apache.openjpa.jdbc.kernel.exps">SubQ</a></td>
<td class="colLast">
<div class="block">A subquery.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Substring.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Substring</a></td>
<td class="colLast">
<div class="block">Take a substring of a string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/ToLowerCase.html" title="class in org.apache.openjpa.jdbc.kernel.exps">ToLowerCase</a></td>
<td class="colLast">
<div class="block">Lower-cases a string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/ToUpperCase.html" title="class in org.apache.openjpa.jdbc.kernel.exps">ToUpperCase</a></td>
<td class="colLast">
<div class="block">Upper-cases a string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/Trim.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Trim</a></td>
<td class="colLast">
<div class="block">Returns the number of characters in a string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/TypeLit.html" title="class in org.apache.openjpa.jdbc.kernel.exps">TypeLit</a></td>
<td class="colLast">
<div class="block">A type literal value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/WhenCondition.html" title="class in org.apache.openjpa.jdbc.kernel.exps">WhenCondition</a></td>
<td class="colLast">
<div class="block">Value produced by a when_clause of a case expression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/openjpa/jdbc/kernel/exps/WhenScalar.html" title="class in org.apache.openjpa.jdbc.kernel.exps">WhenScalar</a></td>
<td class="colLast">
<div class="block">Value produced by a when_clause of a case expression.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.openjpa.jdbc.kernel.exps Description">Package org.apache.openjpa.jdbc.kernel.exps Description</h2>
<div class="block"><p><strong>OpenJPA-JDBC Expression Tree</strong></p></div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/jdbc/kernel/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/openjpa/jdbc/meta/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/openjpa/jdbc/kernel/exps/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>