nablarch.core.dataformat

Class FormatterFactory

java.lang.Object

nablarch.core.dataformat.FormatterFactory

@Published(tag="architect")
public class FormatterFactory
extends java.lang.Object

データレコードフォーマッタ（DataRecordFormatter）を生成するファクトリクラス。

フォーマット定義ファイルのパースを行い、ディレクティブで指定されたファイルタイプに対応するデータレコードフォーマッタを生成して返却する。
具体的には、ファイルタイプが "Variable" の場合にVariableLengthDataRecordFormatterを、 ファイルタイプが "Fixed" の場合にFixedLengthDataRecordFormatterを生成する。

フォーマット定義情報保持クラスは、本クラスの内部でキャッシュし、同一のフォーマット定義ファイルが何度もパースされないように制御する。 デフォルトではフォーマット定義ファイルのパース結果はキャッシュされる。

また、リポジトリに「formatterFactory」のキーで本クラスのインスタンスを格納することで、設定を変更することができる。

以下に、設定可能な項目の一覧を示す。

プロパティ名	型	概要
allowedRecordSeparatorList	List<String>	レコード終端文字列として許容する文字列のリスト
defaultReplacementType	Map<String, String>	フィールドタイプ名に対応するデフォルトの寄せ字変換タイプ名のMap
encoding	String	フォーマット定義ファイルのエンコーディング
cacheLayoutFileDefinition	boolean	フォーマット定義ファイルのパース結果のキャッシュ要否

また、以下にフォーマット定義ファイルの定義例を示す。

 
 <component name="formatterFactory"
     class="nablarch.core.dataformat.FormatterFactory">
   <property name="cacheLayoutFileDefinition" value="false" />
   <property name="defaultReplacementType">
     <map>
       <entry key="X" value="type_hankaku" />
       <entry key="N" value="type_zenkaku" />
     </map>
   </property>
 </component>
 
 

See Also:

DataRecordFormatter, LayoutDefinition

Constructor Summary

Constructors

Constructor and Description
FormatterFactory()

Method Summary

Modifier and Type	Method and Description
protected LayoutDefinition	createDefinition(java.io.File layoutFile) フォーマット定義ファイルを読み込み、フォーマット定義情報保持クラスを生成する。
DataRecordFormatter	createFormatter(java.io.File layoutFile) データレコードフォーマッタのインスタンスを生成する。 フォーマット定義ファイルのパース結果をキャッシュする設定の場合は、フォーマット定義ファイルのパースは２度行わない。
DataRecordFormatter	createFormatter(LayoutDefinition definition) フォーマット定義情報保持クラスをもとに、データレコードフォーマッタのインスタンスを生成する。
protected DataRecordFormatter	createFormatter(java.lang.String fileType, java.lang.String formatFilePath) データレコードフォーマッタを生成する。 ファイルタイプにより下記のとおりフォーマッタの生成を行い、 これら以外のファイルタイプの場合は例外をスローする。 ファイルタイプ フォーマッタクラス Variable VariableLengthDataRecordFormatter Fixed FixedLengthDataRecordFormatter JSON JsonDataRecordFormatter XML XmlDataRecordFormatter protected LayoutFileParser createLayoutFileParser(java.lang.String layoutFilePath) フォーマット定義ファイルのパーサを生成する。 protected LayoutDefinition getDefinitionFromCache(java.io.File layoutFile) キャッシュからフォーマット定義情報保持クラスを取得する。 フォーマット定義情報保持クラスをキャッシュから取得できない場合は、生成する。 static FormatterFactory getInstance() FormatterFactoryクラスのインスタンスをリポジトリより取得する。 リポジトリより取得できなかった場合は、デフォルトで本クラスのインスタンスを返却する。 FormatterFactory setAllowedRecordSeparatorList(java.util.List<java.lang.String> allowedRecordSeparatorList) 許容するレコード終端文字列のリストを設定する。 FormatterFactory setCacheLayoutFileDefinition(boolean cacheLayoutFileDefinition) フォーマット定義ファイルのパース結果のキャッシュ要否を設定する。 FormatterFactory setDefaultReplacementType(java.util.Map<java.lang.String,java.lang.String> defaultReplacementType) データタイプ名に対応するデフォルトの寄せ字変換タイプ名のMapを設定する。 FormatterFactory setEncoding(java.lang.String encoding) フォーマット定義ファイルのファイルエンコーディングを設定する。 protected void setFormatterProperty(DataRecordFormatter formatter) データレコードフォーマッタにプロパティを設定する。 Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Constructor Detail FormatterFactory public FormatterFactory() Method Detail getInstance public static FormatterFactory getInstance() FormatterFactoryクラスのインスタンスをリポジトリより取得する。 リポジトリより取得できなかった場合は、デフォルトで本クラスのインスタンスを返却する。 Returns: このクラスのインスタンス setCacheLayoutFileDefinition public FormatterFactory setCacheLayoutFileDefinition(boolean cacheLayoutFileDefinition) フォーマット定義ファイルのパース結果のキャッシュ要否を設定する。 Parameters: cacheLayoutFileDefinition - フォーマット定義ファイルのパース結果のキャッシュ要否 Returns: このオブジェクト自体 createFormatter public DataRecordFormatter createFormatter(java.io.File layoutFile) データレコードフォーマッタのインスタンスを生成する。 フォーマット定義ファイルのパース結果をキャッシュする設定の場合は、フォーマット定義ファイルのパースは２度行わない。 Parameters: layoutFile - フォーマット定義ファイル Returns: データレコードフォーマッタのインスタンス createFormatter public DataRecordFormatter createFormatter(LayoutDefinition definition) フォーマット定義情報保持クラスをもとに、データレコードフォーマッタのインスタンスを生成する。 Parameters: definition - フォーマット定義情報保持クラス Returns: データレコードフォーマッタのインスタンス getDefinitionFromCache protected LayoutDefinition getDefinitionFromCache(java.io.File layoutFile) キャッシュからフォーマット定義情報保持クラスを取得する。 フォーマット定義情報保持クラスをキャッシュから取得できない場合は、生成する。 Parameters: layoutFile - フォーマット定義ファイル Returns: フォーマット定義情報保持クラス createFormatter protected DataRecordFormatter createFormatter(java.lang.String fileType, java.lang.String formatFilePath) データレコードフォーマッタを生成する。 ファイルタイプにより下記のとおりフォーマッタの生成を行い、 これら以外のファイルタイプの場合は例外をスローする。 ファイルタイプ フォーマッタクラス Variable VariableLengthDataRecordFormatter Fixed FixedLengthDataRecordFormatter JSON JsonDataRecordFormatter XML XmlDataRecordFormatter Parameters: fileType - ファイルタイプ formatFilePath - フォーマット定義ファイルのパス（例外発生時に使用する） Returns: フォーマッタ setFormatterProperty protected void setFormatterProperty(DataRecordFormatter formatter) データレコードフォーマッタにプロパティを設定する。 具体的には、データレコードフォーマッタの型がDataRecordFormatterSupportの場合に、 本クラスに設定された以下のプロパティを、データレコードフォーマッタのプロパティに設定する。 データタイプ名に対応するデフォルトの寄せ字変換タイプ名のMap 許容するレコード終端文字列のリスト Parameters: formatter - データレコードフォーマッタ createDefinition protected LayoutDefinition createDefinition(java.io.File layoutFile) フォーマット定義ファイルを読み込み、フォーマット定義情報保持クラスを生成する。 Parameters: layoutFile - フォーマット定義ファイル Returns: フォーマット定義情報保持クラス createLayoutFileParser protected LayoutFileParser createLayoutFileParser(java.lang.String layoutFilePath) フォーマット定義ファイルのパーサを生成する。 Parameters: layoutFilePath - フォーマット定義ファイルのパス Returns: フォーマット定義ファイルのパーサ setAllowedRecordSeparatorList public FormatterFactory setAllowedRecordSeparatorList(java.util.List<java.lang.String> allowedRecordSeparatorList) 許容するレコード終端文字列のリストを設定する。 Parameters: allowedRecordSeparatorList - 許容されるレコード終端文字列のリスト Returns: このオブジェクト自体 setDefaultReplacementType public FormatterFactory setDefaultReplacementType(java.util.Map<java.lang.String,java.lang.String> defaultReplacementType) データタイプ名に対応するデフォルトの寄せ字変換タイプ名のMapを設定する。 Parameters: defaultReplacementType - データタイプ名に対応するデフォルトの寄せ字変換タイプ名のMap Returns: このオブジェクト自体 setEncoding public FormatterFactory setEncoding(java.lang.String encoding) フォーマット定義ファイルのファイルエンコーディングを設定する。 Parameters: encoding - フォーマット定義ファイルのファイルエンコーディング Returns: このオブジェクト自体 Skip navigation links Overview Package Class Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method