add comments

Author: daileyet

src/openthinks/libs/sql/data/Row.java

@@ -1,12 +1,14 @@
 /**
  * 数据库数据模型包
+ * Database data models
  */
 package openthinks.libs.sql.data;
 
 import openthinks.libs.sql.dhibernate.support.ColumnAttribute;
 
 /**
  * 数据表的一行实体记录接口
+ * Represent the structure of row in database table
  * @author dmj
  *
  */
@@ -17,43 +19,43 @@ public interface Row {
 	 * @return Object 该列的值
 	 */
 	public Object get(int index);
-	
+
 	/**
 	 * 设置index列的值
 	 * @param index 第index列
 	 * @param e       设置新列的值
 	 */
-	public void set(int index,Object e);
-	
+	public void set(int index, Object e);
+
 	/**
 	 * 返回该行的列数
 	 * @return int 列数
 	 */
 	public int size();
-	
+
 	/**
 	 * 返回所有列的名称
 	 * @return ColumnAttribute[] 列名称字符串数组
 	 */
 	public ColumnAttribute[] getColumnAttributes();
-	
+
 	/**
 	 * 返回该行的所有列的集合
 	 * @return Column[]
 	 */
 	public Column[] getColumns();
-	
+
 	/**
 	 * 根据列名称返回该列的值
 	 * @param columnName  列名称
 	 * @return Object 该列的值
 	 */
 	public Object get(String columnName);
-	
+
 	/**
 	 * 设置列名称为columnName的列值为e
 	 * @param columnName 列名称
 	 * @param e
 	 */
-	public void set(String columnName,Object e);
+	public void set(String columnName, Object e);
 }

src/openthinks/libs/sql/dhibernate/support/ColumnAttribute.java

@@ -25,7 +25,11 @@
  */
 package openthinks.libs.sql.dhibernate.support;
 
-
+/**
+ * The information which holds the attribute name and column name in entity and table
+ * @author dailey
+ *
+ */
 public class ColumnAttribute {
 	private String columnName;
 	private String attributeName;
@@ -105,10 +109,8 @@ public void setAttributeName(String attributeName) {
 	public int hashCode() {
 		final int prime = 31;
 		int result = 1;
-		result = prime * result
-				+ ((attributeName == null) ? 0 : attributeName.hashCode());
-		result = prime * result
-				+ ((columnName == null) ? 0 : columnName.hashCode());
+		result = prime * result + ((attributeName == null) ? 0 : attributeName.hashCode());
+		result = prime * result + ((columnName == null) ? 0 : columnName.hashCode());
 		return result;
 	}
 

src/openthinks/libs/sql/dhibernate/support/IDType.java

@@ -26,9 +26,10 @@
 package openthinks.libs.sql.dhibernate.support;
 
 /**
+ * The primary key type for database table
  * @author dailey
  *
  */
 public enum IDType {
-	AUTO,MANUAL
+	AUTO, MANUAL
 }

src/openthinks/libs/sql/entity/Entity.java

@@ -16,7 +16,10 @@
 
 /**
  * 对应数据库表的实体类
- * 
+ * The simple entity which reference the table in database;<BR>
+ * required:<BR>
+ * 	<li>the attribute(property) name in this entity need same as the column name in database table
+ * 	<li>the first attribute in this entity map to the primary key column in database table
  * @author dmj
  */
 public abstract class Entity extends AbstractRow {
@@ -41,13 +44,11 @@ public ColumnAttribute[] getColumnAttributes() {
 				propertyNames = new String[fields.length];
 				for (int i = 0; i < propertyNames.length; i++) {
 					propertyNames[i] = fields[i].getName();
-					ColumnAttribute columnAttribute = new ColumnAttribute(
-							propertyNames[i], propertyNames[i]);
+					ColumnAttribute columnAttribute = new ColumnAttribute(propertyNames[i], propertyNames[i]);
 					if (i == 0) {
 						columnAttribute.setIdType(IDType.MANUAL);
 						Class<?> type = fields[i].getType();
-						if (type == int.class || type == long.class
-								|| type == Integer.class || type == Long.class) {
+						if (type == int.class || type == long.class || type == Integer.class || type == Long.class) {
 							columnAttribute.setIdType(IDType.AUTO);
 						}
 					}
@@ -62,13 +63,10 @@ public ColumnAttribute[] getColumnAttributes() {
 		return columnAttributeMapping.toArray();
 	}
 
-	protected PropertyDescriptor getPropertyDescriptor(String propertyName)
-			throws IntrospectionException {
-		PropertyDescriptor propertyDescriptor = propertyDescMap
-				.get(propertyName);
+	protected PropertyDescriptor getPropertyDescriptor(String propertyName) throws IntrospectionException {
+		PropertyDescriptor propertyDescriptor = propertyDescMap.get(propertyName);
 		if (propertyDescriptor == null) {
-			propertyDescriptor = new PropertyDescriptor(propertyName,
-					getClass());
+			propertyDescriptor = new PropertyDescriptor(propertyName, getClass());
 			propertyDescMap.put(propertyName, propertyDescriptor);
 		}
 		return propertyDescriptor;
@@ -93,14 +91,13 @@ public Object get(String propertyName) {
 		} catch (Exception e) {
 			isThrow = true;
 		}
-		if (isThrow) {
+		if (isThrow) {//get field value directly by access the filed
 			try {
 				Field filed = this.getClass().getDeclaredField(propertyName);
 				filed.setAccessible(true);
 				ret = filed.get(this);
 			} catch (Exception e) {
-				throw new EntityReflectException(propertyName + "属性",
-						e.getCause());
+				throw new EntityReflectException(propertyName + "属性", e.getCause());
 			}
 		}
 		return ret;
@@ -123,8 +120,7 @@ public void set(String propertyName, Object e) {
 			Method method = propertyDescriptor.getWriteMethod();
 			Class<?>[] parameterTypes = method.getParameterTypes();
 			if (parameterTypes != null && parameterTypes.length == 1) {
-				method.invoke(this,
-						Converter.source(e).convertToSingle(parameterTypes[0]));
+				method.invoke(this, Converter.source(e).convertToSingle(parameterTypes[0]));
 			} else {
 				method.invoke(this, e);
 			}
@@ -134,15 +130,13 @@ public void set(String propertyName, Object e) {
 			// + "方法", ex.getCause());
 			isThrow = true;
 		}
-		if (isThrow) {
+		if (isThrow) {//set field value directly by access the filed
 			try {
 				Field filed = getClass().getDeclaredField(propertyName);
 				filed.setAccessible(true);
-				filed.set(this,
-						Converter.source(e).convertToSingle(filed.getType()));
+				filed.set(this, Converter.source(e).convertToSingle(filed.getType()));
 			} catch (Exception ex) {
-				throw new EntityReflectException(propertyName + "属性",
-						ex.getCause());
+				throw new EntityReflectException(propertyName + "属性", ex.getCause());
 			}
 		}
 	}

src/openthinks/libs/sql/entity/jpa/EntityReflectHandler.java

@@ -33,16 +33,15 @@
 
 import org.apache.log4j.Logger;
 
+/**
+ * The simple {@link IReflectHandler} implementation for {@link Entity}
+ * @author dailey
+ *
+ */
 public class EntityReflectHandler extends JPAReflectHandler implements IReflectHandler {
 
 	Logger logger = Logger.getLogger(getClass());
 
-	/*
-	 * (non-Javadoc)
-	 * 
-	 * @see sql.lang.reflect.IReflectHandler#handField(java.lang.Object,
-	 * java.lang.String, java.lang.Object)
-	 */
 	@Override
 	public <T> boolean handColumnField(T entity, String columnName, Object columnValue) {
 		// TODO Checker.require(entity).isExtendsFrom(Entity.class);
@@ -71,11 +70,6 @@ public <T> String getEntityTableName(Class<T> entityClazz) {
 		return tableName;
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * 
-	 * @see sql.entity.jpa.JPAReflectHandler#getEntityIDName(java.lang.Class)
-	 */
 	@Override
 	public <T> String getEntityIDName(Class<T> entityClazz) {
 		String idName = super.getEntityIDName(entityClazz);

src/openthinks/libs/sql/entity/jpa/IReflectHandler.java

@@ -28,40 +28,47 @@
 import openthinks.libs.sql.dhibernate.support.ColumnAttributeMapping;
 
 /**
+ * The interface to handle different entity object
  * @author dailey
  *
  */
 public interface IReflectHandler {
-	
+
 	/**
 	 * parse entity class to {@link ColumnAttributeMapping}
 	 * @param entityClass Class<T><BR>
 	 * 		1. JPA annotation<BR>
 	 * 		2. Subclass of {@link Entity}
-	 * @return
+	 * @return {@link ColumnAttributeMapping}
 	 */
-	public <T>  ColumnAttributeMapping parseEntityClass(Class<T> entityClass);
+	public <T> ColumnAttributeMapping parseEntityClass(Class<T> entityClass);
 
 	/**
 	 * set column value to corresponding entity object
 	 * @param entity entity instance
+	 * 		1. JPA annotation<BR>
+	 * 		2. Subclass of {@link Entity}
 	 * @param columnName 	column name in database table
 	 * @param columnValue	column name value in database table row
-	 * @return boolean
+	 * @return boolean handle success or not
 	 */
 	public <T> boolean handColumnField(T entity, String columnName, Object columnValue);
 
 	/**
 	 * get entity corresponding table name
 	 * @param entityClazz Class<T>
-	 * @return String
+	 * 		1. JPA annotation<BR>
+	 * 		2. Subclass of {@link Entity}
+	 * @return String table name
 	 */
 	public <T> String getEntityTableName(Class<T> entityClazz);
 
 	/**
 	 * get entity corresponding table primary key
 	 * @param entityClazz Class<T>
-	 * @return String
+	 * 		1. JPA annotation<BR>
+	 * 		2. Subclass of {@link Entity}
+	 * @return String primary key name
 	 */
 	public <T> String getEntityIDName(Class<T> entityClazz);