blob: c43c804d0f491669ba21096801796c6006051f40 [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>JPAEdmEntityTypeView (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="JPAEdmEntityTypeView (olingo-odata2-parent 2.0.10 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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/JPAEdmEntityTypeView.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/JPAEdmEntitySetView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmExtension.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><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/model/JPAEdmEntityTypeView.html" target="_top">Frames</a></li>
<li><a href="JPAEdmEntityTypeView.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 JPAEdmEntityTypeView" class="title">Interface JPAEdmEntityTypeView</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">JPAEdmEntityTypeView</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">A view on Java Persistence entity types and EDM entity types. Java
persistence entity types are converted into EDM entity types.
<p>
The implementation of the view provides access to EDM entity types for the
given JPA EDM model. The view acts as a container for consistent list of EDM
entity types. An EDM entity type is said to be consistent only if it has at
least one consistent EDM property and at least one consistent EDM key.
<p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmPropertyView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmPropertyView</code></a>,
<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmKeyView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmKeyView</code></a>,
<a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmNavigationPropertyView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmNavigationPropertyView</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="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/edm/provider/EntityType.html" title="class in org.apache.olingo.odata2.api.edm.provider">EntityType</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmEntityTypeView.html#getConsistentEdmEntityTypes--">getConsistentEdmEntityTypes</a></span>()</code>
<div class="block">The method returns a consistent list of EDM entity types for a given java
persistence meta model.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/EntityType.html" title="class in org.apache.olingo.odata2.api.edm.provider">EntityType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmEntityTypeView.html#getEdmEntityType--">getEdmEntityType</a></span>()</code>
<div class="block">The method returns an EDM entity currently being processed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>javax.persistence.metamodel.EntityType&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmEntityTypeView.html#getJPAEntityType--">getJPAEntityType</a></span>()</code>
<div class="block">The method returns java persistence Entity type currently being
processed.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/EntityType.html" title="class in org.apache.olingo.odata2.api.edm.provider">EntityType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmEntityTypeView.html#searchEdmEntityType-java.lang.String-">searchEdmEntityType</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>&nbsp;jpaEntityTypeName)</code>
<div class="block">The method searches in the consistent list of EDM entity types for the
given EDM entity type's name.</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="getEdmEntityType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEdmEntityType</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/EntityType.html" title="class in org.apache.olingo.odata2.api.edm.provider">EntityType</a>&nbsp;getEdmEntityType()</pre>
<div class="block">The method returns an EDM entity currently being processed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/EntityType.html" title="class in org.apache.olingo.odata2.api.edm.provider"><code>EntityType</code></a></dd>
</dl>
</li>
</ul>
<a name="getJPAEntityType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJPAEntityType</h4>
<pre>javax.persistence.metamodel.EntityType&lt;?&gt;&nbsp;getJPAEntityType()</pre>
<div class="block">The method returns java persistence Entity type currently being
processed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <code>EntityType</code></dd>
</dl>
</li>
</ul>
<a name="getConsistentEdmEntityTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConsistentEdmEntityTypes</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/edm/provider/EntityType.html" title="class in org.apache.olingo.odata2.api.edm.provider">EntityType</a>&gt;&nbsp;getConsistentEdmEntityTypes()</pre>
<div class="block">The method returns a consistent list of EDM entity types for a given java
persistence meta model.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of <a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/EntityType.html" title="class in org.apache.olingo.odata2.api.edm.provider"><code>EntityType</code></a></dd>
</dl>
</li>
</ul>
<a name="searchEdmEntityType-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>searchEdmEntityType</h4>
<pre><a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/EntityType.html" title="class in org.apache.olingo.odata2.api.edm.provider">EntityType</a>&nbsp;searchEdmEntityType(<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;jpaEntityTypeName)</pre>
<div class="block">The method searches in the consistent list of EDM entity types for the
given EDM entity type's name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpaEntityTypeName</code> - is the name of EDM entity type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a reference to EDM entity type if found else null</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/JPAEdmEntityTypeView.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/JPAEdmEntitySetView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmExtension.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><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/model/JPAEdmEntityTypeView.html" target="_top">Frames</a></li>
<li><a href="JPAEdmEntityTypeView.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>