commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nia...@apache.org
Subject svn commit: r344157 - /jakarta/commons/proper/beanutils/trunk/src/java/org/apache/commons/beanutils/package.html
Date Mon, 14 Nov 2005 16:57:10 GMT
Author: niallp
Date: Mon Nov 14 08:57:01 2005
New Revision: 344157

URL: http://svn.apache.org/viewcvs?rev=344157&view=rev
Log:
Update the User Guide for LazyDynaList and number subsections.

Modified:
    jakarta/commons/proper/beanutils/trunk/src/java/org/apache/commons/beanutils/package.html

Modified: jakarta/commons/proper/beanutils/trunk/src/java/org/apache/commons/beanutils/package.html
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/beanutils/trunk/src/java/org/apache/commons/beanutils/package.html?rev=344157&r1=344156&r2=344157&view=diff
==============================================================================
--- jakarta/commons/proper/beanutils/trunk/src/java/org/apache/commons/beanutils/package.html
(original)
+++ jakarta/commons/proper/beanutils/trunk/src/java/org/apache/commons/beanutils/package.html
Mon Nov 14 08:57:01 2005
@@ -11,58 +11,55 @@
 
 <h1>Table of Contents</h1>
 
-<ol>
-<li><a href="#overview">Overview</a>
+<ul>
+<li>1. <a href="#overview">Overview</a>
     <ul>
-    <li><a href="#overview.background">Background</a></li>
-    <li><a href="#overview.dependencies">External Dependencies</a></li>
+    <li>1.1 <a href="#overview.background">Background</a></li>
+    <li>1.2 <a href="#overview.dependencies">External Dependencies</a></li>
     </ul></li>
-<li><a href="#standard">Standard JavaBeans</a>
+<li>2. <a href="#standard">Standard JavaBeans</a>
     <ul>
-    <li><a href="#standard.background">Background</a></li>
-    <li><a href="#standard.basic">Basic Property Access</a></li>
-    <li><a href="#standard.nested">Nested Property Access</a></li>
+    <li>2.1 <a href="#standard.background">Background</a></li>
+    <li>2.2 <a href="#standard.basic">Basic Property Access</a></li>
+    <li>2.3 <a href="#standard.nested">Nested Property Access</a></li>
     </ul></li>
-<li><a href="#dynamic">Dynamic Beans (DynaBeans)</a>
+<li>3. <a href="#dynamic">Dynamic Beans (DynaBeans)</a>
     <ul>
-    <li><a href="#dynamic.background">Background</a></li>
-    <li><a href="#dynamic.basic">BasicDynaBean and BasicDynaClass</a></li>
-    <li><a href="#dynamic.resultSet">ResultSetDynaClass (Wraps ResultSet in DynaBeans)</a></li>
-    <li><a href="#dynamic.rowSet">RowSetDynaClass (Disconnected ResultSet as
DynaBeans)</a></li>
-    <li><a href="#dynamic.wrap">WrapDynaBean and WrapDynaClass</a></li>
-    <li><a href="#dynamic.lazy"><i>Lazy</i> DynaBeans</a></li>
+    <li>3.1 <a href="#dynamic.background">Background</a></li>
+    <li>3.2 <a href="#dynamic.basic">BasicDynaBean and BasicDynaClass</a></li>
+    <li>3.3 <a href="#dynamic.resultSet">ResultSetDynaClass (Wraps ResultSet
in DynaBeans)</a></li>
+    <li>3.4 <a href="#dynamic.rowSet">RowSetDynaClass (Disconnected ResultSet
as DynaBeans)</a></li>
+    <li>3.5 <a href="#dynamic.wrap">WrapDynaBean and WrapDynaClass</a></li>
+    <li>3.6 <a href="#dynamic.lazy"><i>Lazy</i> DynaBeans</a></li>
     </ul></li>
-<li><a href="#conversion">Data Type Conversions</a>
+<li>4. <a href="#conversion">Data Type Conversions</a>
     <ul>
-    <li><a href="#conversion.background">Background</a></li>
-    <li><a href="#conversion.beanutils">BeanUtils and ConvertUtils
+    <li>4.1 <a href="#conversion.background">Background</a></li>
+    <li>4.2 <a href="#conversion.beanutils">BeanUtils and ConvertUtils
         Conversions</a></li>
-    <li><a href="#conversion.defining">Defining Your Own Converters</a></li>
-    <li><a href="#conversion.i18n">Locale Aware Conversions</a></li>
-    </ul></li>
-<li><a href="#instances">Utility Objects And Static Utility Classes</a>
-    <ul>
-    <li><a href="#instances.background">Background</a></li>
+    <li>4.3 <a href="#conversion.defining">Defining Your Own Converters</a></li>
+    <li>4.4 <a href="#conversion.i18n">Locale Aware Conversions</a></li>
     </ul></li>
-<li><a href="#collections">Collections</a>
+<li>5. <a href="#instances">Utility Objects And Static Utility Classes</a></li>
+<li>6. <a href="#collections">Collections</a>
     <ul>
-    <li><a href="#bean-comparator">Comparing Beans</a></li>
-    <li><a href="#bean-property-closure">Operating On Collections Of Beans</a></li>
-    <li><a href="#bean-property-predicate">Querying Or Filtering Collections
Of Beans</a></li>
-    <li><a href="#bean-property-transformer">Transforming Collections Of Beans</a></li>
+    <li>6.1 <a href="#bean-comparator">Comparing Beans</a></li>
+    <li>6.2 <a href="#bean-property-closure">Operating On Collections Of Beans</a></li>
+    <li>6.3 <a href="#bean-property-predicate">Querying Or Filtering Collections
Of Beans</a></li>
+    <li>6.4 <a href="#bean-property-transformer">Transforming Collections Of
Beans</a></li>
     </ul></li>
-<li><a href="#FAQ">Frequently Asked Questions</a>
+<li>7. <a href="#FAQ">Frequently Asked Questions</a>
     <ul>
     <li><a href="#FAQ.property">Why Can't BeanUtils Find My Method?</a></li>
     <li><a href="#FAQ.bc.order">How Do I Set The BeanComparator Order To Be Ascending/Descending?</a></li>
     </ul></li>
-</ol>
+</ul>
 
 <a name="overview"></a>
-<h1>Overview</h1>
+<h1>1. Overview</h1>
 
 <a name="overview.background"></a>
-<h3>Background</h3>
+<h2>1.1 Background</h2>
 
 <p>The <em>JavaBeans</em> name comes from a
 <a href="http://java.sun.com/products/javabeans/">Java API specification</a>
@@ -155,7 +152,7 @@
 </pre>
 
 <a name="overview.dependencies"></a>
-<h3>External Dependencies</h3>
+<h2>1.2 External Dependencies</h2>
 
 <p>The <em>commons-beanutils</em> package requires that the following
 additional packages be available in the application's class path at runtime:
@@ -169,10 +166,10 @@
 
 
 <a name="standard"></a>
-<h1>Standard JavaBeans</h1>
+<h1>2. Standard JavaBeans</h1>
 
 <a name="standard.background"></a>
-<h3>Background</h3>
+<h2>2.1 Background</h2>
 
 <p>As described above, the standard facilities of the Java programming language
 make it easy and natural to access the property values of your beans using
@@ -239,7 +236,7 @@
 </pre>
 
 <a name="standard.basic"></a>
-<h3>Basic Property Access</h3>
+<h2>2.2 Basic Property Access</h2>
 
 <p>Getting and setting <strong>simple</strong> property values is, well,
 simple :-).  Check out the following API signatures in the Javadocs:</p>
@@ -328,7 +325,7 @@
 </pre>
 
 <a name="standard.nested"></a>
-<h3>Nested Property Access</h3>
+<h2>2.3 Nested Property Access</h2>
 
 <p>In all of the examples above, we have assumed that you wished to retrieve
 the value of a property of the bean being passed as the first argument to a
@@ -383,10 +380,10 @@
 </pre>
 
 <a name="dynamic"></a>
-<h1>Dynamic Beans (DynaBeans)</h1>
+<h1>3. Dynamic Beans (DynaBeans)</h1>
 
 <a name="dynamic.background"></a>
-<h3>Background</h3>
+<h2>3.1 Background</h2>
 
 <p>The <a href="PropertyUtils.html">PropertyUtils</a> class described in
the
 preceding section is designed to provide dynamic property access on existing
@@ -437,7 +434,7 @@
 implementations are not sufficient.</p>
 
 <a name="dynamic.basic"></a>
-<h3><code>BasicDynaBean</code> and <code>BasicDynaClass</code></h3>
+<h2>3.2 <code>BasicDynaBean</code> and <code>BasicDynaClass</code></h2>
 
 <p>The <a href="BasicDynaBean.html">BasicDynaBean</a> and
 <a href="BasicDynaClass.html">BasicDynaClass</a> implementation provides a
@@ -489,7 +486,7 @@
 actual BasicDynaBean implementation class.</p>
 
 <a name="dynamic.resultSet"></a>
-<h3><code>ResultSetDynaClass</code> (Wraps ResultSet in DynaBeans)</h3>
+<h2>3.3 <code>ResultSetDynaClass</code> (Wraps ResultSet in DynaBeans)</h2>
 
 <p>A very common use case for DynaBean APIs is to wrap other collections of
 "stuff" that do not normally present themselves as JavaBeans.  One of the most
@@ -516,7 +513,7 @@
 
 
 <a name="dynamic.rowSet"></a>
-<h3><code>RowSetDynaClass</code> (Disconnected ResultSet as DynaBeans)</h3>
+<h2>3.4 <code>RowSetDynaClass</code> (Disconnected ResultSet as DynaBeans)</h2>
 <p>Although <a href="#dynamic.resultSet"><code>ResultSetDynaClass</code></a>
is
 a very useful technique for representing the results of an SQL query as a
 series of DynaBeans, an important problem is that the underlying
@@ -564,7 +561,7 @@
 
 
 <a name="dynamic.wrap"></a>
-<h3><code>WrapDynaBean</code> and <code>WrapDynaClass</code></h3>
+<h2>3.5 <code>WrapDynaBean</code> and <code>WrapDynaClass</code></h2>
 
 <p>OK, you've tried the DynaBeans APIs and they are cool -- very simple
 <code>get()</code> and <code>set()</code> methods provide easy access
to all
@@ -588,8 +585,14 @@
 created internally, you never need to deal with them.</p>
 
 <a name="dynamic.lazy"></a>
-<h3><i>Lazy</i> DynaBeans (<a href="LazyDynaBean.html">LazyDynaBean</a>,

-<a href="LazyDynaMap.html">LazyDynaMap</a> and <a href="LazyDynaClass.html">LazyDynaClass</a>)</h3>
+<h2>3.6 <i>Lazy</i> DynaBeans</h2>
+
+<ul>
+    <li>1. <a href="#LazyDynaBean">LazyDynaBean</a> - A <i>Lazy</i>
<a href="DynaBean.html">DynaBean</a></li>
+    <li>2. <a href="#LazyDynaMap">LazyDynaMap</a> - A <i>light weight</i>
<a href="DynaBean.html">DynaBean</a> facade to a Map with <i>lazy</i>
map/list processing</li>
+    <li>3. <a href="#LazyDynaList">LazyDynaList</a> - A <i>lazy list</i>
for <a href="DynaBean.html">DynaBean</a>'s, <code>java.util.Map</code>'s
or POJO beans.</li>
+    <li>4. <a href="#LazyDynaClass">LazyDynaClass</a> - A <a href="MutableDynaClass.html">MutableDynaClass</a>
implementation.</li>
+</ul>
 
 <p>You bought into the DynaBeans because it saves coding all those POJO JavaBeans but
    you're here because <i>lazy</i> caught your eye and wondered whats that about?
@@ -625,7 +628,7 @@
              try to instantiate the bean using a default empty constructor.</li> 
     </ul>
 
-<p><strong><a href="LazyDynaBean.html">LazyDynaBean</a></strong>
is the standard <i>lazy</i> bean 
+<p><strong>1. <a name="LazyDynaBean" href="LazyDynaBean.html">LazyDynaBean</a></strong>
is the standard <i>lazy</i> bean 
    implementation. By default it is associated with a <a href="LazyDynaClass.html">LazyDynaClass</a>

    which implements the <a href="MutableDynaClass.html">MutableDynaClass</a>
interface - however
    it can be used with any <code>MutableDynaClass</code> implementation. The
question is <i>how do
@@ -644,7 +647,7 @@
     dynaBean.set("address", 2, addressLine3);     // indexed
 </pre>
 
-<p><strong><a href="LazyDynaMap.html">LazyDynaMap</a></strong>
is a <i>light wieght</i> <code>DynaBean</code>
+<p><strong>2. <a name="LazyDynaMap" href="LazyDynaMap.html">LazyDynaMap</a></strong>
is a <i>light wieght</i> <code>DynaBean</code>
    facade to a <code>Map</code> with all the usual <i>lazy</i> features.
Its <i>light weight</i> because it doesn't
    have an associated <code>DynaClass</code> containing all the properties. In
fact it actually implements
    the <code>DynaClass</code> interface itself (and <code>MutableDynaClass</code>)
and derives all the <i>DynaClass</i>
@@ -671,7 +674,11 @@
     dynaBean.set("foo", "bar");                  // set properties
 </pre>
 
-<p><strong><a href="LazyDynaClass.html">LazyDynaClass</a></strong>
extends <a href="BasicDynaClass.html">BasicDynaClass</a>
+<p><strong>3. <a name="LazyDynaList" href="LazyDynaList.html">LazyDynaList</a></strong>
is  <i>lazy list</i> for <a href="DynaBean.html">DynaBean</a>'s, 
+   <code>java.util.Map</code>'s or POJO beans. See the <a href="LazyDynaList.html">Javadoc</a>
for more details and
+   example usage.</p>
+
+<p><strong>4. <a name="LazyDynaClass" href="LazyDynaClass.html">LazyDynaClass</a></strong>
extends <a href="BasicDynaClass.html">BasicDynaClass</a>
    and implements the <a href="MutableDynaClass.html">MutableDynaClass</a> interface.
It can be used with other
    <code>DynaBean</code> implementations, but it is the default <code>DynaClass</code>
used by <code>LazyDynaBean</code>.
    When using the <code>LazyDynaBean</code> there may be no need to have anything
to do with the <code>DynaClass</code>
@@ -710,10 +717,10 @@
 
 
 <a name="conversion"></a>
-<h1>Data Type Conversions</h1>
+<h1>4. Data Type Conversions</h1>
 
 <a name="conversion.background"></a>
-<h3>Background</h3>
+<h3>4.1 Background</h3>
 
 <p>So far, we've only considered the cases where the data types of the
 dynamically accessed properties are known, and where we can use Java casts
@@ -723,7 +730,7 @@
 for performing this task as well.</p>
 
 <a name="conversion.beanutils"></a>
-<h3><code>BeanUtils</code> and <code>ConvertUtils</code> Conversions</h3>
+<h3>4.2 <code>BeanUtils</code> and <code>ConvertUtils</code>
Conversions</h3>
 
 <p>A very common use case (and the situation that caused the initial creation
 of the <em>BeanUtils</em> package) was the desire to convert the set of request
@@ -770,7 +777,7 @@
 new code should not be written with reliance on ConvertUtils.</p>
 
 <a name="conversion.defining"></a>
-<h3>Defining Your Own Converters</h3>
+<h3>4.3 Defining Your Own Converters</h3>
 
 <p>The <code>ConvertUtils</code> class supports the ability to define and
 register your own String --> Object conversions for any given Java class.
@@ -788,7 +795,7 @@
 </ul>
 
 <a name="conversion.i18n"></a>
-<h3>Locale Aware Conversions</h3>
+<h3>4.4 Locale Aware Conversions</h3>
 <p>The standard classes in <code>org.apache.commons.beanutils</code> are
not
 locale aware. This gives them a cleaner interface and makes then easier to use
 in situations where the locale is not important.</p>
@@ -799,7 +806,7 @@
 
 
 <a name="instances"></a>
-<h1>Utility Objects And Static Utility Classes</h1>
+<h1>5. Utility Objects And Static Utility Classes</h1>
 <a name="instances.background"></a>
 <h3>Background</h3>
 <p>
@@ -826,15 +833,15 @@
 </p>
 
 <a name="collections"></a>
-<h1>Collections</h1>
+<h1>6. Collections</h1>
 <a name="bean-comparator"></a>
-<h3>Comparing Beans</h3>
+<h3>6.1 Comparing Beans</h3>
 <p>
 <code>org.apache.commons.beanutils.BeanComparator</code> is a <code>Comparator</code>
implementation
 that compares beans based on a shared property value.
 </p>
 <a name="bean-property-closure"></a>
-<h3>Operating On Collections Of Beans</h3>
+<h3>6.2 Operating On Collections Of Beans</h3>
 <p>
 The <code>Closure</code> interface in <code>commons-collections</code>
encapsulates a block of code that 
 executes on an arbitrary input Object. <code>Commons-collections</code> contains
code that allows 
@@ -860,7 +867,7 @@
 </p>
 
 <a name="bean-property-predicate"></a>
-<h3>Querying Or Filtering Collections Of Beans</h3>
+<h3>6.3 Querying Or Filtering Collections Of Beans</h3>
 <p>
 The <code>Predicate</code> interface in <code>commons-collections</code>
encapsulates an evaluation
 of an input Object that returns either true or false. <code>Commons-collections</code>
contains code 
@@ -887,7 +894,7 @@
 </p>
 
 <a href="bean-property-transformer"></a>
-<h3>Transforming Collections Of Beans</h3>
+<h3>6.4 Transforming Collections Of Beans</h3>
 <p>
 The <code>Transformer</code> interface in <code>commons-collections</code>
encapsulates the transformation
 of an input Object into an output object. <code>Commons-collections</code> contains
code 
@@ -914,7 +921,7 @@
 </p>
 
 <a name="FAQ"></a>
-<h1>Frequently Asked Questions</h1>
+<h1>7. Frequently Asked Questions</h1>
 
 <a name="FAQ.property"></a>
 <h3>Why Can't BeanUtils Find My Method?</h3>



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message