cayenne-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [CONF] Apache Cayenne Documentation > General Navigation
Date Sun, 27 Dec 2009 14:16:00 GMT
    <base href="">
            <link rel="stylesheet" href="/confluence/s/1519/1/1/_/styles/combined.css?spaceKey=CAYDOC&amp;forWysiwyg=true"
<body style="background-color: white" bgcolor="white">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
     <h2><a href="">General
     <h4>Page <b>edited</b> by             <a href="">Andrus
     <div class="notificationGreySide">
         <h3><a name="GeneralNavigation-GeneralNavigation"></a>General Navigation</h3>

<p>CayenneModeler supports executing commands via its main menu, a button toolbar and
contextual menus that open on right-click. All of the toolbar buttons have corresponding items
in the menu that perform the exact same operation (plus there are operations that are available
via the menu only). If an item or a button action can not be performed in a given context
an item is visually disabled.</p>

<h4><a name="GeneralNavigation-Toolbars"></a>Toolbars</h4>

<p>There is a main toolbar shown below, and a number of object-specific toolbars.</p>

<p><span class="error">Unable to render embedded object: File (modeler-toolbar.png)
not found.</span></p>

<p>The following is a quick reference of the toolbar button functions.</p>

<h5><a name="GeneralNavigation-Project%3A%21iconnew.gif%21%21iconopen.gif%21%21iconsave.gif%21"></a>Project:
<img src="/confluence/download/attachments/10645/icon-new.gif" align="absmiddle" border="0"
/> <img src="/confluence/download/attachments/10645/icon-open.gif" align="absmiddle"
border="0" /> <img src="/confluence/download/attachments/10645/icon-save.gif" align="absmiddle"
border="0" /></h5>

<p>Cayenne Project is a logical deployment unit, that consists of a main project file
(called <tt>cayenne.xml</tt>) and zero or more DataNode (<tt>&#42;.driver.xml</tt>)
and DataMap (<tt>&#42;.map.xml</tt>) XML files. Currently CayenneModeler supports
a single project per running Modeler instance, however multiple instances of Modeler can be
started to edit multiple projects at the same time.</p>

<h5><a name="GeneralNavigation-DataDomain%3A%21icondom.gif%21"></a>DataDomain:
<img src="/confluence/download/attachments/10645/icon-dom.gif" align="absmiddle" border="0"
/>  </h5>

<p>Each DataDomain is an abstraction of a logical data source, possibly spreading multiple
physical databases. cayenne.xml file lists DataDomains present in the project. Most projects
will contain only a single domain. DataDomain button creates a new DataDomain in the currently
open project. </p>

<h5><a name="GeneralNavigation-DataNode%3A%21iconnode.gif%21"></a>DataNode:
<img src="/confluence/download/attachments/10645/icon-node.gif" align="absmiddle" border="0"

<p>DataNode is an object that corresponds to a single physical data source, normally
a database. Currently there are two types of DataNodes: </p>

	<li>Based on DataSource obtained via JNDI from the container (e.g. a WebLogic or Tomcat
	<li>Based on JDBC driver. In this case Cayenne provides its own connection pooling
and other functions expected from a DataSource.</li>

<p>DataNode references zero or more DataMaps defined under DataDomain. </p>

<h5><a name="GeneralNavigation-DataMap%3A%21icondatamap.gif%21"></a>DataMap:
<img src="/confluence/download/attachments/10645/icon-datamap.gif" align="absmiddle" border="0"

<p>DataMap is a collection of Object/Relational mapping information linking Java object
layer with the relational database. DataMaps are created within DataDomains and can be later
linked to DataNodes. </p>

<h5><a name="GeneralNavigation-Entities%3A%21icondbentity.gif%21%21iconobjentity.gif%21"></a>Entities:
<img src="/confluence/download/attachments/10645/icon-dbentity.gif" align="absmiddle" border="0"
/> <img src="/confluence/download/attachments/10645/icon-objentity.gif" align="absmiddle"
border="0" /></h5>

<p>There are two types of entities in Cayenne DataMaps: ObjEntities, reflecting the
structure of the object layer, and DbEntities that describe database tables and views. In
other words, ObjEntity is a descriptor of a persistent Java class, and DbEntity is a descriptor
of a database table or view. Each ObjEntity is based on a DbEntity, but there can be DbEntities
that do not have a corresponding ObjEntity.</p>

<h5><a name="GeneralNavigation-Embeddables%3A%21iconembeddable.gif%21"></a>Embeddables:
<span class="error">Unable to render embedded object: File (icon-embeddable.gif) not

<p>Embeddables are the special kind of mapping objects that allow to map parts of a
DB table as a separate object, allowing to use composition within entities.</p>

<h5><a name="GeneralNavigation-Procedures%3A%21iconstoredprocedure.gif%21"></a>Procedures:
<img src="/confluence/download/attachments/10645/icon-stored-procedure.gif" align="absmiddle"
border="0" /></h5>

<p>Procedure is a decriptor of a database stored procedure. It can be created in the
modeler and later invoked using ProcedureQuery. Note that not all databases support stored
procedures. </p>

<h5><a name="GeneralNavigation-Query%3A%21iconquery.gif%21"></a>Query: <img
src="/confluence/download/attachments/10645/icon-query.gif" align="absmiddle" border="0" /></h5>

<p>Cayenne allows to store queries in the DataMap. There are three types of Cayenne
queries that can be created in the Modeler - object select query, raw SQL query, and procedure
     <div id="commentsSection" class="wiki-content pageSection">
       <div style="float: right;">
            <a href=""
class="grey">Change Notification Preferences</a>

       <a href="">View
       <a href="">View
       <a href=";showCommentArea=true#addcomment">Add

View raw message