blob: 9073ad06ce52bdb7692ad86223063c8ee984a3f9 [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 (version 1.7.0_80) on Thu Jun 14 10:04:07 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>QueryBuilder (OpenJPA Parent POM 2.4.3 API)</title>
<meta name="date" content="2018-06-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="QueryBuilder (OpenJPA Parent POM 2.4.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/QueryBuilder.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/persistence/query/PredicateOperand.html" title="interface in org.apache.openjpa.persistence.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/persistence/query/QueryBuilderImpl.html" title="class in org.apache.openjpa.persistence.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/persistence/query/QueryBuilder.html" target="_top">Frames</a></li>
<li><a href="QueryBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All 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.persistence.query</div>
<h2 title="Interface QueryBuilder" class="title">Interface QueryBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/persistence/query/OpenJPAQueryBuilder.html" title="interface in org.apache.openjpa.persistence.query">OpenJPAQueryBuilder</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/persistence/query/QueryBuilderImpl.html" title="class in org.apache.openjpa.persistence.query">QueryBuilderImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">QueryBuilder</span></pre>
<div class="block">Factory interface for query definition objects</div>
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html" title="interface in org.apache.openjpa.persistence.query">QueryDefinition</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/query/QueryBuilder.html#createQueryDefinition()">createQueryDefinition</a></strong>()</code>
<div class="block">Create an uninitialized query definition object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/query/DomainObject.html" title="interface in org.apache.openjpa.persistence.query">DomainObject</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/query/QueryBuilder.html#createQueryDefinition(java.lang.Class)">createQueryDefinition</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;root)</code>
<div class="block">Create a query definition object with the given root.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/query/DomainObject.html" title="interface in org.apache.openjpa.persistence.query">DomainObject</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/query/QueryBuilder.html#createSubqueryDefinition(org.apache.openjpa.persistence.query.PathExpression)">createSubqueryDefinition</a></strong>(<a href="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</a>&nbsp;path)</code>
<div class="block">Create a query definition object whose root is derived from a domain
object of the containing query.</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="createQueryDefinition()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQueryDefinition</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html" title="interface in org.apache.openjpa.persistence.query">QueryDefinition</a>&nbsp;createQueryDefinition()</pre>
<div class="block">Create an uninitialized query definition object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>query definition instance</dd></dl>
</li>
</ul>
<a name="createQueryDefinition(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQueryDefinition</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/query/DomainObject.html" title="interface in org.apache.openjpa.persistence.query">DomainObject</a>&nbsp;createQueryDefinition(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;root)</pre>
<div class="block">Create a query definition object with the given root. The root must be an
entity class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cls</code> - -
an entity class</dd>
<dt><span class="strong">Returns:</span></dt><dd>root domain object</dd></dl>
</li>
</ul>
<a name="createSubqueryDefinition(org.apache.openjpa.persistence.query.PathExpression)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createSubqueryDefinition</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/query/DomainObject.html" title="interface in org.apache.openjpa.persistence.query">DomainObject</a>&nbsp;createSubqueryDefinition(<a href="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</a>&nbsp;path)</pre>
<div class="block">Create a query definition object whose root is derived from a domain
object of the containing query. Provides support for correlated
subqueries. Joins against the resulting domain object do not affect the
query domain of the containing query. The path expression must correspond
to an entity class. The path expression must not be a domain object of
the containing query.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - -
path expression corresponding to the domain object used to
derive the subquery root.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the subquery DomainObject</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/QueryBuilder.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/persistence/query/PredicateOperand.html" title="interface in org.apache.openjpa.persistence.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/persistence/query/QueryBuilderImpl.html" title="class in org.apache.openjpa.persistence.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/persistence/query/QueryBuilder.html" target="_top">Frames</a></li>
<li><a href="QueryBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All 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;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>