Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.3.0 / apidocs / org / apache / openjpa / persistence / meta / package-summary.html
blob: 29ad873217762f0da7c82609b85c5601c42da726 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Thu Nov 21 14:32:54 CET 2013 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
org.apache.openjpa.persistence.meta (OpenJPA Parent POM 2.3.0 API)
</TITLE>
<META NAME="date" CONTENT="2013-11-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.openjpa.persistence.meta (OpenJPA Parent POM 2.3.0 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/jest/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/osgi/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/openjpa/persistence/meta/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package org.apache.openjpa.persistence.meta
</H2>
<strong>OpenJPA MetaModel</strong>
This package provides an implementation of Metamodel API of JPA 2.0 Specification.
<P>
<B>See:</B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.Filter.html" title="interface in org.apache.openjpa.persistence.meta">AbstractManagedType.Filter&lt;T&gt;</A></B></TD>
<TD>Affirms if a given element satisfy a condition.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/MetadataProcessor.html" title="interface in org.apache.openjpa.persistence.meta">MetadataProcessor&lt;T,M&gt;</A></B></TD>
<TD>Collection of generic utility functions for extracting persistence related
metadata from user specified metadata available in various source
environment.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType&lt;X&gt;</A></B></TD>
<TD>Implements the managed persistent type and its attributes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.AttributeNameFilter.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType.AttributeNameFilter&lt;X&gt;</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.AttributeTypeFilter.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType.AttributeTypeFilter&lt;X,Y&gt;</A></B></TD>
<TD>Selects if the attribute type matches the given Java class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.DeclaredAttributeFilter.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType.DeclaredAttributeFilter&lt;X&gt;</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.ElementTypeFilter.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType.ElementTypeFilter&lt;X,E&gt;</A></B></TD>
<TD>Selects plural attribute of given element type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.EntryTypeFilter.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType.EntryTypeFilter&lt;X,K,V&gt;</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.IdAttributeFilter.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType.IdAttributeFilter&lt;X&gt;</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.PluralCategoryFilter.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType.PluralCategoryFilter&lt;X&gt;</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.SingularAttributeFilter.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType.SingularAttributeFilter&lt;X&gt;</A></B></TD>
<TD>Affirms if the given attribute is a Singular attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AbstractManagedType.VersionAttributeFilter.html" title="class in org.apache.openjpa.persistence.meta">AbstractManagedType.VersionAttributeFilter&lt;X&gt;</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/AnnotationProcessor6.html" title="class in org.apache.openjpa.persistence.meta">AnnotationProcessor6</A></B></TD>
<TD>Annotation processing tool generates source code for a meta-model class given
the annotated source code of persistent entity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/CompileTimeLogger.html" title="class in org.apache.openjpa.persistence.meta">CompileTimeLogger</A></B></TD>
<TD>Simple logger sets log level from javac compilers annotation processing
options <code>-Alog=TRACE|INFO|WARN|ERROR</code> and uses the processing
environment to determine the log output stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.html" title="class in org.apache.openjpa.persistence.meta">Members</A></B></TD>
<TD>Persistent attribute according to JPA 2.0 metamodel.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.CollectionAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta">Members.CollectionAttributeImpl&lt;X,E&gt;</A></B></TD>
<TD>Represents attributes declared as java.util.Collection&lt;E&gt;.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.KeyAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta">Members.KeyAttributeImpl&lt;X,K&gt;</A></B></TD>
<TD>Represents the keys of java.util.Map&lt;K,V&gt; in managed type &lt;X&gt; as a pseudo-attribute of type
java.util.Set&lt;K&gt;.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.ListAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta">Members.ListAttributeImpl&lt;X,E&gt;</A></B></TD>
<TD>Represents attributes declared as java.util.List&lt;E&gt;.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.MapAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta">Members.MapAttributeImpl&lt;X,K,V&gt;</A></B></TD>
<TD>Represents attributes declared as java.util.Map&lt;K,V&gt; in managed type &lt;X&gt;.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.Member.html" title="class in org.apache.openjpa.persistence.meta">Members.Member&lt;X,Y&gt;</A></B></TD>
<TD>An attribute of a Java type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.PluralAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta">Members.PluralAttributeImpl&lt;X,C,E&gt;</A></B></TD>
<TD>Root of multi-cardinality attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.SetAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta">Members.SetAttributeImpl&lt;X,E&gt;</A></B></TD>
<TD>Represents attributes declared as java.util.Set&lt;E&gt;.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Members.SingularAttributeImpl.html" title="class in org.apache.openjpa.persistence.meta">Members.SingularAttributeImpl&lt;X,T&gt;</A></B></TD>
<TD>Represents single-valued persistent attributes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/MetamodelImpl.html" title="class in org.apache.openjpa.persistence.meta">MetamodelImpl</A></B></TD>
<TD>Adapts JPA Metamodel to OpenJPA meta-data repository.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/SourceAnnotationHandler.html" title="class in org.apache.openjpa.persistence.meta">SourceAnnotationHandler</A></B></TD>
<TD>Extracts persistent metadata information by analyzing available annotation
in *.java source files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Types.html" title="class in org.apache.openjpa.persistence.meta">Types</A></B></TD>
<TD>Persistent Type according to JPA 2.0.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Types.Basic.html" title="class in org.apache.openjpa.persistence.meta">Types.Basic&lt;X&gt;</A></B></TD>
<TD>Basic non-relational types of a persistent attribute such as <code>long</code> or
<code>java.util.Date</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Types.Embeddable.html" title="class in org.apache.openjpa.persistence.meta">Types.Embeddable&lt;X&gt;</A></B></TD>
<TD>An embedded, not independently identifiable type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Types.Entity.html" title="class in org.apache.openjpa.persistence.meta">Types.Entity&lt;X&gt;</A></B></TD>
<TD>An entity type that is independently identifiable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Types.Identifiable.html" title="class in org.apache.openjpa.persistence.meta">Types.Identifiable&lt;X&gt;</A></B></TD>
<TD>Represents an abstract persistent type that has a persistent identity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Types.MappedSuper.html" title="class in org.apache.openjpa.persistence.meta">Types.MappedSuper&lt;X&gt;</A></B></TD>
<TD>A abstract, independently identifiable persistent type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/openjpa/persistence/meta/Types.PseudoEntity.html" title="class in org.apache.openjpa.persistence.meta">Types.PseudoEntity&lt;X&gt;</A></B></TD>
<TD>A pseudo managed type used to represent keys of a java.util.Map as a
pseudo attribute.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<A NAME="package_description"><!-- --></A><H2>
Package org.apache.openjpa.persistence.meta Description
</H2>
<P>
<p><strong>OpenJPA MetaModel</strong></p>
<p>
This package provides an implementation of Metamodel API of JPA 2.0 Specification.
</p>
<P>
<P>
<DL>
</DL>
<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>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/jest/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/osgi/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/openjpa/persistence/meta/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2006&#x2013;2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.
</BODY>
</HTML>