| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_65) on Mon Jun 01 22:44:04 CEST 2015 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| MetadataProcessor (OpenJPA Parent POM 2.4.0 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2015-06-01"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MetadataProcessor (OpenJPA Parent POM 2.4.0 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MetadataProcessor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.SingularAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/persistence/meta/MetamodelImpl.html" title="class in org.apache.openjpa.persistence.meta"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/persistence/meta/MetadataProcessor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MetadataProcessor.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.openjpa.persistence.meta</FONT> |
| <BR> |
| Interface MetadataProcessor<T,M></H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/openjpa/persistence/meta/SourceAnnotationHandler.html" title="class in org.apache.openjpa.persistence.meta">SourceAnnotationHandler</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>MetadataProcessor<T,M></B></DL> |
| </PRE> |
| |
| <P> |
| 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. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0.0</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Pinaki Poddar</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#determineMemberAccess(M)">determineMemberAccess</A></B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">M</A> m)</CODE> |
| |
| <BR> |
| Determine the access type of the given member.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#determineTypeAccess(T)">determineTypeAccess</A></B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</CODE> |
| |
| <BR> |
| Determine the access type of the given type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#getPersistentMembers(T)">getPersistentMembers</A></B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</CODE> |
| |
| <BR> |
| Get the persistent members of the given type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#getPersistentSupertype(T)">getPersistentSupertype</A></B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#isMixedAccess(T)">isMixedAccess</A></B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</CODE> |
| |
| <BR> |
| Affirms if the members of given type are using both field and property |
| based access.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html#validateAccess(T)">validateAccess</A></B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</CODE> |
| |
| <BR> |
| Gets the violations, if any.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="determineTypeAccess(java.lang.Object)"><!-- --></A><A NAME="determineTypeAccess(T)"><!-- --></A><H3> |
| determineTypeAccess</H3> |
| <PRE> |
| int <B>determineTypeAccess</B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</PRE> |
| <DL> |
| <DD>Determine the access type of the given type. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an integer denoting the type of access. The integer value |
| corresponds to ClassMetaData#getAccessType().</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="determineMemberAccess(java.lang.Object)"><!-- --></A><A NAME="determineMemberAccess(M)"><!-- --></A><H3> |
| determineMemberAccess</H3> |
| <PRE> |
| int <B>determineMemberAccess</B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">M</A> m)</PRE> |
| <DL> |
| <DD>Determine the access type of the given member. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an integer denoting the type of access. The integer value |
| corresponds to FieldMetaData#getAccessType().</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPersistentMembers(java.lang.Object)"><!-- --></A><A NAME="getPersistentMembers(T)"><!-- --></A><H3> |
| getPersistentMembers</H3> |
| <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>> <B>getPersistentMembers</B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</PRE> |
| <DL> |
| <DD>Get the persistent members of the given type. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="validateAccess(java.lang.Object)"><!-- --></A><A NAME="validateAccess(T)"><!-- --></A><H3> |
| validateAccess</H3> |
| <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>> <B>validateAccess</B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</PRE> |
| <DL> |
| <DD>Gets the violations, if any. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>null or empty list if no exceptions.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isMixedAccess(java.lang.Object)"><!-- --></A><A NAME="isMixedAccess(T)"><!-- --></A><H3> |
| isMixedAccess</H3> |
| <PRE> |
| boolean <B>isMixedAccess</B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</PRE> |
| <DL> |
| <DD>Affirms if the members of given type are using both field and property |
| based access. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPersistentSupertype(java.lang.Object)"><!-- --></A><A NAME="getPersistentSupertype(T)"><!-- --></A><H3> |
| getPersistentSupertype</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> <B>getPersistentSupertype</B>(<A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="type parameter in MetadataProcessor">T</A> t)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MetadataProcessor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.SingularAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/persistence/meta/MetamodelImpl.html" title="class in org.apache.openjpa.persistence.meta"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/persistence/meta/MetadataProcessor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MetadataProcessor.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006–2015 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved. |
| </BODY> |
| </HTML> |
