| <!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>JPQLContext (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="JPQLContext (olingo-odata2-parent 2.0.10 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; | |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/JPQLContext.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>Prev Class</li> | |
| <li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html" target="_top">Frames</a></li> | |
| <li><a href="JPQLContext.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: </li> | |
| <li><a href="#nested.class.summary">Nested</a> | </li> | |
| <li><a href="#field.summary">Field</a> | </li> | |
| <li><a href="#constructor.summary">Constr</a> | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#field.detail">Field</a> | </li> | |
| <li><a href="#constructor.detail">Constr</a> | </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="Class JPQLContext" class="title">Class JPQLContext</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="inheritance"> | |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> | |
| <li> | |
| <ul class="inheritance"> | |
| <li>org.apache.olingo.odata2.jpa.processor.api.jpql.JPQLContext</li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Implemented Interfaces:</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> | |
| <hr> | |
| <br> | |
| <pre>public abstract class <span class="typeNameLabel">JPQLContext</span> | |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> | |
| implements <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 abstract class is a compilation of objects required for building | |
| <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>. Extend this | |
| class to implement specific implementations of JPQL context types (Select, | |
| Join). A JPQL Context is constructed from an OData | |
| request. Depending on OData CRUD operation performed on an Entity, a | |
| corresponding JPQL context object is built. The JPQL context object thus | |
| built can be used for constructing JPQL statements. <br> | |
| A default implementation is provided by the library.</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>, | |
| <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql"><code>JPQLContextType</code></a>, | |
| <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/factory/JPQLBuilderFactory.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.factory"><code>JPQLBuilderFactory</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ======== NESTED CLASS SUMMARY ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="nested.class.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Nested Class Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> | |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Class and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>static class </code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContext.JPQLContextBuilder</a></span></code> | |
| <div class="block">The abstract class is extended by specific JPQLContext builder for | |
| building JPQLContexts.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="field.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Field Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> | |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Field and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>protected <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/JPQLContext.html#jpaEntityAlias">jpaEntityAlias</a></span></code> | |
| <div class="block">An alias for Java Persistence Entity</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>protected <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/JPQLContext.html#jpaEntityName">jpaEntityName</a></span></code> | |
| <div class="block">Java Persistence Entity name</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>protected boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#pagingRequested">pagingRequested</a></span></code> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>protected <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#type">type</a></span></code> | |
| <div class="block">The type of JPQL context.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> | |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colOne" scope="col">Constructor and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#JPQLContext--">JPQLContext</a></span>()</code> </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContext.JPQLContextBuilder</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#createBuilder-org.apache.olingo.odata2.jpa.processor.api.jpql.JPQLContextType-java.lang.Object-">createBuilder</a></span>(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a> contextType, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> resultsView)</code> | |
| <div class="block">the method returns an instance of type | |
| <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><code>JPQLContext.JPQLContextBuilder</code></a> based on the | |
| JPQLContextType.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContext.JPQLContextBuilder</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#createBuilder-org.apache.olingo.odata2.jpa.processor.api.jpql.JPQLContextType-java.lang.Object-boolean-">createBuilder</a></span>(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a> contextType, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> resultsView, | |
| boolean withPaging)</code> | |
| <div class="block">the method returns an instance of type | |
| <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><code>JPQLContext.JPQLContextBuilder</code></a> based on the | |
| JPQLContextType.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <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/JPQLContext.html#getJPAEntityAlias--">getJPAEntityAlias</a></span>()</code> | |
| <div class="block">gets the JPA entity alias name set into the context</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" 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/JPQLContext.html#getJPAEntityName--">getJPAEntityName</a></span>()</code> | |
| <div class="block">gets the JPA entity name set into the context</div> | |
| </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#getType--">getType</a></span>()</code> | |
| <div class="block">gets the JPQL context type set into the context</div> | |
| </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>protected void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#isPagingRequested-boolean-">isPagingRequested</a></span>(boolean pagingRequested)</code> </td> | |
| </tr> | |
| <tr id="i6" class="altColor"> | |
| <td class="colFirst"><code>protected void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#setJPAEntityAlias-java.lang.String-">setJPAEntityAlias</a></span>(<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> jpaEntityAlias)</code> | |
| <div class="block">sets JPA Entity alias name into the context</div> | |
| </td> | |
| </tr> | |
| <tr id="i7" class="rowColor"> | |
| <td class="colFirst"><code>protected void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#setJPAEntityName-java.lang.String-">setJPAEntityName</a></span>(<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> jpaEntityName)</code> | |
| <div class="block">sets JPA Entity Name into the context</div> | |
| </td> | |
| </tr> | |
| <tr id="i8" class="altColor"> | |
| <td class="colFirst"><code>protected void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html#setType-org.apache.olingo.odata2.jpa.processor.api.jpql.JPQLContextType-">setType</a></span>(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a> type)</code> | |
| <div class="block">sets the JPQL context type into the context</div> | |
| </td> | |
| </tr> | |
| </table> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> | |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ============ FIELD DETAIL =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="field.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Field Detail</h3> | |
| <a name="jpaEntityAlias"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>jpaEntityAlias</h4> | |
| <pre>protected <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> jpaEntityAlias</pre> | |
| <div class="block">An alias for Java Persistence Entity</div> | |
| </li> | |
| </ul> | |
| <a name="jpaEntityName"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>jpaEntityName</h4> | |
| <pre>protected <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> jpaEntityName</pre> | |
| <div class="block">Java Persistence Entity name</div> | |
| </li> | |
| </ul> | |
| <a name="type"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>type</h4> | |
| <pre>protected <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a> type</pre> | |
| <div class="block">The type of JPQL context. Based on the type JPQL statements can be built.</div> | |
| </li> | |
| </ul> | |
| <a name="pagingRequested"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>pagingRequested</h4> | |
| <pre>protected boolean pagingRequested</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Detail</h3> | |
| <a name="JPQLContext--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>JPQLContext</h4> | |
| <pre>public JPQLContext()</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="setJPAEntityName-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setJPAEntityName</h4> | |
| <pre>protected final void setJPAEntityName(<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> jpaEntityName)</pre> | |
| <div class="block">sets JPA Entity Name into the context</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>jpaEntityName</code> - is the name of JPA Entity</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setJPAEntityAlias-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setJPAEntityAlias</h4> | |
| <pre>protected final void setJPAEntityAlias(<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> jpaEntityAlias)</pre> | |
| <div class="block">sets JPA Entity alias name into the context</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>jpaEntityAlias</code> - is the JPA entity alias name</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getJPAEntityAlias--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJPAEntityAlias</h4> | |
| <pre>public final <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> getJPAEntityAlias()</pre> | |
| <div class="block">gets the JPA entity alias name set into the context</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextView.html#getJPAEntityAlias--">getJPAEntityAlias</a></code> in interface <code><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></code></dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>JPA entity alias name</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setType-org.apache.olingo.odata2.jpa.processor.api.jpql.JPQLContextType-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setType</h4> | |
| <pre>protected final void setType(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a> type)</pre> | |
| <div class="block">sets the JPQL context type into the context</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>type</code> - is JPQLContextType</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getJPAEntityName--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJPAEntityName</h4> | |
| <pre>public final <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> getJPAEntityName()</pre> | |
| <div class="block">gets the JPA entity name set into the context</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextView.html#getJPAEntityName--">getJPAEntityName</a></code> in interface <code><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></code></dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>JPA entity name</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getType--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getType</h4> | |
| <pre>public final <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a> getType()</pre> | |
| <div class="block">gets the JPQL context type set into the context</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextView.html#getType--">getType</a></code> in interface <code><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></code></dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql"><code>JPQLContextType</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="isPagingRequested-boolean-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isPagingRequested</h4> | |
| <pre>protected void isPagingRequested(boolean pagingRequested)</pre> | |
| </li> | |
| </ul> | |
| <a name="createBuilder-org.apache.olingo.odata2.jpa.processor.api.jpql.JPQLContextType-java.lang.Object-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>createBuilder</h4> | |
| <pre>public static final <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContext.JPQLContextBuilder</a> createBuilder(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a> contextType, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> resultsView) | |
| throws <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></pre> | |
| <div class="block">the method returns an instance of type | |
| <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><code>JPQLContext.JPQLContextBuilder</code></a> based on the | |
| JPQLContextType. The context builder can be used for | |
| building different JPQL contexts.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>contextType</code> - is the JPQLContextType</dd> | |
| <dd><code>resultsView</code> - is the OData request view</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><code>JPQLContext.JPQLContextBuilder</code></a></dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="createBuilder-org.apache.olingo.odata2.jpa.processor.api.jpql.JPQLContextType-java.lang.Object-boolean-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>createBuilder</h4> | |
| <pre>public static final <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContext.JPQLContextBuilder</a> createBuilder(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContextType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.jpql">JPQLContextType</a> contextType, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> resultsView, | |
| boolean withPaging) | |
| throws <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></pre> | |
| <div class="block">the method returns an instance of type | |
| <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><code>JPQLContext.JPQLContextBuilder</code></a> based on the | |
| JPQLContextType. The context builder can be used for | |
| building different JPQL contexts.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>contextType</code> - is the JPQLContextType</dd> | |
| <dd><code>resultsView</code> - is the OData request view</dd> | |
| <dd><code>withPaging</code> - indicates whether to build the context with paging</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><code>JPQLContext.JPQLContextBuilder</code></a></dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></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/JPQLContext.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>Prev Class</li> | |
| <li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.JPQLContextBuilder.html" title="class in org.apache.olingo.odata2.jpa.processor.api.jpql"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/jpql/JPQLContext.html" target="_top">Frames</a></li> | |
| <li><a href="JPQLContext.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: </li> | |
| <li><a href="#nested.class.summary">Nested</a> | </li> | |
| <li><a href="#field.summary">Field</a> | </li> | |
| <li><a href="#constructor.summary">Constr</a> | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#field.detail">Field</a> | </li> | |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2013-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> | |
| </body> | |
| </html> |