add commonts

Author: daileyet

bin/dbconfig.properties

@@ -9,4 +9,5 @@ URL=jdbc:mysql://localhost:3306/opendb
 USERNAME=root
 #database pass
 #USERPWD=P@ssw0rd
-USERPWD=123456
+USERPWD=123456
+DIALECT=MYSQL

src/dbconfig.properties

@@ -9,4 +9,5 @@ URL=jdbc:mysql://localhost:3306/opendb
 USERNAME=root
 #database pass
 #USERPWD=P@ssw0rd
-USERPWD=123456
+USERPWD=123456
+DIALECT=MYSQL

src/openthinks/libs/sql/dao/BaseDao.java

@@ -20,7 +20,7 @@
  * 
  * @author dmj
  * @version 2010/11/15
- * @param <E>
+ * @param <T>
  */
 public interface BaseDao {
 
@@ -29,7 +29,7 @@ public interface BaseDao {
 	 * @return boolean 
 	 */
 	public boolean isUsePool();
-	
+
 	/**
 	 * 取得数据库连接
 	 * 
@@ -171,13 +171,15 @@ public interface BaseDao {
 	 * <li>无配置默认实体类中的各属性字段与数据库表中的字段名称相同,区分大小写.
 	 * </ol>
 	 * @deprecated
+	 * please use: {@code <T> List<T> openthinks.libs.sql.dao.BaseDao.list(Class<T> clz, String sql)}
 	 * @see Entity </span>
 	 * @param clz
 	 *            查询的实体Class类型,<font color=red><b>需是Entity的子类型</b></font>
 	 * @param sql
 	 *            标准查询sql语句,<span style=color:red>不支持跨表查询</span>
-	 * @return List<E> 实体类Entity或其子类的集合列表
+	 * @return List<T> 实体类Entity或其子类的集合列表
 	 */
+	@Deprecated
 	public <T extends Entity> List<T> listEntity(Class<T> clz, String sql);
 
 	/**
@@ -189,17 +191,18 @@ public interface BaseDao {
 	 * <li>无配置默认实体类中的各属性字段与数据库表中的字段名称相同,区分大小写.
 	 * </ol>
 	 * @deprecated
+	 * please use: {@code <T> List<T> openthinks.libs.sql.dao.BaseDao.list(Class<T> clz, String sql, String[] params)}
 	 * @see Entity </span>
 	 * @param clz
 	 *            查询的实体Class类型,<font color=red><b>需是Entity的子类型</b></font>
 	 * @param sql
 	 *            标准查询sql语句,<span style=color:red>不支持跨表查询</span>
 	 * @param params
 	 *            sql语句依赖的具体参数数组
-	 * @return List<E> 实体类Entity或其子类的集合列表
+	 * @return List<T> 实体类Entity或其子类的集合列表
 	 */
-	public <T extends Entity> List<T> listEntity(Class<T> clz, String sql,
-			String[] params);
+	@Deprecated
+	public <T extends Entity> List<T> listEntity(Class<T> clz, String sql, String[] params);
 
 	/**
 	 * 返回满足查询条件的实体类的集合列表<br>
@@ -209,16 +212,17 @@ public <T extends Entity> List<T> listEntity(Class<T> clz, String sql,
 	 * <li>实体类重写父类Entity的get,set方法
 	 * <li>无配置默认实体类中的各属性字段与数据库表中的字段名称相同,区分大小写.
 	 * </ol>
-	 * @deprecated
+	 * @deprecated 
+	 * please use: {@code <T> List<T> openthinks.libs.sql.dao.BaseDao.list(Class<T> clz, Condition condition)}
 	 * @see Entity </span>
 	 * @param clz
 	 *            查询的实体Class类型,<font color=red><b>需是Entity的子类型</b></font>
 	 * @param condition
 	 *            专用于生成带条件的sql语句的对象
-	 * @return List<E> 实体类Entity或其子类的集合列表
+	 * @return List<T> 实体类Entity或其子类的集合列表
 	 */
-	public <T extends Entity> List<T> listEntity(Class<T> clz,
-			Condition condition);
+	@Deprecated
+	public <T extends Entity> List<T> listEntity(Class<T> clz, Condition condition);
 
 	/**
 	 * 返回所有相应实体类的集合列表<br>
@@ -251,10 +255,10 @@ public <T extends Entity> List<T> listEntity(Class<T> clz,
 	 *            1.Entity子类<BR>
 	 *            2.JPA注解方式
 	 * @since 2010/11/17
-	 * @return List<E> 任何实体类的集合列表
+	 * @return List<T> 任何实体类的集合列表
 	 */
-	public  <T> List<T> list(Class<T> clz);
-	
+	public <T> List<T> list(Class<T> clz);
+
 	/**
 	 * 返回满足查询条件的实体类的集合列表<br>
 	 * <span style=color:gray;> 遵循数据库表结构反射. 实体类中的各属性字段与数据库表中的字段名称相同,区分大小写.<br>

src/openthinks/libs/sql/dhibernate/Session.java

@@ -21,16 +21,21 @@
  */
 public interface Session {
 
+	/**
+	 * create a {@link Query} for this given entity class
+	 * @param clz Class<T> entity class type
+	 * @return Query<T>
+	 */
 	public <T> Query<T> createQuery(Class<T> clz);
 
 	/**
 	 * 根据id值获取clz类型的实体对象
 	 * 
 	 * @param clz
 	 *            实体类型clz<BR>
-	 *            1.Entity子类默认第一个熟悉为ID列<BR>
+	 *            1.{@link Entity}子类默认第一个属性为ID列<BR>
 	 *            2.JPA标注的实体类标准 {@link javax.persistence.Id}
-	 * @param id
+	 * @param id Serializable
 	 *            主键值
 	 * @return Object 数据库表所对应的实体对象
 	 */
@@ -102,7 +107,7 @@ public interface Session {
 	 * 
 	 * @param clz
 	 *            查询的实体Class类型,<span style=color:red>可以不是Entity的子类</span><BR>
-	 *            1.Entity子类<BR>
+	 *            1.{@link Entity}子类<BR>
 	 *            2.JPA注解方式
 	 * @since 2010/11/17
 	 * @return List<E> 任何实体类的集合列表
@@ -310,10 +315,14 @@ public interface Session {
 	 */
 	public Configurator getConfigurator();
 
+	/**
+	 * judge database connection is auto-close after execute DML
+	 * @return Boolean
+	 */
 	public Boolean isAutoClose();
 
 	/**
-	 * controller connection auto-close when after execute DML
+	 * controller database connection auto-close when after execute DML
 	 * 
 	 */
 	public void enableAutoClose();

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

@@ -17,7 +17,7 @@
  * under the License. 
  * 
  * @Title: AbstractSession.java 
- * @Package sql.dhibernate.support 
+ * @Package openthinks.libs.sql.dhibernate.support 
  * @Description: TODO
  * @author minjdai 
  * @date 2013-12-2
@@ -75,12 +75,13 @@ protected void setAutoClose(Boolean autoClose) {
 	}
 
 	/**
-	 * @return
+	 * provider the {@link BaseDao}
+	 * @return BaseDao
 	 */
 	public abstract BaseDao getBaseDao();
 
 	/**
-	 * @return the autoClose
+	 * @return Boolean if is autoClose
 	 */
 	@Override
 	public Boolean isAutoClose() {
@@ -94,8 +95,7 @@ public <T> T load(Class<T> clz, Serializable id) {
 		Checker.require(persistName).notNull();
 		String persistIdName = ReflectEngine.getEntityID(clz);
 		Checker.require(persistIdName).notNull();
-		String sql = "SELECT * FROM " + persistName + " WHERE " + persistIdName
-				+ " = ?";
+		String sql = "SELECT * FROM " + persistName + " WHERE " + persistIdName + " = ?";
 		return get(clz, sql, new String[] { id.toString() });
 	}
 
@@ -165,8 +165,7 @@ public <T> T get(Class<T> clz, String sql, String[] params) {
 						try {
 							String columnName = rsmd.getColumnName(i);
 							Object columnValue = rs.getObject(columnName);
-							ReflectEngine.propertyReflect(entity, columnName,
-									columnValue);
+							ReflectEngine.propertyReflect(entity, columnName, columnValue);
 						} catch (Exception e) {
 							getBaseDao().getLogger().warn(e.getMessage());
 							continue;
@@ -200,8 +199,7 @@ public <T extends Entity> T get(Entity entity, String sql, String[] params) {
 						try {
 							String columnName = rsmd.getColumnName(i);
 							Object columnValue = rs.getObject(columnName);
-							ReflectEngine.propertyReflect(entity, columnName,
-									columnValue);
+							ReflectEngine.propertyReflect(entity, columnName, columnValue);
 							// entity.set(columnName, columnValue);
 						} catch (Exception e) {
 							getBaseDao().getLogger().warn(e.getMessage());
@@ -229,15 +227,13 @@ public <T> List<T> list(Class<T> clz) {
 	 */
 	@Override
 	public <T> T get(Class<T> clz, Condition condition) {
-		return condition == null ? null : get(clz,
-				Condition.getFullSql(condition));
+		return condition == null ? null : get(clz, Condition.getFullSql(condition));
 	}
 
 	@SuppressWarnings("unchecked")
 	@Override
 	public <T extends Entity> T get(Entity entity, Condition condition) {
-		return (T) (condition == null ? null : get(entity,
-				Condition.getFullSql(condition)));
+		return (T) (condition == null ? null : get(entity, Condition.getFullSql(condition)));
 	}
 
 	/**

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

@@ -17,7 +17,7 @@
  * under the License. 
  * 
  * @Title: ColumnAttribute.java 
- * @Package sql.dhibernate.support 
+ * @Package openthinks.libs.sql.dhibernate.support 
  * @Description: TODO
  * @author dailey 
  * @date 2012-11-9

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

@@ -17,7 +17,7 @@
  * under the License. 
  * 
  * @Title: ColumnAttributeMapping.java 
- * @Package sql.dhibernate.support 
+ * @Package openthinks.libs.sql.dhibernate.support 
  * @Description: TODO
  * @author dailey 
  * @date 2012-11-9

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

@@ -21,22 +21,11 @@ public DefaultSession(Configurator configurator) {
 		baseDao.setConfigurator(configurator);
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * 
-	 * @see sql.dhibernate.support.AbstractSession#getBaseDao()
-	 */
 	@Override
 	public BaseDao getBaseDao() {
 		return baseDao;
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * 
-	 * @see
-	 * sql.dhibernate.support.AbstractSession#setAutoClose(java.lang.Boolean)
-	 */
 	@Override
 	protected void setAutoClose(Boolean autoClose) {
 		super.setAutoClose(autoClose);

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

@@ -17,7 +17,7 @@
  * under the License. 
  * 
  * @Title: FilterTemplate.java 
- * @Package sql.dhibernate.support 
+ * @Package openthinks.libs.sql.dhibernate.support 
  * @Description: TODO
  * @author minjdai 
  * @date 2013-12-2
@@ -28,8 +28,8 @@
 import openthinks.libs.sql.dhibernate.support.query.QueryFilter;
 
 /**
+ * generate the query filter part sql, which the <B>WHERE</B> part in <B>SELECT</B> statement
  * @author minjdai
- * 
  */
 public interface FilterTemplate extends Template {
 
@@ -41,6 +41,10 @@ public interface FilterTemplate extends Template {
 	 */
 	public void setFilter(QueryFilter filters);
 
+	/**
+	 * get the filter values
+	 * @return Object[]
+	 */
 	public Object[] getParameters();
 
 }

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

@@ -17,7 +17,7 @@
  * under the License. 
  * 
  * @Title: IDType.java 
- * @Package sql.dhibernate.support 
+ * @Package openthinks.libs.sql.dhibernate.support 
  * @Description: TODO
  * @author dailey 
  * @date 2012-11-9
@@ -26,7 +26,7 @@
 package openthinks.libs.sql.dhibernate.support;
 
 /**
- * The primary key type for database table
+ * The generate strategy of primary key value for database table
  * @author dailey
  *
  */