com.gh.mygreen.xlsmapper.xml

クラス XmlBuilder

java.lang.Object

com.gh.mygreen.xlsmapper.xml.XmlBuilder

public class XmlBuilder
extends Object

アノテーション用のXMLのオブジェクト（AnnotationMappingInfo）を組み立てるためのヘルパークラス。

 // static import をすると使いやすくなります。
 import static com.gh.mygreen.xlsmapper.xml.XmlBuilder.*;

 public void sample() {
     AnnotationMappingInfo annotationMapping = createXml()
               .classInfo(createClass(SimpleSheet.class)
                       .annotation(createAnnotationBuilder(XlsSheet.class) // クラスに対するアノテーションの定義
                               .attribute("name", "単純なシート")
                               .buildAnnotation())
                       .field(createField("sheetName") // フィールドに対するアノテーションの定義
                               .annotation(createAnnotation(XlsSheetName.class)
                                       .buildAnnotation())
                               .buildField())
                       .field(createField("name")
                               .annotation(createAnnotation(XlsLabelledCell.class)
                                       .attribute("label", "名称")
                                       .attribute("type", LabelledCellType.Right)
                                       .buildAnnotation())
                               .annotation(createAnnotation(XlsTrim.class)
                                       .buildAnnotation())
                               .annotation(createAnnotation(XlsDefaultValue.class)
                                       .attribute("value", "ー")
                                       .buildAnnotation())
                               .buildField())
                       .method(createMethod("setRecords") // メソッドに対するアノテーションの定義
                               .annotation(createAnnotation(XlsHorizontalRecords.class)
                                       .attribute("tableLabel", "名簿一覧")
                                       .attribute("terminal", RecordTerminal.Border)
                                       .buildAnnotation())
                               .buildMethod())
                       .buildClass())
               .buildXml();

     // ファイルへの保存
     XmlIO.save(annotationMapping, new File("anno_simple.xml"), "UTF-8");

     // システム設定へ渡す。
     XlsMapper xlsMapper = new XlsMapper();
     xlsMapper.getConfiguration.setAnnotationMapping(annotaionMapping);

 }
 

導入されたバージョン:

1.1

作成者:

T.TSUCHIE

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
XmlBuilder()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static AnnotationInfo.Builder	createAnnotation(Class<? extends Annotation> clazz) AnnotationInfoのビルダクラスのAnnotationInfo.Builderインスタンスを作成する。
static ClassInfo.Builder	createClass(Class<?> clazz) ClassInfoのビルダクラスのClassInfo.Builderインスタンスを作成する。
static FieldInfo.Builder	createField(String fieldName) FieldInfoのビルダクラスのFieldInfo.Builderインスタンスを作成する。
static MethodInfo.Builder	createMethod(String methodName) MethodInfoのビルダクラスのMethodInfo.Builderインスタンスを作成する。
static AnnotationMappingInfo.Builder	createXml() AnnotationMappingInfoのビルダクラスのAnnotationMappingInfo.Builderインスタンスを作成する。
static OgnlValueFormatter	getValueFormatter() JavaオブジェクトをOGNL式に変換するためのクラスを取得する。
static void	setValueFormatter(OgnlValueFormatter valueFormatter) JavaオブジェクトをOGNL式に変換するためのクラスを設定する。

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

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

コンストラクタの詳細

XmlBuilder

public XmlBuilder()

メソッドの詳細

createXml

public static AnnotationMappingInfo.Builder createXml()

AnnotationMappingInfoのビルダクラスのAnnotationMappingInfo.Builderインスタンスを作成する。

戻り値:

createClass

public static ClassInfo.Builder createClass(Class<?> clazz)

ClassInfoのビルダクラスのClassInfo.Builderインスタンスを作成する。

パラメータ:

clazz - マッピング対象のJavaのクラス情報。

戻り値:

createMethod

public static MethodInfo.Builder createMethod(String methodName)

MethodInfoのビルダクラスのMethodInfo.Builderインスタンスを作成する。

パラメータ:

methodName - メソッド名

戻り値:

createField

public static FieldInfo.Builder createField(String fieldName)

FieldInfoのビルダクラスのFieldInfo.Builderインスタンスを作成する。

パラメータ:

fieldName - フィールド名

戻り値:

createAnnotation

public static AnnotationInfo.Builder createAnnotation(Class<? extends Annotation> clazz)

AnnotationInfoのビルダクラスのAnnotationInfo.Builderインスタンスを作成する。

JavaオブジェクトをOGNL式に変換するクラスOgnlValueFormatterはデフォルトの物が使用される。 独自のものを設定したい場合は、setValueFormatter(OgnlValueFormatter)を予め呼び変更しておく必要がある。

パラメータ:

clazz - アノテーションのクラス

戻り値:

getValueFormatter

public static OgnlValueFormatter getValueFormatter()

JavaオブジェクトをOGNL式に変換するためのクラスを取得する。

戻り値:

OGNL式のフォーマッタを返す。

setValueFormatter

public static void setValueFormatter(OgnlValueFormatter valueFormatter)

JavaオブジェクトをOGNL式に変換するためのクラスを設定する。

パラメータ:

valueFormatter -