[OFBiz] SVN: r5184 - trunk/website/docs
jonesde at svn.ofbiz.org
jonesde at svn.ofbiz.org
Tue Jun 21 18:59:03 EDT 2005
Author: jonesde
Date: 2005-06-21 17:59:01 -0500 (Tue, 21 Jun 2005)
New Revision: 5184
Modified:
trunk/website/docs/entity.html
Log:
Removed old paragraph, no longer needed as the cache now takes care of this; reported by Dale Key
Modified: trunk/website/docs/entity.html
===================================================================
--- trunk/website/docs/entity.html 2005-06-21 20:26:30 UTC (rev 5183)
+++ trunk/website/docs/entity.html 2005-06-21 22:59:01 UTC (rev 5184)
@@ -31,10 +31,10 @@
href="mailto:jonesde at ofbiz.org">jonesde at ofbiz.org</a></div>
<div class="contenttext">Minor corrections by: <a
href="mailto:PDebski at a4.pl">Pawel H. Debski</a></div>
-<div class="contenttext">Edited by: Les Austin<br>
+<div class="contenttext">Edited by: Les Austin<br/>
Last Updated: August 5, 2004</div>
<!-- $Id$ -->
-<hr class="sepbar">
+<hr class="sepbar"/>
<h3>Table of Contents</h3>
<ul>
<li><a href="#Related_Documents">Related Documents</a> </li>
@@ -46,18 +46,18 @@
<li><a href="#Core_Web_Tools">Core Web Tools</a>
</li>
</ul>
-<hr class="sepbar">
+<hr class="sepbar"/>
<h3><a name="Related_Documents">Related Documents:</a></h3>
-<hr class="sepbar">
+<hr class="sepbar"/>
<ul>
<li><a href="entityconfig.html">Entity Engine Configuration Guide</a></li>
<li><a href="coreconfig.html">Core Configuration Guide</a></li>
<li><a href="../documents.html#JavaDocs">JavaDoc List (Documents Page)</a></li>
<li><a href="../documents.html#XMLDefs">XML File Definitions (Documents Page)</a></li>
</ul>
-<hr class="sepbar">
+<hr class="sepbar"/>
<h3><a name="Introduction">Introduction</a></h3>
-<hr class="sepbar">
+<hr class="sepbar"/>
<p>The Open For Business Entity Engine is a set of tools and patterns
used to
model and manage entity specific data. In this context an entity is a
@@ -184,9 +184,9 @@
data sources like legacy systems over HTTP or messaging services
through a bit of custom coding within the same
framework.</p>
-<hr class="sepbar">
+<hr class="sepbar"/>
<h3><a name="Entity_Modeling">Entity Modeling</a></h3>
-<hr class="sepbar">
+<hr class="sepbar"/>
<p><b>Entity Modeling Files & Locations</b></p>
<p>The first thing to do when starting work with a new entity is to
define or
@@ -255,7 +255,7 @@
description, and
so forth. Here is an example of an XML entity definition:</p>
<pre
- style="border: 1px solid black; background-color: rgb(238, 238, 255); color: black;"> <entity title="Sample Entity"<br> copyright="Copyright (c) 2001 John Doe Enterprises"<br> author="John Doe" version="1.0"<br> package-name="org.ofbiz.commonapp.sample"<br> entity-name="SampleEntity"<br> table-name="SAMPLE_ENTITY"><br> <field name="primaryKeyFieldOne" col-name="PRIMARY_KEY_FIELD_ONE" type="id-ne"></field><br> <field name="primaryKeyFieldTwo" type="id-ne"></field><br> <field name="fieldOne" type="long-varchar"></field><br> <field name="fieldTwo" type="long-varchar"></field><br> <field name="foreignKeyOne" type="id"></field><br> <prim-key field="primaryKeyFieldOne" /><br> <prim-key field="primaryKeyFieldTwo" /><br> <relation type="one" rel-entity-name="OtherSampleEntity"><br> <key-map field-name="foreignKeyOne" rel-field-name="primaryKeyOne" /><br> </relation><br> <relation type="one" title="Self" rel-entity-name="SampleEntity"><br> <key-map field-name="primaryKeyFieldOne" /><br> <key-map field-name="primaryKeyFieldTwo" /><br> </relation><br> <relation type="many" title="AllOne" rel-entity-name="SampleEntity"><br> <key-map field-name="primaryKeyFieldOne" /><br> </relation><br> </entity><br></pre>
+ style="border: 1px solid black; background-color: rgb(238, 238, 255); color: black;"> <entity title="Sample Entity"<br/> copyright="Copyright (c) 2001 John Doe Enterprises"<br/> author="John Doe" version="1.0"<br/> package-name="org.ofbiz.commonapp.sample"<br/> entity-name="SampleEntity"<br/> table-name="SAMPLE_ENTITY"><br/> <field name="primaryKeyFieldOne" col-name="PRIMARY_KEY_FIELD_ONE" type="id-ne"></field><br/> <field name="primaryKeyFieldTwo" type="id-ne"></field><br/> <field name="fieldOne" type="long-varchar"></field><br/> <field name="fieldTwo" type="long-varchar"></field><br/> <field name="foreignKeyOne" type="id"></field><br/> <prim-key field="primaryKeyFieldOne" /><br/> <prim-key field="primaryKeyFieldTwo" /><br/> <relation type="one" rel-entity-name="OtherSampleEntity"><br/> <key-map field-name="foreignKeyOne" rel-field-name="primaryKeyOne" /><br/> </relation><br/> <relation type="one" title="Self" rel-entity-name="SampleEntity"><br/> <key-map field-name="primaryKeyFieldOne" /><br/> <key-map field-name="primaryKeyFieldTwo" /><br/> </relation><br/> <relation type="many" title="AllOne" rel-entity-name="SampleEntity"><br/> <key-map field-name="primaryKeyFieldOne" /><br/> </relation><br/> </entity><br/></pre>
<p>This is a pretty simple entity that demonstrates a few small points.
The meta
data at the top is all optional, and if left unspecified will default
@@ -424,7 +424,7 @@
</tr>
</tbody>
</table>
-<br>
+<br/>
<table border="1" cellpadding="2" cellspacing="0">
<tbody>
<tr>
@@ -485,7 +485,7 @@
</tr>
</tbody>
</table>
-<br>
+<br/>
<table border="1" cellpadding="2" cellspacing="0">
<tbody>
<tr>
@@ -562,7 +562,7 @@
</tr>
</tbody>
</table>
-<br>
+<br/>
<table border="1" cellpadding="2" cellspacing="0">
<tbody>
<tr>
@@ -581,9 +581,9 @@
</tr>
</tbody>
</table>
-<hr class="sepbar">
+<hr class="sepbar"/>
<h3><a name="View_Entity_Modeling">View Entity Modeling</a></h3>
-<hr class="sepbar">
+<hr class="sepbar"/>
<p>In addition to entities that map directly to a single relational
table you can create "virtual" or "view" entities that map to a set of
other entities.
@@ -607,7 +607,7 @@
same entity
group.</p>
<pre
- style="border: 1px solid black; background-color: rgb(238, 238, 255); color: black;"> <view-entity title="Sample View Entity"<br> copyright="Copyright (c) 2001 John Doe Enterprises"<br> author="John Doe" version="1.0"<br> package-name="org.ofbiz.commonapp.sample"<br> entity-name="SampleViewEntity"><br> <member-entity entity-alias="SE" entity-name="SampleEntity" /><br> <member-entity entity-alias="OSE" entity-name="OtherSampleEntity" /><br> <alias entity-alias="SE" name="primaryKeyFieldOne" /><br> <alias entity-alias="SE" name="primaryKeyFieldTwo" /><br> <alias entity-alias="SE" name="fieldOne" /><br> <alias entity-alias="SE" name="fieldTwo" /><br> <alias entity-alias="OSE" name="primaryKeyOne" /><br> <alias entity-alias="OSE" name="otherFieldOne" field="fieldOne" /><br> <view-link entity-alias="SE" rel-entity-alias="OSE"><br> <key-map field-name="foreignKeyOne" rel-field-name="primaryKeyOne" /><br> </view-link><br> <relation type="one" rel-entity-name="OtherSampleEntity"><br> <key-map field-name="primaryKeyOne" /><br> </relation><br> <relation type="many" title="AllOne" rel-entity-name="SampleEntity"><br> <key-map field-name="primaryKeyFieldOne" /><br> </relation><br> </view-entity><br></pre>
+ style="border: 1px solid black; background-color: rgb(238, 238, 255); color: black;"> <view-entity title="Sample View Entity"<br/> copyright="Copyright (c) 2001 John Doe Enterprises"<br/> author="John Doe" version="1.0"<br/> package-name="org.ofbiz.commonapp.sample"<br/> entity-name="SampleViewEntity"><br/> <member-entity entity-alias="SE" entity-name="SampleEntity" /><br/> <member-entity entity-alias="OSE" entity-name="OtherSampleEntity" /><br/> <alias entity-alias="SE" name="primaryKeyFieldOne" /><br/> <alias entity-alias="SE" name="primaryKeyFieldTwo" /><br/> <alias entity-alias="SE" name="fieldOne" /><br/> <alias entity-alias="SE" name="fieldTwo" /><br/> <alias entity-alias="OSE" name="primaryKeyOne" /><br/> <alias entity-alias="OSE" name="otherFieldOne" field="fieldOne" /><br/> <view-link entity-alias="SE" rel-entity-alias="OSE"><br/> <key-map field-name="foreignKeyOne" rel-field-name="primaryKeyOne" /><br/> </view-link><br/> <relation type="one" rel-entity-name="OtherSampleEntity"><br/> <key-map field-name="primaryKeyOne" /><br/> </relation><br/> <relation type="many" title="AllOne" rel-entity-name="SampleEntity"><br/> <key-map field-name="primaryKeyFieldOne" /><br/> </relation><br/> </view-entity><br/></pre>
<p><b>Member Entities</b></p>
<p>Normal entities that will become part of the view entity are
referred to as member entities. Each member entity is given an alias
@@ -780,7 +780,7 @@
</tr>
</tbody>
</table>
-<br>
+<br/>
<table border="1" cellpadding="2" cellspacing="0">
<tbody>
<tr>
@@ -927,7 +927,7 @@
</tr>
</tbody>
</table>
-<br>
+<br/>
<table border="1" cellpadding="2" cellspacing="0">
<tbody>
<tr>
@@ -989,7 +989,7 @@
</tr>
</tbody>
</table>
-<br>
+<br/>
<table border="1" cellpadding="2" cellspacing="0">
<tbody>
<tr>
@@ -1008,9 +1008,9 @@
</tr>
</tbody>
</table>
-<hr class="sepbar">
+<hr class="sepbar"/>
<h3><a name="The_Entity_Engine_API">The Entity Engine API</a></h3>
-<hr class="sepbar">
+<hr class="sepbar"/>
<p>The Entity Engine classes in the package <b>org.ofbiz.entity</b>
define the
API used to interact with Entity Engine entity data. From a users point
@@ -1198,19 +1198,9 @@
Distributed cache clearing is also implemented and can be configured in
a number
of ways using the flexibility of the Service Engine.</p>
-<p>There are some cases where cache entries cannot be automatically
-cleared. The
-most major issue is with view-entities: when an entity that is
-part of a view-entity is updated, it may have only some of the data in
-the primary <span style="font-style: italic;">key </span>or
-<span style="font-style: italic;">and </span>set that was used to find
-and index the cache for that data. There may be a
-way to do this automatically, but for now manually clearing view-entity
-caches
-is still necessary.</p>
-<hr class="sepbar">
+<hr class="sepbar"/>
<h3><a name="JTA_Support">JTA Support</a></h3>
-<hr class="sepbar">
+<hr class="sepbar"/>
<p>The Entity Engine JTA Support is simple to use, but has a few
complications in configuration.
The support runs through an API and a Factory class so that no direct
@@ -1238,9 +1228,9 @@
block and rolling back in each catch block. You can also use the
standard UserTransaction object by getting one from the
TransactionFactory.</p>
-<hr class="sepbar">
+<hr class="sepbar"/>
<h3><a name="Core_Web_Tools">Core Web Tools</a></h3>
-<hr class="sepbar">
+<hr class="sepbar"/>
<p>The WebTools web application contains a number of useful tools for
working
with the entity engine. These include a cross linked reference to the
More information about the Svn
mailing list