jp.sf.orangesignal.csv.handlers
クラス BeanListHandlerSupport<T,H extends BeanListHandlerSupport<T,H>>

java.lang.Object
  jp.sf.orangesignal.csv.handlers.AbstractCsvListHandler<T,H>
      jp.sf.orangesignal.csv.handlers.BeanListHandlerSupport<T,H>

すべての実装されたインタフェース:

CsvHandler<List<T>>, CsvListHandler<T>

直系の既知のサブクラス:

BeanListHandler, ColumnNameMappingBeanListHandler, ColumnPositionMappingBeanListHandler, CsvEntityListHandler

public abstract class BeanListHandlerSupport<T,H extends BeanListHandlerSupport<T,H>>
extends AbstractCsvListHandler<T,H>

Java プログラム要素のリストと区切り文字形式データアクセスを行うハンドラの基底クラスを提供します。

作成者:

杉澤 浩二

フィールドの概要

protected BeanFilter	beanFilter Java プログラム要素フィルタを保持します。
protected List<BeanOrder>	orders 並び替え条件を保持します。

クラス jp.sf.orangesignal.csv.handlers.AbstractCsvListHandler から継承されたフィールド

limit, offset

コンストラクタの概要

protected

BeanListHandlerSupport(Class<T> type) コンストラクタです。

メソッドの概要

protected T	createBean() Java プログラム要素の型が表すクラスの新しいインスタンスを生成します。
protected Map<String,Object[]>	createFieldAndColumnsMap(Map<?,String> map) 指定された項目名 (または項目位置) と Java プログラム要素のフィールド名のマップと Java プログラム要素の型から、 Java プログラム要素のフィールド名と項目名群のマップを構築して返します。
H	filter(BeanFilter beanFilter) Java プログラム要素フィルタを設定します。
static Field	getField(Class<?> type, String name) 指定された Java プログラム要素の型が表すクラスの指定された宣言フィールドをリフレクトする Field オブジェクトを返します。
static Object	getFieldValue(Object bean, Field field) 指定された Java プログラム要素について、指定された Field によって表されるフィールドの値を返します。
Class<T>	getType() Java プログラム要素の型を返します。
protected String	objectToString(Object column, Object obj) 指定されたオブジェクトを項目値へ変換して返します。
H	order(BeanOrder... orders) 並び替え条件を設定します。
List<T>	processScalar(List<T> beans) この実装は orders が指定されている場合、並び替えを行ってから AbstractCsvListHandler.processScalar(List) を呼出します。
static void	setFieldValue(Object bean, Field field, Object value) 指定された Java プログラム要素の指定されたフィールドを、指定された新しい値に設定します。
void	setOrder(List<BeanOrder> orders) 並び替え条件を設定します。
void	setValueConverter(CsvValueConverter valueConverter) 区切り文字形式データの項目値コンバータを設定します。
protected void	setValueFormatter(Object column, Format formatter) 指定された項目名 (または項目位置) と項目値へ書式化するオブジェクトをマップへ追加します。
void	setValueFormatterMapping(Map<Object,Format> valueFormatterMapping) 項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップを設定します。
protected void	setValueParser(String field, Format parser) 指定された Java プログラム要素のフィールド名と項目値を解析するオブジェクトをマップへ追加します。
void	setValueParserMapping(Map<String,Format> valueParserMapping) Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップを設定します。
protected Object	stringToObject(Field field, String value) 指定された項目値を指定されたフィールドのオブジェクトへ変換して返します。
H	valueConverter(CsvValueConverter valueConverter) 区切り文字形式データの項目値コンバータを設定します。
H	valueFormatterMapping(Map<Object,Format> valueFormatterMapping) 項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップを設定します。
H	valueParserMapping(Map<String,Format> valueParserMapping) Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップを設定します。

クラス jp.sf.orangesignal.csv.handlers.AbstractCsvListHandler から継承されたメソッド

limit, load, offset, setLimit, setOffset

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェース jp.sf.orangesignal.csv.CsvListHandler から継承されたメソッド

load, save

フィールドの詳細

beanFilter

protected BeanFilter beanFilter

Java プログラム要素フィルタを保持します。

orders

protected List<BeanOrder> orders

並び替え条件を保持します。

コンストラクタの詳細

BeanListHandlerSupport

protected BeanListHandlerSupport(Class<T> type)

コンストラクタです。

パラメータ:

type - Java プログラム要素の型

例外:

IllegalArgumentException - type が null の場合

メソッドの詳細

processScalar

public List<T> processScalar(List<T> beans)

この実装は orders が指定されている場合、並び替えを行ってから AbstractCsvListHandler.processScalar(List) を呼出します。

定義:

インタフェース CsvListHandler<T> 内の processScalar

オーバーライド:

クラス AbstractCsvListHandler<T,H extends BeanListHandlerSupport<T,H>> 内の processScalar

パラメータ:

beans - スカラー副問い合わせを行う区切り文字形式データのリスト

戻り値:

スカラー副問い合わせされた区切り文字形式データのリスト

getType

public Class<T> getType()

Java プログラム要素の型を返します。

戻り値:

Java プログラム要素の型

setValueParserMapping

public void setValueParserMapping(Map<String,Format> valueParserMapping)

Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップを設定します。

パラメータ:

valueParserMapping - Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップ

例外:

IllegalArgumentException - valueParserMapping が null の場合

導入されたバージョン:

1.2.4

valueParserMapping

public H valueParserMapping(Map<String,Format> valueParserMapping)

Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップを設定します。

パラメータ:

valueParserMapping - Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップ

戻り値:

このオブジェクトへの参照

例外:

IllegalArgumentException - valueParserMapping が null の場合

導入されたバージョン:

1.2

setValueFormatterMapping

public void setValueFormatterMapping(Map<Object,Format> valueFormatterMapping)

項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップを設定します。

パラメータ:

valueFormatterMapping - 項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップ

例外:

IllegalArgumentException - valueFormaterMapping が null の場合

導入されたバージョン:

1.2.4

valueFormatterMapping

public H valueFormatterMapping(Map<Object,Format> valueFormatterMapping)

項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップを設定します。

パラメータ:

valueFormatterMapping - 項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップ

戻り値:

このオブジェクトへの参照

例外:

IllegalArgumentException - valueFormaterMapping が null の場合

導入されたバージョン:

1.2

setValueConverter

public void setValueConverter(CsvValueConverter valueConverter)

区切り文字形式データの項目値コンバータを設定します。

パラメータ:

valueConverter - 区切り文字形式データの項目値コンバータ

例外:

IllegalArgumentException - valueConverter が null の場合

導入されたバージョン:

1.2.4

valueConverter

public H valueConverter(CsvValueConverter valueConverter)

区切り文字形式データの項目値コンバータを設定します。

パラメータ:

valueConverter - 区切り文字形式データの項目値コンバータ

戻り値:

このオブジェクトへの参照

例外:

IllegalArgumentException - valueConverter が null の場合

導入されたバージョン:

1.2

filter

public H filter(BeanFilter beanFilter)

Java プログラム要素フィルタを設定します。

パラメータ:

beanFilter - Java プログラム要素フィルタ

戻り値:

このオブジェクトへの参照

導入されたバージョン:

1.2.3

setOrder

public void setOrder(List<BeanOrder> orders)

並び替え条件を設定します。

パラメータ:

orders - 並び替え条件

導入されたバージョン:

1.2.8

order

public H order(BeanOrder... orders)

並び替え条件を設定します。

パラメータ:

orders - 並び替え条件

戻り値:

このオブジェクトへの参照

導入されたバージョン:

1.2.8

setValueParser

protected void setValueParser(String field,
                              Format parser)

指定された Java プログラム要素のフィールド名と項目値を解析するオブジェクトをマップへ追加します。

指定されたフィールド名に既に項目値を解析するオブジェクトが設定されている場合、 既存の項目値解析オブジェクトへパラメータで指定された項目値解析オブジェクトのパターン文字列を追加します。

パラメータ:

field - Java プログラム要素のフィールド名

parser - 項目値を解析するオブジェクト

導入されたバージョン:

1.2

setValueFormatter

protected void setValueFormatter(Object column,
                                 Format formatter)

指定された項目名 (または項目位置) と項目値へ書式化するオブジェクトをマップへ追加します。

パラメータ:

column - 項目名 (または項目位置)

formatter - 項目値へ書式化するオブジェクト

導入されたバージョン:

1.2

createBean

protected T createBean()
                throws IOException

Java プログラム要素の型が表すクラスの新しいインスタンスを生成します。

戻り値:

Java プログラム要素の型が表す、クラスの新しく割り当てられたインスタンス

例外:

IOException - Java プログラム要素のインスタンス化に失敗した場合

createFieldAndColumnsMap

protected Map<String,Object[]> createFieldAndColumnsMap(Map<?,String> map)

指定された項目名 (または項目位置) と Java プログラム要素のフィールド名のマップと Java プログラム要素の型から、 Java プログラム要素のフィールド名と項目名群のマップを構築して返します。

パラメータ:

map - 項目名 (または項目位置) と Java プログラム要素のフィールド名のマップ

戻り値:

Java プログラム要素のフィールド名と項目名群のマップ

導入されたバージョン:

1.2

stringToObject

protected Object stringToObject(Field field,
                                String value)

指定された項目値を指定されたフィールドのオブジェクトへ変換して返します。 この実装は、指定されたフィールドに対応する項目値を解析するオブジェクトが存在する場合は、Format.parseObject(String) で得られたオブジェクトを返します。 それ以外の場合は、項目値コンバータを使用して得られたオブジェクトを返します。

パラメータ:

field - フィールド

value - 項目値

戻り値:

変換された項目値

導入されたバージョン:

1.2

objectToString

protected String objectToString(Object column,
                                Object obj)

指定されたオブジェクトを項目値へ変換して返します。 この実装は、指定された項目に対応する項目値へ書式化するオブジェクトが存在する場合は、Format.format(Object) で得られた文字列を返します。 それ以外の場合は、項目値コンバータを使用して得られた文字列を返します。

パラメータ:

column - 項目名 (または項目位置)

obj - オブジェクト

戻り値:

文字列の項目値

導入されたバージョン:

1.2

getField

public static Field getField(Class<?> type,
                             String name)
                      throws IOException

指定された Java プログラム要素の型が表すクラスの指定された宣言フィールドをリフレクトする Field オブジェクトを返します。

パラメータ:

type - Java プログラム要素の型

name - フィールド名

戻り値:

指定された Java プログラム要素の Field オブジェクト

例外:

IOException - 指定された名前のフィールドが見つからない場合

NullPointerException - name が null の場合

SecurityException

setFieldValue

public static void setFieldValue(Object bean,
                                 Field field,
                                 Object value)
                          throws IOException

指定された Java プログラム要素の指定されたフィールドを、指定された新しい値に設定します。 基本となるフィールドにプリミティブ型が指定されている場合、新しい値は自動的にラップ解除されます。

パラメータ:

bean - フィールドを変更する Java プログラム要素

field - フィールド

value - 変更中の Java プログラム要素の新しいフィールド値

例外:

IOException - 基本となるフィールドにアクセスできない場合。または指定されたオブジェクトが基本となるフィールド (またはそのサブクラスか実装側) を宣言するクラスまたはインタフェースのインスタンスではない場合、あるいはラップ解除変換が失敗した場合

NullPointerException - 指定されたオブジェクトが null で、フィールドがインスタンスフィールドの場合

SecurityException

getFieldValue

public static Object getFieldValue(Object bean,
                                   Field field)
                            throws IOException

指定された Java プログラム要素について、指定された Field によって表されるフィールドの値を返します。 プリミティブ型の場合、オブジェクト内に自動的に格納されてから返されます。

パラメータ:

bean - Java プログラム要素

field - フィールド

戻り値:

Java プログラム要素 bean 内で表現される値。プリミティブ値は適切なオブジェクト内にラップされてから返される

例外:

IOException - 基本となるフィールドにアクセスできない場合。指定されたオブジェクトが基本となるフィールド (またはそのサブクラスか実装側) を宣言するクラスまたはインタフェースのインスタンスではない場合

NullPointerException - 指定されたオブジェクトが null で、フィールドがインスタンスフィールドの場合

SecurityException