You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ba...@apache.org on 2002/04/01 12:19:39 UTC
cvs commit: jakarta-commons-sandbox/simplestore/docs developers-guide.html users-guide.html
baliuka 02/04/01 02:19:39
Modified: simplestore/docs users-guide.html
Added: simplestore/docs developers-guide.html
Log:
Added developers guide
Revision Changes Path
1.5 +39 -12 jakarta-commons-sandbox/simplestore/docs/users-guide.html
Index: users-guide.html
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/simplestore/docs/users-guide.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- users-guide.html 31 Mar 2002 22:13:50 -0000 1.4
+++ users-guide.html 1 Apr 2002 10:19:39 -0000 1.5
@@ -10,9 +10,31 @@
</style>
</head>
<body link='navy' alink='navy' vlink='navy'>
-
+ <a href="http://jakarta.apache.org">
+ <img src="http://jakarta.apache.org/images/jakarta-logo.gif" border="0"/></a>
<center><h2 style='color:navy'> SimpleStore Users Guide</h2></center>
- <h3>What is SimpleStore ?</h3>
+ <a name='toc'><h3>Table of Contents</h3></a>
+<ul>
+ <li><a href='#about'>About this Guide</a></li>
+ <li><a href='#whatis'>What is SimpleStore ?</a></li>
+ <li><a href='#whatcan'>What can SimpleStore do for me ?</a></li>
+ <li><a href='#pmf'>PersitenceManagerFactory</a></li>
+ <li><a href='#pm'>PersitenceManager</a></li>
+ <li><a href='#transaction'>Transaction</a></li>
+ <li><a href='#id'>Identity</a></li>
+ <li><a href='#state'>State</a></li>
+ <li><a href='#cache'>Cache</a></li>
+ <li><a href='#validation'>Validation</a></li>
+ <li><a href='#security'>Security</a></li>
+ <li><a href='developers-guide.html'>Developers Guide </a></li>
+ <li><a href='api/index.html'>API</a></li>
+</ul>
+ <a name='about'><h3>About this Guide</h3></a>
+ The SimpleStore User Guide is intended to help bean providers get acquainted with Simplestore.
+ <br>
+ Thanks for choosing Simplestore!
+
+ <a name='whatis'><h3>What is SimpleStore ?</h3></a>
<p>
SimpleStore is customizable persistence framework.
It defines interfaces for Transparent Persistence and provides reference implementation.
@@ -26,7 +48,7 @@
It is useful if you will decide to make your objects Distributed.
See Apache's AltRMI for more information on Transparent Distribution implementation.
</p>
-<h3>What can SimpleStore do for me ?</h3>
+<a name='whatcan'><h3>What can SimpleStore do for me ?</h3></a>
<p>
You can use it to implement persistency aspect in your web application,
or object model, you can use it as service for your server like
@@ -35,7 +57,7 @@
SimpleStore is Open Source and you can use it in commercial projects, see Apache
<a href='http://www.apache.org/foundation/licence-FAQ.htm'> license </a> for details.
</p>
-<h3>PersitenceManagerFactory</h3>
+<a name='pmf'><h3>PersitenceManagerFactory</h3></a>
<p>
This interface is used to implement well known Factory design pattern it used to setup singleton
<code>PersitenceManager</code> instanse.<code>PersitenceManager</code> is the most specific
@@ -53,7 +75,7 @@
this example setups <code>PersitenceManager</code> to use RDMS as storage.
</p>
-<h3>PersitenceManager</h3>
+<a name='pm'><h3>PersitenceManager</h3></a>
<p>
<code>PersitenceManager</code> is factory for your beans and transactions, <code>Transaction</code> is the
last interface you need to know from SimpleStore if you not going to extend SimpleStore.
@@ -135,7 +157,7 @@
</storage>
</pre>
</p>
-<h3>Transaction</h3>
+<a name='transaction'><h3>Transaction</h3></a>
<p>
SimpleStore supports only atomic persistence operations, All operations must be in transaction context:
<pre>
@@ -147,7 +169,7 @@
transaction.<b>commit</b>();// or transaction.<b>rollback</b>();
</pre>
</p>
-<h3>Identity</h3>
+<a name='id'><h3>Identity</h3></a>
<p>
All persistent objects have OID, it is recomended to use <code>Serializable</code> Object for OID,
reference implementaion uses java.lang.Long and default (Random) generator.
@@ -164,7 +186,7 @@
SimpleStore overrides <code>int hashCode()</code> and <code>boolean equals(Object obj)</code>
methods in class Object.
</p>
-<h3>State</h3>
+<a name='state'><h3>State</h3></a>
<p>
It is to methods in PersistenceManager for persitent object state.
<code> boolean isNew(Object p)</code> returns <code>true</code> if object is returned from
@@ -175,13 +197,13 @@
<code>java.lang.IllegalStateException</code>
if deleted object is accessed inside or outside transaction.
</p>
-<h3>Cashe</h3>
+<a name='cache'><h3>Cache</h3>
<p>
Cache is transparent for SimpleStore user. It used for optimizations and
reachability management, but it is "invisible" in code.
It is recomended to use default implementation.
</p>
-<h3>Validation</h3>
+<a name='validation'><h3>Validation</h3></a>
<p>
Metadada is used to define validation rules.
<code>Validator</code> is custom object see javadoc for more information on
@@ -189,11 +211,16 @@
and sample <code>NotNull</code> validator implementation. Persistent object implementation throws
<code>ValidationException</code> if registread validator returns false for managed property value.
</p>
-<h3>Security</h3>
+<a name='security'><h3>Security</h3></a>
<p>
Custom interceptors used for security checks.
SimpleStore doe's not define any specific Permissions and doe's no security checks.
-Read more about customizations in Developers Guide.
+Read more about customizations see <a href='developers-guide.html'> Developers Guide </a>.
</p>
+<hr style='color:navy'>
+ <div align="center"><font color="#525D76" size="-1"><em>
+ Copyright © 1999-2002, Apache Software Foundation
+ </em></font></div>
+
</body>
</html>
1.1 jakarta-commons-sandbox/simplestore/docs/developers-guide.html
Index: developers-guide.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>SimpleStore Developers Guide</TITLE>
<style>
h3{color:navy};
pre{color:navy};
code{color:navy};
</style>
</HEAD>
<BODY link='navy' alink='navy' vlink='navy'>
<a href="http://jakarta.apache.org">
<img src="http://jakarta.apache.org/images/jakarta-logo.gif" border="0"/></a>
<center><h2 style='color:navy'> SimpleStore Developers Guide</h2></center>
<a name='toc'><h3>Table of Contents</h3></a>
<ul>
<li><a href='users-guide.html'>Users Guide</a></li>
<li><a href='#about'>About this Guide</a></li>
<li><a href='#introduction'> Introduction </a></li>
<li><a href='#about'>Context</a></li>
<li><a href='#pmf'>PersitenceManagerFactory</a></li>
<li><a href='#pm'>PersitenceManager</a></li>
<li><a href='#transaction'>TransactionManager</a></li>
<li><a href='#storage'>Storage</a></li>
<li><a href='#cache'>Cache</a></li>
<li><a href='#metaclass'>MetaClass</a></li>
<li><a href='#enhansment'>Enhancment</a></li>
<li><a href='#persistent'>Persistent</a></li>
<li><a href='#proxy'>Proxy</a></li>
<li><a href='#state'>State</a></li>
<li><a href='#id'>Identity</a></li>
<li><a href='#validation'>Validation</a></li>
<li><a href='#interceptors'>Interceptors</a></li>
<li><a href='api/index.html'>API</a></li>
</ul>
<a name='about'><h3>About this Guide</h3></a>
This guide is intended for service providers.
<a name='introduction'><h3>Introduction</h3></a>
<a name='about'><h3>Context</h3></a>
<a name='pmf'><h3>PersitenceManagerFactory</h3></a>
<a name='pm'><h3>PersitenceManager</h3></a>
<a name='transaction'><h3>TransactionManager</h3></a>
<a name='storage'><h3>Storage</h3></a>
<a name='cache'><h3>Cache<h3></a>
<a name='metaclass'><h3>MetaClass</h3></a>
<a name='enhansment'><h3>Enhancment</h3></a>
<a name='persistent'><h3>Persistent</h3></a>
<a name='proxy'><h3>Proxy</h3></a>
<a name='state'><h3>State</h3></a>
<a name='id'><h3>Identity</h3></a>
<a name='validation'><h3>Validation</h3></a>
<a name='interceptors'><h3>Interceptors</h3></a>
<hr style='color:navy'>
<div align="center"><font color="#525D76" size="-1"><em>
Copyright © 1999-2002, Apache Software Foundation
</em></font></div>
</BODY>
</HTML>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>