Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.3 / apidocs / org / apache / openjpa / meta / MetaDataFactory.html
blob: 0fcb7c5c47e5d7ffc2f51a79bb779af5406f52cc [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:01 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MetaDataFactory (OpenJPA Parent POM 2.4.3 API)</title>
<meta name="date" content="2018-06-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MetaDataFactory (OpenJPA Parent POM 2.4.3 API)";
}
//-->
</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/MetaDataFactory.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/meta/MetaDataDefaults.html" title="interface in org.apache.openjpa.meta"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/meta/MetaDataInheritanceComparator.html" title="class in org.apache.openjpa.meta"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/meta/MetaDataFactory.html" target="_top">Frames</a></li>
<li><a href="MetaDataFactory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.openjpa.meta</div>
<h2 title="Interface MetaDataFactory" class="title">Interface MetaDataFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<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>
<br>
<pre>public interface <span class="strong">MetaDataFactory</span>
extends <a href="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Patrick Linskey, Abe White, Pinaki Poddar</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#STORE_DEFAULT">STORE_DEFAULT</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#STORE_PER_CLASS">STORE_PER_CLASS</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#STORE_VERBOSE">STORE_VERBOSE</a></strong></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.meta.MetaDataModes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.meta.<a href="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></h3>
<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></li>
</ul>
</li>
</ul>
<!-- ========== 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">&nbsp;</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#addClassExtensionKeys(java.util.Collection)">addClassExtensionKeys</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;?&gt;&nbsp;exts)</code>
<div class="block">Add any extension keys used by this instance to the given set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#addFieldExtensionKeys(java.util.Collection)">addFieldExtensionKeys</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;?&gt;&nbsp;exts)</code>
<div class="block">Add any extension keys used by this instance to the given set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#clear()">clear</a></strong>()</code>
<div class="block">Clear any internal caches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#drop(java.lang.Class[],%20int,%20java.lang.ClassLoader)">drop</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;cls,
int&nbsp;mode,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;envLoader)</code>
<div class="block">Drop the metadata for the given classes in the given mode(s).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/MetaDataDefaults.html" title="interface in org.apache.openjpa.meta">MetaDataDefaults</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getDefaults()">getDefaults</a></strong>()</code>
<div class="block">Return the metadata defaults for this factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getManagedClass(java.lang.Class)">getManagedClass</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;c)</code>
<div class="block">Gets the managed class corresponding to the given meta-class.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getManagedClassName(java.lang.String)">getManagedClassName</a></strong>(<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;metamodelClassName)</code>
<div class="block">Gets the name of the managed class for the given fully-qualified
meta-model class name.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getMetaModelClassName(java.lang.String)">getMetaModelClassName</a></strong>(<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;managedClassName)</code>
<div class="block">Gets the name of the meta-model class for the given fully-qualified
managed class name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getPersistentTypeNames(boolean,%20java.lang.ClassLoader)">getPersistentTypeNames</a></strong>(boolean&nbsp;devpath,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;envLoader)</code>
<div class="block">Return all persistent class names, using the metadata locations supplied
in configuration, optionally scanning the classpath.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getQueryScope(java.lang.String,%20java.lang.ClassLoader)">getQueryScope</a></strong>(<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;queryName,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</code>
<div class="block">Return the type defining the given query name, if any.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#getResultSetMappingScope(java.lang.String,%20java.lang.ClassLoader)">getResultSetMappingScope</a></strong>(<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;resultSetMappingName,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</code>
<div class="block">Return the type defining the given result set mapping name, if any.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#isMetaClass(java.lang.Class)">isMetaClass</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;c)</code>
<div class="block">Affirms if the given class is a meta-class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#load(java.lang.Class,%20int,%20java.lang.ClassLoader)">load</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls,
int&nbsp;mode,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;envLoader)</code>
<div class="block">Load metadata for the given class in the given mode(s).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#loadXMLMetaData(java.lang.Class)">loadXMLMetaData</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls)</code>
<div class="block">Load XMLClassMetadata for the given class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/lib/meta/ClassArgParser.html" title="class in org.apache.openjpa.lib.meta">ClassArgParser</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#newClassArgParser()">newClassArgParser</a></strong>()</code>
<div class="block">Return a properly-configured class arg parser for our expected
metadata format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#setRepository(org.apache.openjpa.meta.MetaDataRepository)">setRepository</a></strong>(<a href="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a>&nbsp;repos)</code>
<div class="block">Set the repository to load metadata into.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#setStoreDirectory(java.io.File)">setStoreDirectory</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;dir)</code>
<div class="block">Base directory for storing metadata.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#setStoreMode(int)">setStoreMode</a></strong>(int&nbsp;store)</code>
<div class="block">Storage mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#setStrict(boolean)">setStrict</a></strong>(boolean&nbsp;strict)</code>
<div class="block">If true, I/O's must exactly obey the mode directives given, and may
not load additional information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html#store(org.apache.openjpa.meta.ClassMetaData[],%20org.apache.openjpa.meta.QueryMetaData[],%20org.apache.openjpa.meta.SequenceMetaData[],%20int,%20java.util.Map)">store</a></strong>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[]&nbsp;metas,
<a href="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta">QueryMetaData</a>[]&nbsp;queries,
<a href="../../../../org/apache/openjpa/meta/SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</a>[]&nbsp;seqs,
int&nbsp;mode,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>,<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>&gt;&nbsp;output)</code>
<div class="block">Store the given metadata.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="STORE_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STORE_DEFAULT</h4>
<pre>static final&nbsp;int STORE_DEFAULT</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.MetaDataFactory.STORE_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="STORE_PER_CLASS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STORE_PER_CLASS</h4>
<pre>static final&nbsp;int STORE_PER_CLASS</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.MetaDataFactory.STORE_PER_CLASS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="STORE_VERBOSE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>STORE_VERBOSE</h4>
<pre>static final&nbsp;int STORE_VERBOSE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.MetaDataFactory.STORE_VERBOSE">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setRepository(org.apache.openjpa.meta.MetaDataRepository)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRepository</h4>
<pre>void&nbsp;setRepository(<a href="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a>&nbsp;repos)</pre>
<div class="block">Set the repository to load metadata into.
This method will be called before use.</div>
</li>
</ul>
<a name="setStoreDirectory(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStoreDirectory</h4>
<pre>void&nbsp;setStoreDirectory(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;dir)</pre>
<div class="block">Base directory for storing metadata. May not be called.</div>
</li>
</ul>
<a name="setStoreMode(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStoreMode</h4>
<pre>void&nbsp;setStoreMode(int&nbsp;store)</pre>
<div class="block">Storage mode. May not be called.</div>
</li>
</ul>
<a name="setStrict(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStrict</h4>
<pre>void&nbsp;setStrict(boolean&nbsp;strict)</pre>
<div class="block">If true, I/O's must exactly obey the mode directives given, and may
not load additional information.</div>
</li>
</ul>
<a name="load(java.lang.Class, int, java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>load</h4>
<pre>void&nbsp;load(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls,
int&nbsp;mode,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;envLoader)</pre>
<div class="block">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>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><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</dd></dl>
</li>
</ul>
<a name="store(org.apache.openjpa.meta.ClassMetaData[], org.apache.openjpa.meta.QueryMetaData[], org.apache.openjpa.meta.SequenceMetaData[], int, java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>store</h4>
<pre>boolean&nbsp;store(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[]&nbsp;metas,
<a href="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta">QueryMetaData</a>[]&nbsp;queries,
<a href="../../../../org/apache/openjpa/meta/SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</a>[]&nbsp;seqs,
int&nbsp;mode,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>,<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>&gt;&nbsp;output)</pre>
<div class="block">Store the given metadata.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - hint about what aspects of the metadata have changed</dd><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</dd>
<dt><span class="strong">Returns:</span></dt><dd>false if this factory is unable to store metadata</dd></dl>
</li>
</ul>
<a name="drop(java.lang.Class[], int, java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drop</h4>
<pre>boolean&nbsp;drop(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;cls,
int&nbsp;mode,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;envLoader)</pre>
<div class="block">Drop the metadata for the given classes in the given mode(s).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>false if any metadata could not be dropped</dd></dl>
</li>
</ul>
<a name="getDefaults()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaults</h4>
<pre><a href="../../../../org/apache/openjpa/meta/MetaDataDefaults.html" title="interface in org.apache.openjpa.meta">MetaDataDefaults</a>&nbsp;getDefaults()</pre>
<div class="block">Return the metadata defaults for this factory.</div>
</li>
</ul>
<a name="getPersistentTypeNames(boolean, java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPersistentTypeNames</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;&nbsp;getPersistentTypeNames(boolean&nbsp;devpath,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;envLoader)</pre>
<div class="block">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,%20java.lang.ClassLoader)"><code>MetaDataRepository.getPersistentTypeNames(boolean, java.lang.ClassLoader)</code></a> instead.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/meta/MetaDataRepository.html#getPersistentTypeNames(boolean,%20java.lang.ClassLoader)"><code>MetaDataRepository.getPersistentTypeNames(boolean, java.lang.ClassLoader)</code></a>,
<a href="../../../../org/apache/openjpa/meta/MetaDataRepository.html#loadPersistentTypes(boolean,%20java.lang.ClassLoader)"><code>MetaDataRepository.loadPersistentTypes(boolean, java.lang.ClassLoader)</code></a></dd></dl>
</li>
</ul>
<a name="getQueryScope(java.lang.String, java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryScope</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;getQueryScope(<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;queryName,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</pre>
<div class="block">Return the type defining the given query name, if any.</div>
</li>
</ul>
<a name="getResultSetMappingScope(java.lang.String, java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultSetMappingScope</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;getResultSetMappingScope(<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;resultSetMappingName,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</pre>
<div class="block">Return the type defining the given result set mapping name, if any.</div>
</li>
</ul>
<a name="newClassArgParser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newClassArgParser</h4>
<pre><a href="../../../../org/apache/openjpa/lib/meta/ClassArgParser.html" title="class in org.apache.openjpa.lib.meta">ClassArgParser</a>&nbsp;newClassArgParser()</pre>
<div class="block">Return a properly-configured class arg parser for our expected
metadata format.</div>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>void&nbsp;clear()</pre>
<div class="block">Clear any internal caches.</div>
</li>
</ul>
<a name="addClassExtensionKeys(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addClassExtensionKeys</h4>
<pre>void&nbsp;addClassExtensionKeys(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;?&gt;&nbsp;exts)</pre>
<div class="block">Add any extension keys used by this instance to the given set.</div>
</li>
</ul>
<a name="addFieldExtensionKeys(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFieldExtensionKeys</h4>
<pre>void&nbsp;addFieldExtensionKeys(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;?&gt;&nbsp;exts)</pre>
<div class="block">Add any extension keys used by this instance to the given set.</div>
</li>
</ul>
<a name="loadXMLMetaData(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadXMLMetaData</h4>
<pre>void&nbsp;loadXMLMetaData(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls)</pre>
<div class="block">Load XMLClassMetadata for the given class. Loaded
metadata should be added directly to the repository.</div>
</li>
</ul>
<a name="getMetaModelClassName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetaModelClassName</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>&nbsp;getMetaModelClassName(<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;managedClassName)</pre>
<div class="block">Gets the name of the meta-model class for the given fully-qualified
managed class name.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0.0</dd></dl>
</li>
</ul>
<a name="getManagedClassName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManagedClassName</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>&nbsp;getManagedClassName(<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;metamodelClassName)</pre>
<div class="block">Gets the name of the managed class for the given fully-qualified
meta-model class name.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0.0</dd></dl>
</li>
</ul>
<a name="isMetaClass(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMetaClass</h4>
<pre>boolean&nbsp;isMetaClass(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;c)</pre>
<div class="block">Affirms if the given class is a meta-class.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0.0</dd></dl>
</li>
</ul>
<a name="getManagedClass(java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getManagedClass</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;getManagedClass(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;c)</pre>
<div class="block">Gets the managed class corresponding to the given meta-class.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>null if the given input is not a meta-class.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.0.0</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><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/MetaDataFactory.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/meta/MetaDataDefaults.html" title="interface in org.apache.openjpa.meta"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/meta/MetaDataInheritanceComparator.html" title="class in org.apache.openjpa.meta"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/meta/MetaDataFactory.html" target="_top">Frames</a></li>
<li><a href="MetaDataFactory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>