| <!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>JPAEdmReferentialConstraintRoleView (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="JPAEdmReferentialConstraintRoleView (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/JPAEdmReferentialConstraintRoleView.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/JPAEdmPropertyView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.RoleType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.model"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.html" target="_top">Frames</a></li> | |
| <li><a href="JPAEdmReferentialConstraintRoleView.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>Field | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li>Constr | </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 JPAEdmReferentialConstraintRoleView" class="title">Interface JPAEdmReferentialConstraintRoleView</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">JPAEdmReferentialConstraintRoleView</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 Entity Join Column's "name" and | |
| "referenced column name" attributes and Entity Data Model Referential | |
| Constraint's dependent and principal roles respectively. Each java | |
| persistence entity with properties annotated with Join Columns are | |
| transformed into Referential constraints and Referential constraint roles. | |
| </p> | |
| <p> | |
| The implementation of the view provides access to EDM referential constraint | |
| roles created from Java Persistence Entity Join Columns. The implementation | |
| acts as a container for EDM referential constraint roles. A referential | |
| constraint role is consistent only if the principal role and dependent roles | |
| can be created from JPA Entity relationships. | |
| </p> | |
| <p></div> | |
| <dl> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmReferentialConstraintView</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"> | |
| <!-- ======== 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">Interface 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/model/JPAEdmReferentialConstraintRoleView.RoleType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmReferentialConstraintRoleView.RoleType</a></span></code> | |
| <div class="block">Two types of EDM roles of a referential constraint.</div> | |
| </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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><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/model/JPAEdmReferentialConstraintRoleView.html#getEdmAssociationName--">getEdmAssociationName</a></span>()</code> | |
| <div class="block">The method returns the EDM association name.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.html#getEdmEntityTypeName--">getEdmEntityTypeName</a></span>()</code> | |
| <div class="block">The method returns the EDM entity type name that holds the | |
| relationship/referential constraint.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/ReferentialConstraintRole.html" title="class in org.apache.olingo.odata2.api.edm.provider">ReferentialConstraintRole</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.html#getEdmReferentialConstraintRole--">getEdmReferentialConstraintRole</a></span>()</code> | |
| <div class="block">The method returns the Referential constraint role that is currently | |
| being processed.</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/model/JPAEdmReferentialConstraintRoleView.html#getJPAColumnName--">getJPAColumnName</a></span>()</code> | |
| <div class="block">The method returns the name of JPA attribute's column name (annotated | |
| with @Column).</div> | |
| </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.RoleType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmReferentialConstraintRoleView.RoleType</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.html#getRoleType--">getRoleType</a></span>()</code> | |
| <div class="block">The method returns the role type (PRINCIPAL or DEPENDENT)</div> | |
| </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.html#isExists--">isExists</a></span>()</code> | |
| <div class="block">The method tells if there exists a valid referential constraint for a | |
| given association.</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 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="getRoleType--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getRoleType</h4> | |
| <pre><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.RoleType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.model">JPAEdmReferentialConstraintRoleView.RoleType</a> getRoleType()</pre> | |
| <div class="block">The method returns the role type (PRINCIPAL or DEPENDENT)</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a <a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.RoleType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.model"><code>JPAEdmReferentialConstraintRoleView.RoleType</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getEdmReferentialConstraintRole--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getEdmReferentialConstraintRole</h4> | |
| <pre><a href="../../../../../../../../org/apache/olingo/odata2/api/edm/provider/ReferentialConstraintRole.html" title="class in org.apache.olingo.odata2.api.edm.provider">ReferentialConstraintRole</a> getEdmReferentialConstraintRole()</pre> | |
| <div class="block">The method returns the Referential constraint role that is 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/ReferentialConstraintRole.html" title="class in org.apache.olingo.odata2.api.edm.provider"><code>ReferentialConstraintRole</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getJPAColumnName--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJPAColumnName</h4> | |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getJPAColumnName()</pre> | |
| <div class="block">The method returns the name of JPA attribute's column name (annotated | |
| with @Column). The returned Column Name acts as the PRINCIPAL entity | |
| type.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>name of JPA Column name</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getEdmEntityTypeName--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getEdmEntityTypeName</h4> | |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getEdmEntityTypeName()</pre> | |
| <div class="block">The method returns the EDM entity type name that holds the | |
| relationship/referential constraint. The entity type that acts as a | |
| DEPENDENT entity type.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>name of EDM entity type</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getEdmAssociationName--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getEdmAssociationName</h4> | |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getEdmAssociationName()</pre> | |
| <div class="block">The method returns the EDM association name.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>name of EDM association</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="isExists--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>isExists</h4> | |
| <pre>boolean isExists()</pre> | |
| <div class="block">The method tells if there exists a valid referential constraint for a | |
| given association.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>true - if valid referential constraint exits else false</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/JPAEdmReferentialConstraintRoleView.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/JPAEdmPropertyView.html" title="interface in org.apache.olingo.odata2.jpa.processor.api.model"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../../org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.RoleType.html" title="enum in org.apache.olingo.odata2.jpa.processor.api.model"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/model/JPAEdmReferentialConstraintRoleView.html" target="_top">Frames</a></li> | |
| <li><a href="JPAEdmReferentialConstraintRoleView.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>Field | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li>Constr | </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> |