svn commit: r398745 - /db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/metadata/fieldaccess/PersistentField.java

[ar...@apache.org]

Author: arminw
Date: Mon May  1 17:07:38 2006
New Revision: 398745

URL: http://svn.apache.org/viewcvs?rev=398745&view=rev
Log:
update javadoc

Modified:
    db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/metadata/fieldaccess/PersistentField.java

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/metadata/fieldaccess/PersistentField.java
URL: http://svn.apache.org/viewcvs/db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/metadata/fieldaccess/PersistentField.java?rev=398745&r1=398744&r2=398745&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/metadata/fieldaccess/PersistentField.java (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/metadata/fieldaccess/PersistentField.java Mon May  1 17:07:38 2006
@@ -20,14 +20,41 @@
 import org.apache.ojb.broker.metadata.MetadataException;
 
 /**
- * @author <a href="mailto:thma@apache.org">Thomas Mahler<a>
+ * Provide methods to manage a field of a persistence capable object.
+ *
  * @version $Id$
  */
 public interface PersistentField extends Serializable
 {
-	public Class getDeclaringClass();
-	public String getName();
-	public Class getType();
+    /**
+     * The type of the field declared in the persistence capable object.
+     *
+     * @return The declared field type.
+     * @see #getType()
+     */
+    public Class getDeclaringClass();
+
+    /**
+     * Returns the name of the field.
+     *
+     * @return The field name.
+     */
+    public String getName();
+
+    /**
+     * Returns the mapped type of the field.
+     * <p/>
+     * In most cases
+     * the <em>mapped type</em> and the {@link #getDeclaringClass() declared}
+     * type are the same, except when using <em>nested fields</em> (see OJB docs).
+     * Then the declared type is the nested class (a nested class encapsulates
+     * 'normal' fields, e.g. nested class <code>Unit</code> has fields
+     * <code>String unitName</code> and <code>int value</code>) itself and mapped type is
+     * one of the mapped fields.
+     *
+     * @see #getDeclaringClass()
+     */
+    public Class getType();
 
 	/**
 	 * Sets the field represented by this PersistentField object on the specified object argument to the specified new value.
@@ -53,5 +80,8 @@
 	 */
 	public Object get(Object anObject) throws MetadataException;
 
-	public boolean usesAccessorsAndMutators();
+    /**
+     * @deprecated will be removed
+     */
+    public boolean usesAccessorsAndMutators();
 }



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