| <!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.5.0_19) on Wed Jan 13 14:47:59 CST 2010 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| MetaDataFactory (OpenJPA 1.2.2 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.meta.MetaDataFactory interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="MetaDataFactory (OpenJPA 1.2.2 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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/MetaDataFactory.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/meta/MetaDataDefaults.html" title="interface in org.apache.openjpa.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/meta/MetaDataInheritanceComparator.html" title="class in org.apache.openjpa.meta"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/meta/MetaDataFactory.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MetaDataFactory.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | 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.meta</FONT> |
| <BR> |
| Interface MetaDataFactory</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/openjpa/meta/AbstractCFMetaDataFactory.html" title="class in org.apache.openjpa.meta">AbstractCFMetaDataFactory</A>, <A HREF="../../../../org/apache/openjpa/meta/AbstractMetaDataFactory.html" title="class in org.apache.openjpa.meta">AbstractMetaDataFactory</A>, <A HREF="../../../../org/apache/openjpa/meta/DelegatingMetaDataFactory.html" title="class in org.apache.openjpa.meta">DelegatingMetaDataFactory</A>, <A HREF="../../../../org/apache/openjpa/jdbc/meta/MetaDataPlusMappingFactory.html" title="class in org.apache.openjpa.jdbc.meta">MetaDataPlusMappingFactory</A>, <A HREF="../../../../org/apache/openjpa/meta/NoneMetaDataFactory.html" title="class in org.apache.openjpa.meta">NoneMetaDataFactory</A>, <A HREF="../../../../org/apache/openjpa/persistence/jdbc/PersistenceMappingFactory.html" title="class in org.apache.openjpa.persistence.jdbc">PersistenceMappingFactory</A>, <A HREF="../../../../org/apache/openjpa/persistence/PersistenceMetaDataFactory.html" title="class in org.apache.openjpa.persistence">PersistenceMetaDataFactory</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>MetaDataFactory</B><DT>extends <A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</A></DL> |
| </PRE> |
| |
| <P> |
| The <A HREF="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta"><CODE>MetaDataRepository</CODE></A> uses implementations of this interface |
| to load and store metadata. Implementations need not be threadsafe. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Patrick Linskey, Abe White</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#STORE_DEFAULT">STORE_DEFAULT</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#STORE_PER_CLASS">STORE_PER_CLASS</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#STORE_VERBOSE">STORE_VERBOSE</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.meta.MetaDataModes"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from interface org.apache.openjpa.meta.<A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ALL">MODE_ALL</A>, <A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ANN_MAPPING">MODE_ANN_MAPPING</A>, <A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING">MODE_MAPPING</A>, <A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING_INIT">MODE_MAPPING_INIT</A>, <A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_META">MODE_META</A>, <A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_NONE">MODE_NONE</A>, <A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_QUERY">MODE_QUERY</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#addClassExtensionKeys(java.util.Collection)">addClassExtensionKeys</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> exts)</CODE> |
| |
| <BR> |
| Add any extension keys used by this instance to the given set.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#addFieldExtensionKeys(java.util.Collection)">addFieldExtensionKeys</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> exts)</CODE> |
| |
| <BR> |
| Add any extension keys used by this instance to the given set.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#clear()">clear</A></B>()</CODE> |
| |
| <BR> |
| Clear any internal caches.</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/meta/MetaDataFactory.html#drop(java.lang.Class[], int, java.lang.ClassLoader)">drop</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>[] cls, |
| int mode, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> envLoader)</CODE> |
| |
| <BR> |
| Drop the metadata for the given classes in the given mode(s).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/MetaDataDefaults.html" title="interface in org.apache.openjpa.meta">MetaDataDefaults</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getDefaults()">getDefaults</A></B>()</CODE> |
| |
| <BR> |
| Return the metadata defaults for this factory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getPersistentTypeNames(boolean, java.lang.ClassLoader)">getPersistentTypeNames</A></B>(boolean devpath, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> envLoader)</CODE> |
| |
| <BR> |
| Return all persistent class names, using the metadata locations supplied |
| in configuration, optionally scanning the classpath.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getQueryScope(java.lang.String, java.lang.ClassLoader)">getQueryScope</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> queryName, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> loader)</CODE> |
| |
| <BR> |
| Return the type defining the given query name, if any.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getResultSetMappingScope(java.lang.String, java.lang.ClassLoader)">getResultSetMappingScope</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> resultSetMappingName, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> loader)</CODE> |
| |
| <BR> |
| Return the type defining the given result set mapping name, if any.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#load(java.lang.Class, int, java.lang.ClassLoader)">load</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| int mode, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> envLoader)</CODE> |
| |
| <BR> |
| Load metadata for the given class in the given mode(s).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#loadXMLMetaData(org.apache.openjpa.meta.FieldMetaData)">loadXMLMetaData</A></B>(<A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> fmd)</CODE> |
| |
| <BR> |
| Load XMLClassMetadata for the given class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/lib/meta/ClassArgParser.html" title="class in org.apache.openjpa.lib.meta">ClassArgParser</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#newClassArgParser()">newClassArgParser</A></B>()</CODE> |
| |
| <BR> |
| Return a properly-configured class arg parser for our expected |
| metadata format.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#setRepository(org.apache.openjpa.meta.MetaDataRepository)">setRepository</A></B>(<A HREF="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</A> repos)</CODE> |
| |
| <BR> |
| Set the repository to load metadata into.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#setStoreDirectory(java.io.File)">setStoreDirectory</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dir)</CODE> |
| |
| <BR> |
| Base directory for storing metadata.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#setStoreMode(int)">setStoreMode</A></B>(int store)</CODE> |
| |
| <BR> |
| Storage mode.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html#setStrict(boolean)">setStrict</A></B>(boolean strict)</CODE> |
| |
| <BR> |
| If true, I/O's must exactly obey the mode directives given, and may |
| not load additional information.</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/meta/MetaDataFactory.html#store(org.apache.openjpa.meta.ClassMetaData[], org.apache.openjpa.meta.QueryMetaData[], org.apache.openjpa.meta.SequenceMetaData[], int, java.util.Map)">store</A></B>(<A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A>[] metas, |
| <A HREF="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta">QueryMetaData</A>[] queries, |
| <A HREF="../../../../org/apache/openjpa/meta/SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</A>[] seqs, |
| int mode, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A> output)</CODE> |
| |
| <BR> |
| Store the given metadata.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="STORE_DEFAULT"><!-- --></A><H3> |
| STORE_DEFAULT</H3> |
| <PRE> |
| static final int <B>STORE_DEFAULT</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.MetaDataFactory.STORE_DEFAULT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="STORE_PER_CLASS"><!-- --></A><H3> |
| STORE_PER_CLASS</H3> |
| <PRE> |
| static final int <B>STORE_PER_CLASS</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.MetaDataFactory.STORE_PER_CLASS">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="STORE_VERBOSE"><!-- --></A><H3> |
| STORE_VERBOSE</H3> |
| <PRE> |
| static final int <B>STORE_VERBOSE</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.MetaDataFactory.STORE_VERBOSE">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ============ 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="setRepository(org.apache.openjpa.meta.MetaDataRepository)"><!-- --></A><H3> |
| setRepository</H3> |
| <PRE> |
| void <B>setRepository</B>(<A HREF="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</A> repos)</PRE> |
| <DL> |
| <DD>Set the repository to load metadata into. |
| This method will be called before use. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStoreDirectory(java.io.File)"><!-- --></A><H3> |
| setStoreDirectory</H3> |
| <PRE> |
| void <B>setStoreDirectory</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dir)</PRE> |
| <DL> |
| <DD>Base directory for storing metadata. May not be called. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStoreMode(int)"><!-- --></A><H3> |
| setStoreMode</H3> |
| <PRE> |
| void <B>setStoreMode</B>(int store)</PRE> |
| <DL> |
| <DD>Storage mode. May not be called. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStrict(boolean)"><!-- --></A><H3> |
| setStrict</H3> |
| <PRE> |
| void <B>setStrict</B>(boolean strict)</PRE> |
| <DL> |
| <DD>If true, I/O's must exactly obey the mode directives given, and may |
| not load additional information. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="load(java.lang.Class, int, java.lang.ClassLoader)"><!-- --></A><H3> |
| load</H3> |
| <PRE> |
| void <B>load</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| int mode, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> envLoader)</PRE> |
| <DL> |
| <DD>Load metadata for the given class in the given mode(s). If loading |
| in <A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_QUERY"><CODE>MetaDataModes.MODE_QUERY</CODE></A>, the class may be null. Loaded |
| metadata should be added directly to the repository. It should have |
| its source mode set appropriately via |
| <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html#setSourceMode(int)"><CODE>ClassMetaData.setSourceMode(int)</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mode</CODE> - the mode to load metadata in: if mapping information is |
| stored together with metadata, then you can load mapping |
| data even if this mode only includes |
| <A HREF="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_META"><CODE>MODE_META</CODE></A>, so long as |
| the <code>strict</code> property hasn't been set</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="store(org.apache.openjpa.meta.ClassMetaData[], org.apache.openjpa.meta.QueryMetaData[], org.apache.openjpa.meta.SequenceMetaData[], int, java.util.Map)"><!-- --></A><H3> |
| store</H3> |
| <PRE> |
| boolean <B>store</B>(<A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A>[] metas, |
| <A HREF="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta">QueryMetaData</A>[] queries, |
| <A HREF="../../../../org/apache/openjpa/meta/SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</A>[] seqs, |
| int mode, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A> output)</PRE> |
| <DL> |
| <DD>Store the given metadata. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mode</CODE> - hint about what aspects of the metadata have changed<DD><CODE>output</CODE> - if non-null, rather than storing metadata directly, |
| add entries mapping each output destination such |
| as a <code>File</code> to the planned output for that |
| destination in string form |
| <DT><B>Returns:</B><DD>false if this factory is unable to store metadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="drop(java.lang.Class[], int, java.lang.ClassLoader)"><!-- --></A><H3> |
| drop</H3> |
| <PRE> |
| boolean <B>drop</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>[] cls, |
| int mode, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> envLoader)</PRE> |
| <DL> |
| <DD>Drop the metadata for the given classes in the given mode(s). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>false if any metadata could not be dropped</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDefaults()"><!-- --></A><H3> |
| getDefaults</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/meta/MetaDataDefaults.html" title="interface in org.apache.openjpa.meta">MetaDataDefaults</A> <B>getDefaults</B>()</PRE> |
| <DL> |
| <DD>Return the metadata defaults for this factory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPersistentTypeNames(boolean, java.lang.ClassLoader)"><!-- --></A><H3> |
| getPersistentTypeNames</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A> <B>getPersistentTypeNames</B>(boolean devpath, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> envLoader)</PRE> |
| <DL> |
| <DD>Return all persistent class names, using the metadata locations supplied |
| in configuration, optionally scanning the classpath. |
| Return null if no types are supplied and this factory is unable to scan |
| the classpath. This method should not be used directly by outside |
| code; use <A HREF="../../../../org/apache/openjpa/meta/MetaDataRepository.html#getPersistentTypeNames(boolean, java.lang.ClassLoader)"><CODE>MetaDataRepository.getPersistentTypeNames(boolean, java.lang.ClassLoader)</CODE></A> instead. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/meta/MetaDataRepository.html#getPersistentTypeNames(boolean, java.lang.ClassLoader)"><CODE>MetaDataRepository.getPersistentTypeNames(boolean, java.lang.ClassLoader)</CODE></A>, |
| <A HREF="../../../../org/apache/openjpa/meta/MetaDataRepository.html#loadPersistentTypes(boolean, java.lang.ClassLoader)"><CODE>MetaDataRepository.loadPersistentTypes(boolean, java.lang.ClassLoader)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getQueryScope(java.lang.String, java.lang.ClassLoader)"><!-- --></A><H3> |
| getQueryScope</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>getQueryScope</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> queryName, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> loader)</PRE> |
| <DL> |
| <DD>Return the type defining the given query name, if any. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResultSetMappingScope(java.lang.String, java.lang.ClassLoader)"><!-- --></A><H3> |
| getResultSetMappingScope</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>getResultSetMappingScope</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> resultSetMappingName, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang">ClassLoader</A> loader)</PRE> |
| <DL> |
| <DD>Return the type defining the given result set mapping name, if any. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newClassArgParser()"><!-- --></A><H3> |
| newClassArgParser</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/lib/meta/ClassArgParser.html" title="class in org.apache.openjpa.lib.meta">ClassArgParser</A> <B>newClassArgParser</B>()</PRE> |
| <DL> |
| <DD>Return a properly-configured class arg parser for our expected |
| metadata format. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clear()"><!-- --></A><H3> |
| clear</H3> |
| <PRE> |
| void <B>clear</B>()</PRE> |
| <DL> |
| <DD>Clear any internal caches. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addClassExtensionKeys(java.util.Collection)"><!-- --></A><H3> |
| addClassExtensionKeys</H3> |
| <PRE> |
| void <B>addClassExtensionKeys</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> exts)</PRE> |
| <DL> |
| <DD>Add any extension keys used by this instance to the given set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addFieldExtensionKeys(java.util.Collection)"><!-- --></A><H3> |
| addFieldExtensionKeys</H3> |
| <PRE> |
| void <B>addFieldExtensionKeys</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> exts)</PRE> |
| <DL> |
| <DD>Add any extension keys used by this instance to the given set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadXMLMetaData(org.apache.openjpa.meta.FieldMetaData)"><!-- --></A><H3> |
| loadXMLMetaData</H3> |
| <PRE> |
| void <B>loadXMLMetaData</B>(<A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> fmd)</PRE> |
| <DL> |
| <DD>Load XMLClassMetadata for the given class. Loaded |
| metadata should be added directly to the repository. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <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/MetaDataFactory.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/meta/MetaDataDefaults.html" title="interface in org.apache.openjpa.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/meta/MetaDataInheritanceComparator.html" title="class in org.apache.openjpa.meta"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/meta/MetaDataFactory.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MetaDataFactory.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2010 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
