Google Git
Sign in
apache / olingo-site / refs/heads/preview/4.9.0-release-staging / . / output / javadoc / odata2 / org / apache / olingo / odata2 / jpa / processor / api / factory / ODataJPAAccessFactory.html
blob: b7400aaeae54a6de279d4bc69f1511b99b9991db [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>ODataJPAAccessFactory (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="ODataJPAAccessFactory (olingo-odata2-parent 2.0.10 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/ODataJPAAccessFactory.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/factory/JPQLBuilderFactory.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.factory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/factory/ODataJPAFactory.html" title="class in org.apache.olingo.odata2.jpa.processor.api.factory"><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/factory/ODataJPAAccessFactory.html" target="_top">Frames</a></li>
<li><a href="ODataJPAAccessFactory.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.factory</div>
<h2 title="Interface ODataJPAAccessFactory" class="title">Interface ODataJPAAccessFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ODataJPAAccessFactory</span></pre>
<div class="block">Factory interface for creating following instances
<p>
<ul>
<li>OData JPA Processor of type <a href="../../../../../../../../org/apache/olingo/odata2/api/processor/ODataSingleProcessor.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataSingleProcessor</code></a></li>
<li>JPA EDM Provider of type <a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/EdmProvider.html" title="class in org.apache.olingo.odata2.api.edm.provider"><code>EdmProvider</code></a></li>
<li>OData JPA Context <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api"><code>ODataJPAContext</code></a></li>
<li>OData JPA Response Builder <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html" title="interface in org.apache.olingo.odata2.jpa.processor.api"><code>ODataJPAResponseBuilder</code></a></li>
</ul>
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/factory/ODataJPAFactory.html" title="class in org.apache.olingo.odata2.jpa.processor.api.factory"><code>ODataJPAFactory</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="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/EdmProvider.html" title="class in org.apache.olingo.odata2.api.edm.provider">EdmProvider</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/factory/ODataJPAAccessFactory.html#createJPAEdmProvider-org.apache.olingo.odata2.jpa.processor.api.ODataJPAContext-">createJPAEdmProvider</a></span>(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAContext</a>&nbsp;oDataJPAContext)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/factory/ODataJPAAccessFactory.html#createODataJPAContext--">createODataJPAContext</a></span>()</code>
<div class="block">The method creates an instance of OData JPA Context.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/api/processor/ODataSingleProcessor.html" title="class in org.apache.olingo.odata2.api.processor">ODataSingleProcessor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/factory/ODataJPAAccessFactory.html#createODataProcessor-org.apache.olingo.odata2.jpa.processor.api.ODataJPAContext-">createODataProcessor</a></span>(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAContext</a>&nbsp;oDataJPAContext)</code>
<div class="block">The method creates an OData JPA Processor.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPAMessageService.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPAMessageService</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/factory/ODataJPAAccessFactory.html#getODataJPAMessageService-java.util.Locale-">getODataJPAMessageService</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">The method creates an instance of message service for loading language
dependent message text.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAResponseBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/factory/ODataJPAAccessFactory.html#getODataJPAResponseBuilder-org.apache.olingo.odata2.jpa.processor.api.ODataJPAContext-">getODataJPAResponseBuilder</a></span>(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAContext</a>&nbsp;oDataJPAContext)</code>&nbsp;</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="createODataProcessor-org.apache.olingo.odata2.jpa.processor.api.ODataJPAContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createODataProcessor</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/api/processor/ODataSingleProcessor.html" title="class in org.apache.olingo.odata2.api.processor">ODataSingleProcessor</a>&nbsp;createODataProcessor(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAContext</a>&nbsp;oDataJPAContext)</pre>
<div class="block">The method creates an OData JPA Processor. The processor handles runtime
behavior of an OData service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>oDataJPAContext</code> - an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api"><code>ODataJPAContext</code></a>.
The context should be initialized properly and cannot be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An implementation of OData JPA Processor.</dd>
</dl>
</li>
</ul>
<a name="createJPAEdmProvider-org.apache.olingo.odata2.jpa.processor.api.ODataJPAContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createJPAEdmProvider</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/EdmProvider.html" title="class in org.apache.olingo.odata2.api.edm.provider">EdmProvider</a>&nbsp;createJPAEdmProvider(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAContext</a>&nbsp;oDataJPAContext)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>oDataJPAContext</code> - an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api"><code>ODataJPAContext</code></a>.
The context should be initialized properly and cannot be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An implementation of JPA EdmProvider. EdmProvider handles
meta-data.</dd>
</dl>
</li>
</ul>
<a name="createODataJPAContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createODataJPAContext</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAContext</a>&nbsp;createODataJPAContext()</pre>
<div class="block">The method creates an instance of OData JPA Context. An empty instance is
returned.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api"><code>ODataJPAContext</code></a></dd>
</dl>
</li>
</ul>
<a name="getODataJPAMessageService-java.util.Locale-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getODataJPAMessageService</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPAMessageService.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPAMessageService</a>&nbsp;getODataJPAMessageService(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</pre>
<div class="block">The method creates an instance of message service for loading language
dependent message text.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locale</code> - is the language in which the message service should load
message texts.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPAMessageService.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.exception"><code>ODataJPAMessageService</code></a></dd>
</dl>
</li>
</ul>
<a name="getODataJPAResponseBuilder-org.apache.olingo.odata2.jpa.processor.api.ODataJPAContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getODataJPAResponseBuilder</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAResponseBuilder</a>&nbsp;getODataJPAResponseBuilder(<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAContext</a>&nbsp;oDataJPAContext)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>oDataJPAContext</code> - an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api"><code>ODataJPAContext</code></a>.
The context should be initialized properly and cannot be null.
The method creates an instance of OData Response Builder for building OData Responses from a JPA Entity.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html" title="interface in org.apache.olingo.odata2.jpa.processor.api"><code>ODataJPAResponseBuilder</code></a></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/ODataJPAAccessFactory.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/factory/JPQLBuilderFactory.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.factory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/factory/ODataJPAFactory.html" title="class in org.apache.olingo.odata2.jpa.processor.api.factory"><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/factory/ODataJPAAccessFactory.html" target="_top">Frames</a></li>
<li><a href="ODataJPAAccessFactory.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>