| <!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 (version 1.7.0_121) on Fri Jan 06 19:36:35 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MetadataProcessor (OpenJPA Parent POM 2.4.2 API)</title> |
| <meta name="date" content="2017-01-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MetadataProcessor (OpenJPA Parent POM 2.4.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/MetadataProcessor.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/openjpa/persistence/meta/Members.SingularAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/persistence/meta/MetamodelImpl.html" title="class in org.apache.openjpa.persistence.meta"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/persistence/meta/MetadataProcessor.html" target="_top">Frames</a></li> |
| <li><a href="MetadataProcessor.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>Nested | </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.openjpa.persistence.meta</div> |
| <h2 title="Interface MetadataProcessor" class="title">Interface MetadataProcessor<T,M></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/persistence/meta/SourceAnnotationHandler.html" title="class in org.apache.openjpa.persistence.meta">SourceAnnotationHandler</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">MetadataProcessor<T,M></span></pre> |
| <div class="block">Collection of generic utility functions for extracting persistence related |
| metadata from user specified metadata available in various source |
| environment. |
| <br> |
| Persistence metadata needs to be acquired from different sources such as |
| annotated source code, compiled class files, XML descriptors or combinations |
| thereof under different invocation and configuration context. |
| <br> |
| Specific implementation of this interface is distinguished by the nature of |
| the source and the representation available for type system in the source.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Pinaki Poddar</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#determineMemberAccess(M)">determineMemberAccess</a></strong>(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">M</a> m)</code> |
| <div class="block">Determine the access type of the given member.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#determineTypeAccess(T)">determineTypeAccess</a></strong>(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</code> |
| <div class="block">Determine the access type of the given type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">M</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#getPersistentMembers(T)">getPersistentMembers</a></strong>(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</code> |
| <div class="block">Get the persistent members of the given type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#getPersistentSupertype(T)">getPersistentSupertype</a></strong>(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#isMixedAccess(T)">isMixedAccess</a></strong>(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</code> |
| <div class="block">Affirms if the members of given type are using both field and property |
| based access.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#validateAccess(T)">validateAccess</a></strong>(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</code> |
| <div class="block">Gets the violations, if any.</div> |
| </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="determineTypeAccess(java.lang.Object)"> |
| <!-- --> |
| </a><a name="determineTypeAccess(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>determineTypeAccess</h4> |
| <pre>int determineTypeAccess(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</pre> |
| <div class="block">Determine the access type of the given type.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>an integer denoting the type of access. The integer value |
| corresponds to ClassMetaData#getAccessType().</dd></dl> |
| </li> |
| </ul> |
| <a name="determineMemberAccess(java.lang.Object)"> |
| <!-- --> |
| </a><a name="determineMemberAccess(M)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>determineMemberAccess</h4> |
| <pre>int determineMemberAccess(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">M</a> m)</pre> |
| <div class="block">Determine the access type of the given member.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>an integer denoting the type of access. The integer value |
| corresponds to FieldMetaData#getAccessType().</dd></dl> |
| </li> |
| </ul> |
| <a name="getPersistentMembers(java.lang.Object)"> |
| <!-- --> |
| </a><a name="getPersistentMembers(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistentMembers</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">M</a>> getPersistentMembers(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</pre> |
| <div class="block">Get the persistent members of the given type.</div> |
| </li> |
| </ul> |
| <a name="validateAccess(java.lang.Object)"> |
| <!-- --> |
| </a><a name="validateAccess(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateAccess</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>> validateAccess(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</pre> |
| <div class="block">Gets the violations, if any.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>null or empty list if no exceptions.</dd></dl> |
| </li> |
| </ul> |
| <a name="isMixedAccess(java.lang.Object)"> |
| <!-- --> |
| </a><a name="isMixedAccess(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMixedAccess</h4> |
| <pre>boolean isMixedAccess(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</pre> |
| <div class="block">Affirms if the members of given type are using both field and property |
| based access.</div> |
| </li> |
| </ul> |
| <a name="getPersistentSupertype(java.lang.Object)"> |
| <!-- --> |
| </a><a name="getPersistentSupertype(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPersistentSupertype</h4> |
| <pre><a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> getPersistentSupertype(<a href="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</a> t)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/MetadataProcessor.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/openjpa/persistence/meta/Members.SingularAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/persistence/meta/MetamodelImpl.html" title="class in org.apache.openjpa.persistence.meta"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/persistence/meta/MetadataProcessor.html" target="_top">Frames</a></li> |
| <li><a href="MetadataProcessor.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>Nested | </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 © 2006–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
