blob: 7a3c052f6326929ce4f8d9a144b10e251c0c4e26 [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 (1.8.0_171) on Thu Jun 14 10:06:17 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.openjpa.meta (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.openjpa.meta (OpenJPA Parent POM 3.0.0 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>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/lib/xml/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/openjpa/persistence/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/meta/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.openjpa.meta</h1>
<div class="docSummary">
<div class="block"><strong>OpenJPA Metadata</strong>
This package provides an extendable framework for parsing and caching
persistence metadata.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/AbstractCFMetaDataFactory.Parser.html" title="interface in org.apache.openjpa.meta">AbstractCFMetaDataFactory.Parser</a></td>
<td class="colLast">
<div class="block">Internal parser interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/AbstractCFMetaDataFactory.Serializer.html" title="interface in org.apache.openjpa.meta">AbstractCFMetaDataFactory.Serializer</a></td>
<td class="colLast">
<div class="block">Internal serializer interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a></td>
<td class="colLast">
<div class="block">Allows us to access configuration through metadata in a generic way.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MetaDataDefaults.html" title="interface in org.apache.openjpa.meta">MetaDataDefaults</a></td>
<td class="colLast">
<div class="block">Populates new metadata with default values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html" title="interface in org.apache.openjpa.meta">MetaDataFactory</a></td>
<td class="colLast">
<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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></td>
<td class="colLast">
<div class="block">Mode constants used to track the initialization status of metadata.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/Order.html" title="interface in org.apache.openjpa.meta">Order</a></td>
<td class="colLast">
<div class="block">Order a field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/SequenceMetaData.SequenceFactory.html" title="interface in org.apache.openjpa.meta">SequenceMetaData.SequenceFactory</a></td>
<td class="colLast">
<div class="block">Allow facades to supply adapters from a spec sequence type to the
OpenJPA sequence type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></td>
<td class="colLast">
<div class="block">Holds metadata on a value; this could be a field value, key value, or
element value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a></td>
<td class="colLast">
<div class="block">Describe metadata about an xml type.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/AbstractCFMetaDataFactory.html" title="class in org.apache.openjpa.meta">AbstractCFMetaDataFactory</a></td>
<td class="colLast">
<div class="block">Base class for factory implementations built around XML metadata files
in the common format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/AbstractMetaDataDefaults.html" title="class in org.apache.openjpa.meta">AbstractMetaDataDefaults</a></td>
<td class="colLast">
<div class="block">Abstract implementation provides a set of generic utilities for detecting
persistence meta-data of Field/Member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/AbstractMetaDataFactory.html" title="class in org.apache.openjpa.meta">AbstractMetaDataFactory</a></td>
<td class="colLast">
<div class="block">Abstract <a href="../../../../org/apache/openjpa/meta/MetaDataFactory.html" title="interface in org.apache.openjpa.meta"><code>MetaDataFactory</code></a> that provides default implementations
of many methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/AccessCode.html" title="class in org.apache.openjpa.meta">AccessCode</a></td>
<td class="colLast">
<div class="block">Represents access styles for members of a class and field through a
5-bit integer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a></td>
<td class="colLast">
<div class="block">Contains metadata about a persistent type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/DelegatingMetaDataFactory.html" title="class in org.apache.openjpa.meta">DelegatingMetaDataFactory</a></td>
<td class="colLast">
<div class="block">Base class for factory instances that use a delegate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a></td>
<td class="colLast">
<div class="block">Vendor extensions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a></td>
<td class="colLast">
<div class="block">Captures fetch group meta-data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></td>
<td class="colLast">
<div class="block">Metadata for a managed class field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/FieldMetaData.MemberProvider.html" title="class in org.apache.openjpa.meta">FieldMetaData.MemberProvider</a></td>
<td class="colLast">
<div class="block">Serializable wrapper around a <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect"><code>Method</code></a> or <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect"><code>Field</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/InheritanceComparator.html" title="class in org.apache.openjpa.meta">InheritanceComparator</a></td>
<td class="colLast">
<div class="block">Comparator that keeps classes in inheritance order.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/JavaTypes.html" title="class in org.apache.openjpa.meta">JavaTypes</a></td>
<td class="colLast">
<div class="block">Type constants for managed fields.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html" title="class in org.apache.openjpa.meta">LifecycleMetaData</a></td>
<td class="colLast">
<div class="block">Information about lifecycle events for a managed type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MetaDataInheritanceComparator.html" title="class in org.apache.openjpa.meta">MetaDataInheritanceComparator</a></td>
<td class="colLast">
<div class="block">Comparator that keeps metadatas in inheritance order.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a></td>
<td class="colLast">
<div class="block">Repository of and factory for persistent metadata.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MetaDataTool.html" title="class in org.apache.openjpa.meta">MetaDataTool</a></td>
<td class="colLast">
<div class="block">Tool for generating default metadata.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MetaDataTool.Flags.html" title="class in org.apache.openjpa.meta">MetaDataTool.Flags</a></td>
<td class="colLast">
<div class="block">Run flags.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MultiQueryMetaData.html" title="class in org.apache.openjpa.meta">MultiQueryMetaData</a></td>
<td class="colLast">
<div class="block">Extends <a href="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta"><code>QueryMetaData</code></a> to allow multiple <a href="../../../../org/apache/openjpa/meta/QueryMetaData.html#getResultType--"><code>result class</code></a> or
<a href="../../../../org/apache/openjpa/meta/QueryMetaData.html#getResultSetMappingName--"><code>mapping names</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MultiQueryMetaData.Parameter.html" title="class in org.apache.openjpa.meta">MultiQueryMetaData.Parameter</a></td>
<td class="colLast">
<div class="block">A parameter</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/NoneMetaDataFactory.html" title="class in org.apache.openjpa.meta">NoneMetaDataFactory</a></td>
<td class="colLast">
<div class="block">No-op metadata I/O to prevent attempts to load other classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/NonPersistentMetaData.html" title="class in org.apache.openjpa.meta">NonPersistentMetaData</a></td>
<td class="colLast">
<div class="block">Metadata about a persistence-aware type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta">QueryMetaData</a></td>
<td class="colLast">
<div class="block">Holds metadata about named queries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</a></td>
<td class="colLast">
<div class="block">Metadata about a named sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/UpdateStrategies.html" title="class in org.apache.openjpa.meta">UpdateStrategies</a></td>
<td class="colLast">
<div class="block">Strategies for persistent value updates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/ValueMetaDataImpl.html" title="class in org.apache.openjpa.meta">ValueMetaDataImpl</a></td>
<td class="colLast">
<div class="block">Default <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta"><code>ValueMetaData</code></a> implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/ValueStrategies.html" title="class in org.apache.openjpa.meta">ValueStrategies</a></td>
<td class="colLast">
<div class="block">Strategies for persistent value generation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/XMLClassMetaData.html" title="class in org.apache.openjpa.meta">XMLClassMetaData</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/XMLFieldMetaData.html" title="class in org.apache.openjpa.meta">XMLFieldMetaData</a></td>
<td class="colLast">
<div class="block">Contains metadata about an xml element or attribute</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/meta/MultiQueryMetaData.Parameter.Mode.html" title="enum in org.apache.openjpa.meta">MultiQueryMetaData.Parameter.Mode</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.openjpa.meta Description">Package org.apache.openjpa.meta Description</h2>
<div class="block"><p><strong>OpenJPA Metadata</strong></p>
<p>
This package provides an extendable framework for parsing and caching
persistence metadata. The metadata can be accessed at both enhancement
time and at runtime.
</p></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/lib/xml/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/openjpa/persistence/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/meta/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
<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>