Google Git
Sign in
apache / cayenne-website / 017cf03748c43ba409f0544b0c0a0f42b7e1cddc / . / src / main / site / static / docs / 4.0 / api / org / apache / cayenne / map / package-summary.html
blob: 7c6918316e5d73063743124aa9bdb978df70ee0a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_112) on Mon Oct 14 11:36:20 MSK 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.cayenne.map (cayenne-doc: Cayenne Documentation 4.0.2 API)</title>
<meta name="date" content="2019-10-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.cayenne.map (cayenne-doc: Cayenne Documentation 4.0.2 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/cayenne/log/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/cayenne/map/event/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/map/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.cayenne.map</h1>
<div class="docSummary">
<div class="block">Contains O/R mapping classes that store relational database
metadata information and map it to Java classes.</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/cayenne/map/EntityListenerFactory.html" title="interface in org.apache.cayenne.map">EntityListenerFactory</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">since 4.0, as EntityResolver no longer loads listeners from its
DataMaps.</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/EntitySorter.html" title="interface in org.apache.cayenne.map">EntitySorter</a></td>
<td class="colLast">
<div class="block">Defines API for sorting of Cayenne entities based on their mutual dependencies.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/MappingNamespace.html" title="interface in org.apache.cayenne.map">MappingNamespace</a></td>
<td class="colLast">
<div class="block">Defines API of a container of DbEntities, ObjEntities, Procedures, Queries
and other mapping objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</a>&lt;T extends <a href="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</a>,U extends <a href="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">Relationship</a>&gt;</td>
<td class="colLast">
<div class="block">A component in a path chain.</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/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</a></td>
<td class="colLast">
<div class="block">Defines a property descriptor that is a part of an Entity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/CallbackDescriptor.html" title="class in org.apache.cayenne.map">CallbackDescriptor</a></td>
<td class="colLast">
<div class="block">A mapping descriptor of a single callback event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/CallbackMap.html" title="class in org.apache.cayenne.map">CallbackMap</a></td>
<td class="colLast">
<div class="block">A generic descriptor of a set of standard lifecycle callbacks.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a></td>
<td class="colLast">
<div class="block">Stores a collection of related mapping objects that describe database and
object layers of an application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a></td>
<td class="colLast">
<div class="block">A DbAttribute defines a descriptor for a single database table column.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a></td>
<td class="colLast">
<div class="block">A DbEntity is a mapping descriptor that defines a structure of a database
table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a></td>
<td class="colLast">
<div class="block">Defines a join between two attributes of a given relationship.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</a></td>
<td class="colLast">
<div class="block">DbKeyGenerator is an abstraction of a primary key generator It configures the primary
key generation per DbEntity in a RDBMS independent manner.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a></td>
<td class="colLast">
<div class="block">A DbRelationship is a descriptor of a database inter-table relationship based
on one or more primary key/foreign key pairs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/DeleteRule.html" title="class in org.apache.cayenne.map">DeleteRule</a></td>
<td class="colLast">
<div class="block">Defines constants for the possible values of ObjRelationship delete rules.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/DetectedDbEntity.html" title="class in org.apache.cayenne.map">DetectedDbEntity</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map"><code>DbEntity</code></a> subclass used to hold extra JDBC metadata.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/EJBQLQueryDescriptor.html" title="class in org.apache.cayenne.map">EJBQLQueryDescriptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/Embeddable.html" title="class in org.apache.cayenne.map">Embeddable</a></td>
<td class="colLast">
<div class="block">A mapping descriptor of an embeddable class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/EmbeddableAttribute.html" title="class in org.apache.cayenne.map">EmbeddableAttribute</a></td>
<td class="colLast">
<div class="block">A persistent attribute of an embeddable object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html" title="class in org.apache.cayenne.map">EmbeddedAttribute</a></td>
<td class="colLast">
<div class="block">An attribute of the ObjEntity that maps to an embeddable class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</a></td>
<td class="colLast">
<div class="block">An Entity is an abstract descriptor for an entity mapping concept.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</a></td>
<td class="colLast">
<div class="block">A tree structure representing inheritance hierarchy of an ObjEntity and its
subentities.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/EntityListener.html" title="class in org.apache.cayenne.map">EntityListener</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">since 4.0, as EntityResolver no longer loads listeners from its
DataMaps.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a></td>
<td class="colLast">
<div class="block">Represents a virtual shared namespace for zero or more DataMaps.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/EntityResult.html" title="class in org.apache.cayenne.map">EntityResult</a></td>
<td class="colLast">
<div class="block">A metadata object that provides mapping of a set of result columns to an
ObjEntity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/MapLoader.html" title="class in org.apache.cayenne.map">MapLoader</a></td>
<td class="colLast">
<div class="block">Default MapLoader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></td>
<td class="colLast">
<div class="block">An ObjAttribute is a mapping descriptor of a Java class property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a></td>
<td class="colLast">
<div class="block">ObjEntity is a mapping descriptor for a DataObject Java class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a></td>
<td class="colLast">
<div class="block">Describes an association between two Java classes mapped as source and target
ObjEntity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a></td>
<td class="colLast">
<div class="block">A mapping descriptor for a database stored procedure.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/ProcedureParameter.html" title="class in org.apache.cayenne.map">ProcedureParameter</a></td>
<td class="colLast">
<div class="block">A descriptor for the Procedure parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/ProcedureQueryDescriptor.html" title="class in org.apache.cayenne.map">ProcedureQueryDescriptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/QueryDescriptor.html" title="class in org.apache.cayenne.map">QueryDescriptor</a></td>
<td class="colLast">
<div class="block">Generic descriptor of a Cayenne query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/QueryDescriptorLoader.html" title="class in org.apache.cayenne.map">QueryDescriptorLoader</a></td>
<td class="colLast">
<div class="block">A builder that constructs Cayenne queries from abstract configuration information
defined in cayenne-data-map*.dtd.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></td>
<td class="colLast">
<div class="block">Defines a relationship between two entities.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/SelectQueryDescriptor.html" title="class in org.apache.cayenne.map">SelectQueryDescriptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/SQLResult.html" title="class in org.apache.cayenne.map">SQLResult</a></td>
<td class="colLast">
<div class="block">A metadata object that defines how a row in a result set can be converted to
result objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/SQLTemplateDescriptor.html" title="class in org.apache.cayenne.map">SQLTemplateDescriptor</a></td>
<td class="colLast">&nbsp;</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/cayenne/map/JoinType.html" title="enum in org.apache.cayenne.map">JoinType</a></td>
<td class="colLast">
<div class="block">Enumerates supported JOIN types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/map/LifecycleEvent.html" title="enum in org.apache.cayenne.map">LifecycleEvent</a></td>
<td class="colLast">
<div class="block">Defines possible entity object lifecycle events.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.cayenne.map Description">Package org.apache.cayenne.map Description</h2>
<div class="block">Contains O/R mapping classes that store relational database
metadata information and map it to Java classes.</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/cayenne/log/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/cayenne/map/event/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/map/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; 2001&#x2013;2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>