RowProcessor インターフェースの基本実装です。
* このクラスはスレッドセーフなSingletonです。
* {@primary Basic implementation of the RowProcessor interface.
* This class is a thread-safe Singleton.}
*
* @see RowProcessor
*
* @author Henri Yandell
* @author Juozas Baliuka
* @author David Graham
* @author Yoav Shapira
* @translator 小川 環
* @editor 日置 聡
* @status underproof
* @update 2003/12/19
*/
public class BasicRowProcessor implements RowProcessor {
/**
* Set a bean's primitive properties to these defaults when SQL NULL
* is returned. These are the same as the defaults that ResultSet get*
* methods return in the event of a NULL column.
*/
private static final Map primitiveDefaults = new HashMap();
static {
primitiveDefaults.put(Integer.TYPE, new Integer(0));
primitiveDefaults.put(Short.TYPE, new Short((short) 0));
primitiveDefaults.put(Byte.TYPE, new Byte((byte) 0));
primitiveDefaults.put(Float.TYPE, new Float(0));
primitiveDefaults.put(Double.TYPE, new Double(0));
primitiveDefaults.put(Long.TYPE, new Long(0));
primitiveDefaults.put(Boolean.TYPE, Boolean.FALSE);
primitiveDefaults.put(Character.TYPE, new Character('\u0000'));
}
/**
* Special array index that indicates there is no bean property that
* matches a column from a ResultSet.
*/
private static final int PROPERTY_NOT_FOUND = -1;
/**
* The Singleton instance of this class.
*/
private static final BasicRowProcessor instance = new BasicRowProcessor();
/**
* このクラスのSingletonインスタンスを返します。
* {@primary Returns the Singleton instance of this class.}
*
* @return このクラスの唯一のインスタンス。
* {@primary The single instance of this class.}
*/
public static BasicRowProcessor instance() {
return instance;
}
/**
* BasicRowProcessorのサブクラスのみを対象としたprotectedスコープのコンストラクタ。
* {@primary Protected constructor for BasicRowProcessor subclasses only.}
*/
protected BasicRowProcessor() {
super();
}
/**
* ResultSet の行を Object[] へ変換します。
* この実装は、 ResultSet から返されたカラム値を配列へ同順にコピーします。
* カラム値がSQL NULLであれば、配列の要素には null がセットされます。
* {@primary Convert a ResultSet row into an Object[].
* This implementation copies column values into the array in the same
* order they're returned from the ResultSet. Array elements
* will be set to null if the column was SQL NULL.}
*
* @see org.apache.commons.dbutils.RowProcessor#toArray(java.sql.ResultSet)
*/
public Object[] toArray(ResultSet rs) throws SQLException {
ResultSetMetaData meta = rs.getMetaData();
int cols = meta.getColumnCount();
Object[] result = new Object[cols];
for (int i = 0; i < cols; i++) {
result[i] = rs.getObject(i + 1);
}
return result;
}
/**
* ResultSet の行をJavaBeanへ変換します。
* この実装では、カラム名とBeanプロパティ名が一致するかどうか判定するために、 リフレクションおよび
* BeanInfoのクラスを使用しています。
* プロパティはいくつかの要因に基づいたカラムと一致します。
* {@primary Convert a ResultSet row into a JavaBean. This
* implementation uses reflection and BeanInfo classes to
* match column names to bean property names. Properties are matched to
* columns based on several factors:}
*
* ResultSet よりSQL NULLが返されると、 プリミティブ型の
* Bean プロパティは、その型のデフォルト値がセットされます。
* 数値型のフィールドには0がセットされ、boolean 型のフィールドには false がセットされます。
* SQL NULLが返されると、オブジェクト型のプロパティには null がセットされます。
* これは、 ResultSet の get* メソッドと同一の振る舞いです。
* {@primary Primitive bean properties are set to their defaults when SQL NULL is
* returned from the ResultSet. Numeric fields are set to 0
* and booleans are set to false. Object bean properties are set to
* null when SQL NULL is returned. This is the same behavior
* as the ResultSet get* methods.}
*
ResultSet をJavaBeanの List へ変換します。
* この実装では、カラム名とBeanプロパティ名が一致するかどうか判定するために、 リフレクションおよび
* BeanInfo のクラスを使用しています。
* プロパティはいくつかの要因に基づいたカラムと一致します。
* {@primary Convert a ResultSet into a List of JavaBeans.
* This implementation uses reflection and BeanInfo classes to
* match column names to bean property names. Properties are matched to
* columns based on several factors:}
*
* ResultSet よりSQL NULLが返されると、 プリミティブ型の
* Bean プロパティは、その型のデフォルト値がセットされます。
* 数値型のフィールドには0がセットされ、boolean 型のフィールドには false がセットされます。
* SQL NULLが返されると、オブジェクト型のプロパティには null がセットされます。
* これは、ResultSet の get* メソッドと同一の振る舞いです。
* {@primary Primitive bean properties are set to their defaults when SQL NULL is
* returned from the ResultSet. Numeric fields are set to 0
* and booleans are set to false. Object bean properties are set to
* null when SQL NULL is returned. This is the same behavior
* as the ResultSet get* methods.}
*
ResultSet の行を Map へ変換します。
* この実装では、大小文字を区別しないカラム名をキーとしたMapを返します。
* 例えば、map.get("COL") の呼び出しと
* map.get("col") の呼び出しでは、 同一の値が返されるようになります。
* {@primary Convert a ResultSet row into a Map. This
* implementation returns a Map with case insensitive column
* names as keys. Calls to map.get("COL") and
* map.get("col") return the same value.}
* @see org.apache.commons.dbutils.RowProcessor#toMap(java.sql.ResultSet)
*/
public Map toMap(ResultSet rs) throws SQLException {
Map result = new CaseInsensitiveHashMap();
ResultSetMetaData rsmd = rs.getMetaData();
int cols = rsmd.getColumnCount();
for (int i = 1; i <= cols; i++) {
result.put(rsmd.getColumnName(i), rs.getObject(i));
}
return result;
}
/**
* Calls the setter method on the target object for the given property.
* If no setter method exists for the property, this method does nothing.
* @param target The object to set the property on.
* @param prop The property to set.
* @param value The value to pass into the setter.
* @throws SQLException if an error occurs setting the property.
*/
private void callSetter(
Object target,
PropertyDescriptor prop,
Object value)
throws SQLException {
Method setter = prop.getWriteMethod();
if (setter == null) {
return;
}
Class[] params = setter.getParameterTypes();
try {
// Don't call setter if the value object isn't the right type
if (this.isCompatibleType(value, params[0])) {
setter.invoke(target, new Object[] { value });
}
} catch (IllegalArgumentException e) {
throw new SQLException(
"Cannot set " + prop.getName() + ": " + e.getMessage());
} catch (IllegalAccessException e) {
throw new SQLException(
"Cannot set " + prop.getName() + ": " + e.getMessage());
} catch (InvocationTargetException e) {
throw new SQLException(
"Cannot set " + prop.getName() + ": " + e.getMessage());
}
}
/**
* ResultSet.getObject() returns an Integer object for an INT column. The
* setter method for the property might take an Integer or a primitive int.
* This method returns true if the value can be successfully passed into
* the setter method. Remember, Method.invoke() handles the unwrapping
* of Integer into an int.
*
* @param value The value to be passed into the setter method.
* @param type The setter's parameter type.
* @return boolean True if the value is compatible.
*/
private boolean isCompatibleType(Object value, Class type) {
// Do object check first, then primitives
if (value == null || type.isInstance(value)) {
return true;
} else if (
type.equals(Integer.TYPE) && Integer.class.isInstance(value)) {
return true;
} else if (type.equals(Long.TYPE) && Long.class.isInstance(value)) {
return true;
} else if (
type.equals(Double.TYPE) && Double.class.isInstance(value)) {
return true;
} else if (type.equals(Float.TYPE) && Float.class.isInstance(value)) {
return true;
} else if (type.equals(Short.TYPE) && Short.class.isInstance(value)) {
return true;
} else if (type.equals(Byte.TYPE) && Byte.class.isInstance(value)) {
return true;
} else if (
type.equals(Character.TYPE) && Character.class.isInstance(value)) {
return true;
} else if (
type.equals(Boolean.TYPE) && Boolean.class.isInstance(value)) {
return true;
} else {
return false;
}
}
/**
* Returns a new instance of the given Class.
*
* @param c The Class to create an object from.
* @return A newly created object of the Class.
* @throws SQLException if creation failed.
*/
private Object newInstance(Class c) throws SQLException {
try {
return c.newInstance();
} catch (InstantiationException e) {
throw new SQLException(
"Cannot create " + c.getName() + ": " + e.getMessage());
} catch (IllegalAccessException e) {
throw new SQLException(
"Cannot create " + c.getName() + ": " + e.getMessage());
}
}
/**
* Returns a PropertyDescriptor[] for the given Class.
*
* @param c The Class to retrieve PropertyDescriptors for.
* @return A PropertyDescriptor[] describing the Class.
* @throws SQLException if introspection failed.
*/
private PropertyDescriptor[] propertyDescriptors(Class c)
throws SQLException {
// Introspector caches BeanInfo classes for better performance
BeanInfo beanInfo = null;
try {
beanInfo = Introspector.getBeanInfo(c);
} catch (IntrospectionException e) {
throw new SQLException(
"Bean introspection failed: " + e.getMessage());
}
return beanInfo.getPropertyDescriptors();
}
/**
* A Map that converts all keys to lowercase Strings for case insensitive
* lookups. This is needed for the toMap() implementation because
* databases don't consistenly handle the casing of column names.
*/
private static class CaseInsensitiveHashMap extends HashMap {
/**
* @see java.util.Map#containsKey(java.lang.Object)
*/
public boolean containsKey(Object key) {
return super.containsKey(key.toString().toLowerCase());
}
/**
* @see java.util.Map#get(java.lang.Object)
*/
public Object get(Object key) {
return super.get(key.toString().toLowerCase());
}
/**
* @see java.util.Map#put(java.lang.Object, java.lang.Object)
*/
public Object put(Object key, Object value) {
return super.put(key.toString().toLowerCase(), value);
}
/**
* @see java.util.Map#putAll(java.util.Map)
*/
public void putAll(Map m) {
Iterator iter = m.keySet().iterator();
while (iter.hasNext()) {
Object key = iter.next();
Object value = m.get(key);
this.put(key, value);
}
}
/**
* @see java.util.Map#remove(java.lang.ObjecT)
*/
public Object remove(Object key) {
return super.remove(key.toString().toLowerCase());
}
}
}