blob: 744dc841f86735240b1ca3ec61b2f79f67531aea [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:23 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JPAEdmSchemaView (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="JPAEdmSchemaView (olingo-odata2-parent 2.0.10 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/JPAEdmSchemaView.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/model/JPAEdmReferentialConstraintView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmSchemaView.html" target="_top">Frames</a></li>
<li><a href="JPAEdmSchemaView.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.model</div>
<h2 title="Interface JPAEdmSchemaView" class="title">Interface JPAEdmSchemaView</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/model/JPAEdmBaseView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmBaseView</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">JPAEdmSchemaView</span>
extends <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmBaseView</a></pre>
<div class="block"><p>
A view on Java Persistence Model and Entity Data Model Schema. Each java
persistence unit corresponds to a one EDM schema.
</p>
<p>
The implementation of the view provides access to EDM schema created from
Java Persistence unit. The implementation acts as a container for schema. The
schema is consistent only if following elements are consistent
<ol>
<li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmAssociationView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmAssociationView</code></a></li>
<li> <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmEntityContainerView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmEntityContainerView</code></a></li>
<li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmComplexTypeView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmComplexTypeView</code></a></li>
</ol>
</p>
<p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmAssociationView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmAssociationView</code></a>,
<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmEntityContainerView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmEntityContainerView</code></a>,
<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmComplexTypeView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmComplexTypeView</code></a></dd>
<dt><span class="simpleTagLabel">Do not implement this interface or derive from class.</span></dt>
</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/Schema.html" title="class in org.apache.olingo.odata2.api.edm.provider">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmSchemaView.html#getEdmSchema--">getEdmSchema</a></span>()</code>
<div class="block">The method returns the EDM schema present in the container.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmAssociationView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmAssociationView</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmSchemaView.html#getJPAEdmAssociationView--">getJPAEdmAssociationView</a></span>()</code>
<div class="block">The method returns JPA EDM association view.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmComplexTypeView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmComplexTypeView</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmSchemaView.html#getJPAEdmComplexTypeView--">getJPAEdmComplexTypeView</a></span>()</code>
<div class="block">The method returns JPA EDM complex view.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmEntityContainerView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmEntityContainerView</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmSchemaView.html#getJPAEdmEntityContainerView--">getJPAEdmEntityContainerView</a></span>()</code>
<div class="block">The method returns JPA EDM container view.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<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>&lt;?&gt;,<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>[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmSchemaView.html#getRegisteredOperations--">getRegisteredOperations</a></span>()</code>
<div class="block">The method returns an Hash Map containing the registered custom
operations.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmSchemaView.html#registerOperations-java.lang.Class-java.lang.String:A-">registerOperations</a></span>(<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>&lt;?&gt;&nbsp;customClass,
<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;methodNames)</code>
<div class="block">The method registers custom operations that shall be represented as Edm
Function Imports.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.odata2.jpa.processor.api.model.JPAEdmBaseView">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.olingo.odata2.jpa.processor.api.model.<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmBaseView</a></h3>
<code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html#clean--">clean</a>, <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html#getBuilder--">getBuilder</a>, <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html#getJPAEdmExtension--">getJPAEdmExtension</a>, <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html#getJPAEdmMappingModelAccess--">getJPAEdmMappingModelAccess</a>, <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html#getJPAMetaModel--">getJPAMetaModel</a>, <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html#getpUnitName--">getpUnitName</a>, <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html#isConsistent--">isConsistent</a>, <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmBaseView.html#isDefaultNamingSkipped--">isDefaultNamingSkipped</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="getEdmSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEdmSchema</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/Schema.html" title="class in org.apache.olingo.odata2.api.edm.provider">Schema</a>&nbsp;getEdmSchema()</pre>
<div class="block">The method returns the EDM schema present in the container.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance EDM schema of type <a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/Schema.html" title="class in org.apache.olingo.odata2.api.edm.provider"><code>Schema</code></a></dd>
</dl>
</li>
</ul>
<a name="getJPAEdmEntityContainerView--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJPAEdmEntityContainerView</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmEntityContainerView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmEntityContainerView</a>&nbsp;getJPAEdmEntityContainerView()</pre>
<div class="block">The method returns JPA EDM container view. The JPA EDM container view can
be used to access EDM Entity Container elements.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmEntityContainerView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmEntityContainerView</code></a></dd>
</dl>
</li>
</ul>
<a name="getJPAEdmComplexTypeView--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJPAEdmComplexTypeView</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmComplexTypeView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmComplexTypeView</a>&nbsp;getJPAEdmComplexTypeView()</pre>
<div class="block">The method returns JPA EDM complex view. The JPA EDM complex view can be
used to access EDM complex types and JPA Embeddable Types.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmComplexTypeView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmComplexTypeView</code></a></dd>
</dl>
</li>
</ul>
<a name="getJPAEdmAssociationView--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJPAEdmAssociationView</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmAssociationView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmAssociationView</a>&nbsp;getJPAEdmAssociationView()</pre>
<div class="block">The method returns JPA EDM association view. The JPA EDM association view
can be used to access EDM associations and JPA Relationships.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmAssociationView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmAssociationView</code></a></dd>
</dl>
</li>
</ul>
<a name="registerOperations-java.lang.Class-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerOperations</h4>
<pre>void&nbsp;registerOperations(<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>&lt;?&gt;&nbsp;customClass,
<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;methodNames)</pre>
<div class="block">The method registers custom operations that shall be represented as Edm
Function Imports. Custom operations are created using Edm Annotation
<code>org.apache.olingo.odata2.api.annotation.edm.FunctionImport</code>.
<p>
Custom Operations can be part of JPA Entity or can be created in a class
other than JPA Entity. Such custom operations can be registered using
this method.
<p>
The method is a callback.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>customClass</code> - is the class that contains custom operations</dd>
<dd><code>methodNames</code> - is the name of the method that needs to be transformed into
Function Imports. It is an optional parameter. If null is
passed then all annotated methods are transformed into
Function Imports.</dd>
</dl>
</li>
</ul>
<a name="getRegisteredOperations--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRegisteredOperations</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<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>&lt;?&gt;,<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>[]&gt;&nbsp;getRegisteredOperations()</pre>
<div class="block">The method returns an Hash Map containing the registered custom
operations.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a HashMap of Class and the methods in the class</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/JPAEdmSchemaView.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/model/JPAEdmReferentialConstraintView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmSchemaView.html" target="_top">Frames</a></li>
<li><a href="JPAEdmSchemaView.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>