nablarch.core.dataformat

クラス LayoutDefinition

java.lang.Object

nablarch.core.dataformat.LayoutDefinition

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

フォーマット定義ファイル全体の定義情報を保持するクラス。 フォーマット定義ファイルのパース結果が本クラスとなる。

フォーマット定義ファイルの情報は、LayoutFileParserによって読み込まれ、 DataRecordFormatterSupportのサブクラスにより、 ファイルタイプ（固定長・可変長）に応じた初期化処理が行われる。

関連項目:

LayoutFileParser, DataRecordFormatterSupport

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

コンストラクタ

コンストラクタと説明
LayoutDefinition() デフォルトコンストラクタ。
LayoutDefinition(java.lang.String source) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
LayoutDefinition	addRecord(RecordDefinition... records) レコードタイプの定義を追加する。
java.util.Map<java.lang.String,java.lang.Object>	getDirective() ディレクティブの定義を取得する。
RecordDefinition	getRecordClassifier() レコードタイプを識別するフィールドを読み込むためのフォーマット定義を取得する。
java.util.List<RecordDefinition>	getRecords() レコードタイプの定義のリストを返却する。
RecordDefinition	getRecordType(java.lang.String typeName) レコードタイプ名に紐付くレコードタイプの定義を返却する。
boolean	isInitialized() 初期化が行われたかどうかのフラグを取得する
LayoutDefinition	setInitialized(boolean initialized) 初期化が行われたかどうかのフラグを設定する。
LayoutDefinition	setRecordClassifier(RecordDefinition classifier) レコードタイプ識別用フィールド定義を設定する。

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

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

コンストラクタの詳細

LayoutDefinition

public LayoutDefinition()

デフォルトコンストラクタ。

LayoutDefinition

public LayoutDefinition(java.lang.String source)

コンストラクタ。

パラメータ:

source - 本インスタンスの入力元となるレイアウト定義ファイルのパス

メソッドの詳細

getRecordClassifier

public RecordDefinition getRecordClassifier()

レコードタイプを識別するフィールドを読み込むためのフォーマット定義を取得する。

戻り値:

レコードタイプを識別するフィールドを読み込むためのフォーマット定義

setRecordClassifier

public LayoutDefinition setRecordClassifier(RecordDefinition classifier)

レコードタイプ識別用フィールド定義を設定する。

パラメータ:

classifier - レコード種別識別フィールド定義

戻り値:

このオブジェクト自体

addRecord

public LayoutDefinition addRecord(RecordDefinition... records)

レコードタイプの定義を追加する。

パラメータ:

records - レコードタイプ定義

戻り値:

このオブジェクト自体

getRecordType

public RecordDefinition getRecordType(java.lang.String typeName)

レコードタイプ名に紐付くレコードタイプの定義を返却する。

パラメータ:

typeName - レコードタイプ名

戻り値:

レコードタイプの定義

getRecords

public java.util.List<RecordDefinition> getRecords()

レコードタイプの定義のリストを返却する。

戻り値:

レコードタイプの定義のリスト

setInitialized

public LayoutDefinition setInitialized(boolean initialized)

初期化が行われたかどうかのフラグを設定する。

パラメータ:

initialized - 初期化が行われたかどうかのフラグ

戻り値:

このオブジェクト自体

isInitialized

public boolean isInitialized()

初期化が行われたかどうかのフラグを取得する

戻り値:

初期化が行われたかどうかのフラグ

getDirective

public java.util.Map<java.lang.String,java.lang.Object> getDirective()

ディレクティブの定義を取得する。

戻り値:

ディレクティブの定義