nablarch.core.dataformat

クラス LayoutFileParser

java.lang.Object

nablarch.core.dataformat.LayoutFileParser

public class LayoutFileParser
extends java.lang.Object

フォーマット定義ファイルのLL(1)パーサ。

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	LayoutFileParser.Token フォーマット定義ファイルの構文定義上の終端要素(トークン)。
static class	LayoutFileParser.Tokenizer フォーマット定義ファイルの字句要素解析器
static class	LayoutFileParser.TokenType フォーマット定義ファイルの終端要素(トークン)の種別

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

コンストラクタ

コンストラクタと説明
LayoutFileParser(java.lang.String filePath) コンストラクタ。
LayoutFileParser(java.lang.String filePath, java.lang.String encoding) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Object[]	argsOpt() コンバータのオプション定義を読み込む。
void	conditionalStatement(RecordDefinition record) レコードタイプ判定条件を読み込む
void	conditionalStatements(RecordDefinition record) レコードタイプ判定条件定義部を読み込む
LayoutFileParser.Token	consume() 次のトークンを返し、読み込んだトークン分のだけ読み出し位置を進める。
LayoutFileParser.Token	consume(LayoutFileParser.TokenType type) 次のトークンを読み込み、読み出し位置を進める。
boolean	consumeIfFollowing(LayoutFileParser.TokenType type) 次のトークンが指定した種別のものである場合のみ、それを読み込んでスキャナの 位置を進める。
protected LayoutDefinition	createDefinition(java.lang.String filePath) パース結果を格納するクラスを生成し、フィールドに設定する。
void	directive(LayoutDefinition definition) 動作設定(ディレクティブ)を読み込む。
void	directives(LayoutDefinition definition) 共通設定部をパースする。
FieldDefinition	fieldFormat() フィールド定義を読み込む。
void	fieldFormats(LayoutDefinition layout, RecordDefinition record) フィールド定義部をパースする。
java.lang.Object	literal() リテラル値を読み込む。
LayoutDefinition	parse() フォーマット定義ファイルをパースし、その内容を渡されたオブジェクトに設定する。
LayoutFileParser.Token	peek() 次のトークンを返却する。
void	recordFormat(LayoutDefinition layout) レコード定義を読み込む。
void	recordFormats(LayoutDefinition layout) レコードタイプ定義部をパースする。
void	valueConvertor(FieldDefinition field) フィールド値のタイプ定義およびコンバート定義を読み込む。
void	valueConvertors(FieldDefinition field) フィールドに設定されているすべてのコンバート定義を読み込む。

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

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

コンストラクタの詳細

LayoutFileParser

@Published(tag="architect")
public LayoutFileParser(java.lang.String filePath)

コンストラクタ。

パラメータ:

filePath - フォーマット定義ファイルのパス

LayoutFileParser

@Published(tag="architect")
public LayoutFileParser(java.lang.String filePath,
                                                    java.lang.String encoding)

コンストラクタ。 フォーマット定義ファイルのエンコーディングを指定する。

パラメータ:

filePath - フォーマット定義ファイルのパス

encoding - フォーマット定義ファイルのエンコーディング

メソッドの詳細

createDefinition

protected LayoutDefinition createDefinition(java.lang.String filePath)

パース結果を格納するクラスを生成し、フィールドに設定する。

パラメータ:

filePath - フォーマット定義ファイルのパス

戻り値:

パース結果を格納するクラス

parse

@Published(tag="architect")
public LayoutDefinition parse()
                                                   throws SyntaxErrorException

フォーマット定義ファイルをパースし、その内容を渡されたオブジェクトに設定する。

戻り値:

パース結果オブジェクト

例外:

SyntaxErrorException - フォーマット定義ファイル内に構文エラーが存在した場合。

directives

public void directives(LayoutDefinition definition)

共通設定部をパースする。

パラメータ:

definition - フォーマット定義情報保持クラス

directive

public void directive(LayoutDefinition definition)

動作設定(ディレクティブ)を読み込む。

パラメータ:

definition - フォーマット定義情報保持クラス

recordFormats

public void recordFormats(LayoutDefinition layout)

レコードタイプ定義部をパースする。

パラメータ:

layout - フォーマット定義情報保持クラス

recordFormat

public void recordFormat(LayoutDefinition layout)

レコード定義を読み込む。

パラメータ:

layout - フォーマット定義情報保持クラス

fieldFormats

public void fieldFormats(LayoutDefinition layout,
                         RecordDefinition record)

フィールド定義部をパースする。

パラメータ:

layout - フォーマット定義情報保持クラス

record - レコードフォーマット定義

conditionalStatements

public void conditionalStatements(RecordDefinition record)

レコードタイプ判定条件定義部を読み込む

パラメータ:

record - レコードフォーマット定義

conditionalStatement

public void conditionalStatement(RecordDefinition record)

レコードタイプ判定条件を読み込む

パラメータ:

record - レコードフォーマット定義

fieldFormat

public FieldDefinition fieldFormat()

フィールド定義を読み込む。

戻り値:

レコードフォーマット定義

valueConvertors

public void valueConvertors(FieldDefinition field)

フィールドに設定されているすべてのコンバート定義を読み込む。

パラメータ:

field - フィールドフォーマット定義

valueConvertor

public void valueConvertor(FieldDefinition field)

フィールド値のタイプ定義およびコンバート定義を読み込む。

パラメータ:

field - フィールド定義

argsOpt

public java.lang.Object[] argsOpt()

コンバータのオプション定義を読み込む。

戻り値:

オプションの配列

literal

public java.lang.Object literal()

リテラル値を読み込む。

戻り値:

リテラル値

peek

public LayoutFileParser.Token peek()

次のトークンを返却する。 ただし、現在の読み出し位置は変更しない。

戻り値:

次のトークン

consume

public LayoutFileParser.Token consume()
                               throws SyntaxErrorException

次のトークンを返し、読み込んだトークン分のだけ読み出し位置を進める。

戻り値:

次のトークン

例外:

SyntaxErrorException - 読み出し位置が既に終端に達している場合

consume

public LayoutFileParser.Token consume(LayoutFileParser.TokenType type)
                               throws SyntaxErrorException

次のトークンを読み込み、読み出し位置を進める。 このとき、読み込んだトークンの種別が指定したものと異なる場合は実行時例外を送出する。

パラメータ:

type - 読み込むトークンの種別

戻り値:

読み込んだトークン

例外:

SyntaxErrorException - 読み込んだトークンが指定したものと異なる場合。

consumeIfFollowing

public boolean consumeIfFollowing(LayoutFileParser.TokenType type)

次のトークンが指定した種別のものである場合のみ、それを読み込んでスキャナの 位置を進める。 種別が一致しない場合は何もしない。

パラメータ:

type - 読み込むトークンの種別

戻り値:

種別が一致し、トークンを読み込んだ場合はtrue。 そうでなかった場合はfalse。