blob: 3ec1a21a54c13878d2532b55a5058e3e6bbaee0e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Wed Dec 06 14:36:22 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JPQLSelectSingleContextView (olingo-odata2-parent 2.0.10 API)</title>
<meta name="date" content="2017-12-06">
<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="JPQLSelectSingleContextView (olingo-odata2-parent 2.0.10 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/JPQLSelectSingleContextView.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/olingo/odata2/jpa/processor/api/jpql/JPQLSelectContextView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.jpql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLStatement.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLSelectSingleContextView.html" target="_top">Frames</a></li>
<li><a href="JPQLSelectSingleContextView.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.olingo.odata2.jpa.processor.api.jpql</div>
<h2 title="Interface JPQLSelectSingleContextView" class="title">Interface JPQLSelectSingleContextView</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextView</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLJoinSelectSingleContextView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLJoinSelectSingleContextView</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">JPQLSelectSingleContextView</span>
extends <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextView</a></pre>
<div class="block">The interface provide a view on JPQL select single context.The interface
provides methods for accessing the clause of a JPQL SELECT statement like
"SELECT". The view can be used for building JPQL statements without any
WHERE,JOIN,ORDERBY clauses. The clauses are built from OData read entity
request views.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLStatement.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><code>JPQLStatement</code></a></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="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/olingo/odata2/api/uri/KeyPredicate.html" title="interface in org.apache.olingo.odata2.api.uri">KeyPredicate</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLSelectSingleContextView.html#getKeyPredicates--">getKeyPredicates</a></span>()</code>
<div class="block">The method returns the list of key predicates that can be used for
constructing the WHERE clause in JPQL statements.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/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/olingo/odata2/jpa/processor/api/jpql/JPQLSelectSingleContextView.html#getSelectExpression--">getSelectExpression</a></span>()</code>
<div class="block">The method returns a JPQL SELECT clause.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.odata2.jpa.processor.api.jpql.JPQLContextView">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.olingo.odata2.jpa.processor.api.jpql.<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextView</a></h3>
<code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextView.html#getJPAEntityAlias--">getJPAEntityAlias</a>, <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextView.html#getJPAEntityName--">getJPAEntityName</a>, <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextView.html#getType--">getType</a></code></li>
</ul>
</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="getSelectExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectExpression</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSelectExpression()</pre>
<div class="block">The method returns a JPQL SELECT clause. The SELECT clause is built from
$select OData system Query option.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String representing a SELECT clause in JPQL</dd>
</dl>
</li>
</ul>
<a name="getKeyPredicates--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getKeyPredicates</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/olingo/odata2/api/uri/KeyPredicate.html" title="interface in org.apache.olingo.odata2.api.uri">KeyPredicate</a>&gt;&nbsp;getKeyPredicates()</pre>
<div class="block">The method returns the list of key predicates that can be used for
constructing the WHERE clause in JPQL statements. The OData entity key
predicates are thus converted into JPA entity keys.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of key predicates</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>
<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/JPQLSelectSingleContextView.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/olingo/odata2/jpa/processor/api/jpql/JPQLSelectContextView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.jpql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLStatement.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLSelectSingleContextView.html" target="_top">Frames</a></li>
<li><a href="JPQLSelectSingleContextView.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; 2013-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>