Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.3 / apidocs / org / apache / openjpa / jdbc / meta / package-summary.html
blob: bd69852e6b22d1b5ea73d2a691a8920035b8237d [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:13 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.openjpa.jdbc.meta (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="org.apache.openjpa.jdbc.meta (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 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/jdbc/kernel/exps/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/strats/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.openjpa.jdbc.meta</h1>
<div class="docSummary">
<div class="block"><strong>OpenJPA-JDBC ORM Metadata</strong>
This package extends the standard persistence metadata with
object-relational mapping information.</div>
</div>
<p>See:&nbsp;<a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" 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/jdbc/meta/ClassStrategy.html" title="interface in org.apache.openjpa.jdbc.meta">ClassStrategy</a></td>
<td class="colLast">
<div class="block">Mapping from a class to a relational schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/DiscriminatorStrategy.html" title="interface in org.apache.openjpa.jdbc.meta">DiscriminatorStrategy</a></td>
<td class="colLast">
<div class="block">Handles determining the object class of database records.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html" title="interface in org.apache.openjpa.jdbc.meta">Embeddable</a></td>
<td class="colLast">
<div class="block">Interface for field strategies that can managed fields of
embedded-element, embedded-key, and embedded-value objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldStrategy.html" title="interface in org.apache.openjpa.jdbc.meta">FieldStrategy</a></td>
<td class="colLast">
<div class="block">Maps a persistent field to the relational schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/Joinable.html" title="interface in org.apache.openjpa.jdbc.meta">Joinable</a></td>
<td class="colLast">
<div class="block">Represents a value that can be joined to.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingDefaults.html" title="interface in org.apache.openjpa.jdbc.meta">MappingDefaults</a></td>
<td class="colLast">
<div class="block">Generates default names for tables, columns, indexes, constraints, etc.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingInfo.ForeignKeyDefaults.html" title="interface in org.apache.openjpa.jdbc.meta">MappingInfo.ForeignKeyDefaults</a></td>
<td class="colLast">
<div class="block">Supplies default foreign key information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingInfo.TableDefaults.html" title="interface in org.apache.openjpa.jdbc.meta">MappingInfo.TableDefaults</a></td>
<td class="colLast">
<div class="block">Supplies default table information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.ImportExport.html" title="interface in org.apache.openjpa.jdbc.meta">MappingTool.ImportExport</a></td>
<td class="colLast">
<div class="block">Helper used to import and export mapping data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/RelationId.html" title="interface in org.apache.openjpa.jdbc.meta">RelationId</a></td>
<td class="colLast">
<div class="block">Callback to store a relation after the object id has been assigned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta">ReverseCustomizer</a></td>
<td class="colLast">
<div class="block">Plugin in interface to customize the output of the
<a href="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html" title="class in org.apache.openjpa.jdbc.meta"><code>ReverseMappingTool</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html" title="interface in org.apache.openjpa.jdbc.meta">Strategy</a></td>
<td class="colLast">
<div class="block">Interface implemented by all mapping strategies.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</a></td>
<td class="colLast">
<div class="block">Maps a value to a relational schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a></td>
<td class="colLast">
<div class="block">Specialization of value metadata for relational databases.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/VersionStrategy.html" title="interface in org.apache.openjpa.jdbc.meta">VersionStrategy</a></td>
<td class="colLast">
<div class="block">Handles optimistic lock versioning for a class.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" 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/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a></td>
<td class="colLast">
<div class="block">Specialization of metadata for relational databases.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta">ClassMappingInfo</a></td>
<td class="colLast">
<div class="block">Information about the mapping from a class to the schema, in raw form.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/DelegatingJoinable.html" title="class in org.apache.openjpa.jdbc.meta">DelegatingJoinable</a></td>
<td class="colLast">
<div class="block">Delegates to another <a href="../../../../../org/apache/openjpa/jdbc/meta/Joinable.html" title="interface in org.apache.openjpa.jdbc.meta"><code>Joinable</code></a> after doing column
translation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/Discriminator.html" title="class in org.apache.openjpa.jdbc.meta">Discriminator</a></td>
<td class="colLast">
<div class="block">Handles determining the object class of database records.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/DiscriminatorMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta">DiscriminatorMappingInfo</a></td>
<td class="colLast">
<div class="block">Information about the mapping from a discriminator to the schema, in
raw form.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</a></td>
<td class="colLast">
<div class="block">Specialization of metadata for relational databases.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta">FieldMappingInfo</a></td>
<td class="colLast">
<div class="block">Information about the mapping from a field to the schema, in raw form.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/JavaSQLTypes.html" title="class in org.apache.openjpa.jdbc.meta">JavaSQLTypes</a></td>
<td class="colLast">
<div class="block">Java SQL type constants.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingDefaultsImpl.html" title="class in org.apache.openjpa.jdbc.meta">MappingDefaultsImpl</a></td>
<td class="colLast">
<div class="block">Default implementation of <a href="../../../../../org/apache/openjpa/jdbc/meta/MappingDefaults.html" title="interface in org.apache.openjpa.jdbc.meta"><code>MappingDefaults</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingInfo.html" title="class in org.apache.openjpa.jdbc.meta">MappingInfo</a></td>
<td class="colLast">
<div class="block">Base class storing raw mapping information; defines utility methods for
converting raw mapping information to full mapping to the schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</a></td>
<td class="colLast">
<div class="block">Repository of object/relational mapping information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingStrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta">MappingStrategyInstaller</a></td>
<td class="colLast">
<div class="block">Installer used during mapping that attempts to use the given mapping
information (if any), and fails if it does not work.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html" title="class in org.apache.openjpa.jdbc.meta">MappingTool</a></td>
<td class="colLast">
<div class="block">Tool for manipulating class mappings and associated schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">MappingTool.Flags</a></td>
<td class="colLast">
<div class="block">Run flags.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/MetaDataPlusMappingFactory.html" title="class in org.apache.openjpa.jdbc.meta">MetaDataPlusMappingFactory</a></td>
<td class="colLast">
<div class="block">Combines two internal <a href="../../../../../org/apache/openjpa/meta/MetaDataFactory.html" title="interface in org.apache.openjpa.meta"><code>MetaDataFactory</code></a> instances -- one for
metadata, one for mappings -- into a single <a href="../../../../../org/apache/openjpa/meta/MetaDataFactory.html" title="interface in org.apache.openjpa.meta"><code>MetaDataFactory</code></a> facade.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/NoneMappingDefaults.html" title="class in org.apache.openjpa.jdbc.meta">NoneMappingDefaults</a></td>
<td class="colLast">
<div class="block">No-op mapping defaults.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/NoneStrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta">NoneStrategyInstaller</a></td>
<td class="colLast">
<div class="block">Clears all mapping information from classes and installs none strategies.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/PropertiesReverseCustomizer.html" title="class in org.apache.openjpa.jdbc.meta">PropertiesReverseCustomizer</a></td>
<td class="colLast">
<div class="block">Simple <a href="../../../../../org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta"><code>ReverseCustomizer</code></a> that uses a properties file to
to allow customization of basic class and field properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/QueryResultMapping.html" title="class in org.apache.openjpa.jdbc.meta">QueryResultMapping</a></td>
<td class="colLast">
<div class="block">Mapping of a query result set to scalar and/or persistence-capable
object-level values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/RefreshStrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta">RefreshStrategyInstaller</a></td>
<td class="colLast">
<div class="block">Attempts to install using the given mapping information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html" title="class in org.apache.openjpa.jdbc.meta">ReverseMappingTool</a></td>
<td class="colLast">
<div class="block">Reverse-maps a schema into class mappings and the associated java
code.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">ReverseMappingTool.Flags</a></td>
<td class="colLast">
<div class="block">Holder for run flags.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/RuntimeStrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta">RuntimeStrategyInstaller</a></td>
<td class="colLast">
<div class="block">Installer that attempts to use the given mapping information, and
fails if it does not work.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/SequenceMapping.html" title="class in org.apache.openjpa.jdbc.meta">SequenceMapping</a></td>
<td class="colLast">
<div class="block">Specialization of sequence metadata for ORM.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/StrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta">StrategyInstaller</a></td>
<td class="colLast">
<div class="block">Installs mapping strategies.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingImpl.html" title="class in org.apache.openjpa.jdbc.meta">ValueMappingImpl</a></td>
<td class="colLast">
<div class="block">Standalone <a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta"><code>ValueMapping</code></a> implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta">ValueMappingInfo</a></td>
<td class="colLast">
<div class="block">Information about the mapping from a field value to the schema, in
raw form.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/Version.html" title="class in org.apache.openjpa.jdbc.meta">Version</a></td>
<td class="colLast">
<div class="block">Handles optimistic lock versioning for a class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/meta/VersionMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta">VersionMappingInfo</a></td>
<td class="colLast">
<div class="block">Information about the mapping from a version indicator to the schema, in
raw form.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!-- -->
</a>
<h2 title="Package org.apache.openjpa.jdbc.meta Description">Package org.apache.openjpa.jdbc.meta Description</h2>
<div class="block"><p><strong>OpenJPA-JDBC ORM Metadata</strong></p>
<p>
This package extends the standard persistence metadata with
object-relational mapping information.
</p></div>
</div>
<!-- ======= 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 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/jdbc/kernel/exps/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/strats/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>