report
クラス Field

java.lang.Object
  上位を拡張 report.Node
      上位を拡張 report.Field

public class Field
extends Node

テキスト編集のレイアウトを構築するための「フィールド」ノード。
親ノードは、レコード。子ノードはもたない。


フィールドの概要
static int MIN_ROW
          フィールドのレコード内の桁位置の最小値
static int MIN_WIDTH
          フィールド幅の桁数の最小値
private  int row
          フィールドのレコード内の桁位置
private  FieldType type
          フィールドが固定文字列を保持するか編集フィールドかの区分
private  FieldFormat userFormatter
          パッケージのユーザが編集フィールドのフォーマットを行うために指定したハンドラ
private  java.lang.String value
          フィールドの固定文字列あるいは置換キーワード
private  int width
          フィールド幅の桁数
 
コンストラクタの概要
Field(int row, int width, FieldType type, java.lang.String value)
          フィールドに、フィールド桁位置、フィールド幅桁数、固定文字列か置換フィールドの区分、固定文字列か置換キーワードを指定するコンストラクタ。
Field(int row, int width, FieldType type, java.lang.String value, FieldFormat userFormatter)
          フィールドに、フィールド桁位置、フィールド幅桁数、固定文字列か置換フィールドの区分、固定文字列か置換キーワード、ユーザ定義フォーマッタ・ハンドラを指定するコンストラクタ。
Field(Record ancestor, int row, int width, FieldType type, java.lang.String value)
          フィールドに、親ノード、フィールド桁位置、フィールド幅桁数、固定文字列か置換フィールドの区分、固定文字列か置換キーワードを指定するコンストラクタ。
Field(Record ancestor, int row, int width, FieldType type, java.lang.String value, FieldFormat userFormatter)
          フィールドに、親ノード、フィールド桁位置、フィールド幅桁数、固定文字列か置換フィールドの区分、固定文字列か置換キーワード、ユーザ定義フォーマッタ・ハンドラを指定するコンストラクタ。
 
メソッドの概要
 Field add(java.util.List<Node> children)
          フィールドに子ノードをリストで指定した場合に例外を発生する。
 Field add(Node... children)
          フィールドに可変個の子ノードを指定した場合に例外を発生する。
 Field adda(Node[] children)
          フィールドに子ノードを配列で指定した場合に例外を発生する。
 int getRow()
          フィールドのレコード内の桁位置のゲッタ。
 FieldType getType()
          フィールドが固定文字列か編集フィールドかを表す区分のゲッタ。
(package private)  FieldFormat getUserFormatter()
          パッケージのユーザが編集フィールドのフォーマットを行うために指定したハンドラのゲッタ。
 java.lang.String getValue()
          フィールドの固定文字列あるいは置換キーワードのゲッタ。
 int getWidth()
          フィールド幅の桁数のゲッタ。
 Field merge(Node another)
          他のノードの子ノードをこのフィールドに取り込もうとした場合に例外を発生する。
 Field verify()
          フィールドの正当性を確認する。
 
クラス report.Node から継承されたメソッド
add, getAncestor, getChildren, getRootLayout, isEmpty, isOrphanNode, nullSafe, setAncestor, setChildren
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

MIN_ROW

public static final int MIN_ROW
フィールドのレコード内の桁位置の最小値

関連項目:
定数フィールド値

row

private int row
フィールドのレコード内の桁位置


MIN_WIDTH

public static final int MIN_WIDTH
フィールド幅の桁数の最小値

関連項目:
定数フィールド値

width

private int width
フィールド幅の桁数


type

private FieldType type
フィールドが固定文字列を保持するか編集フィールドかの区分


value

private java.lang.String value
フィールドの固定文字列あるいは置換キーワード


userFormatter

private FieldFormat userFormatter
パッケージのユーザが編集フィールドのフォーマットを行うために指定したハンドラ

コンストラクタの詳細

Field

public Field(Record ancestor,
             int row,
             int width,
             FieldType type,
             java.lang.String value,
             FieldFormat userFormatter)
フィールドに、親ノード、フィールド桁位置、フィールド幅桁数、固定文字列か置換フィールドの区分、固定文字列か置換キーワード、ユーザ定義フォーマッタ・ハンドラを指定するコンストラクタ。

パラメータ:
ancestor - 親ノード (レコード) を渡す。
row - フィールドの桁位置を渡す。
width - フィールド幅の桁数を渡す。
type - 固定文字列か置換フィールドかの区分 (FieldType) を渡す。
value - 固定文字列か置換キーワードを渡す。
userFormatter - ユーザ定義のフォーマッタを渡す。

Field

public Field(Record ancestor,
             int row,
             int width,
             FieldType type,
             java.lang.String value)
フィールドに、親ノード、フィールド桁位置、フィールド幅桁数、固定文字列か置換フィールドの区分、固定文字列か置換キーワードを指定するコンストラクタ。 ユーザ定義フォーマッタ・ハンドラは指定されない。

パラメータ:
ancestor - 親ノード (レコード) を渡す。
row - フィールドの桁位置を渡す。
width - フィールド幅の桁数を渡す。
type - 固定文字列か置換フィールドかの区分 (FieldType) を渡す。
value - 固定文字列か置換キーワードを渡す。

Field

public Field(int row,
             int width,
             FieldType type,
             java.lang.String value,
             FieldFormat userFormatter)
フィールドに、フィールド桁位置、フィールド幅桁数、固定文字列か置換フィールドの区分、固定文字列か置換キーワード、ユーザ定義フォーマッタ・ハンドラを指定するコンストラクタ。 親ノードは不明なままとなる。 他のフィールドとマージするために使用するフィールドを生成する事を想定している。

パラメータ:
row - フィールドの桁位置を渡す。
width - フィールド幅の桁数を渡す。
type - 固定文字列か置換フィールドかの区分 (FieldType) を渡す。
value - 固定文字列か置換キーワードを渡す。
userFormatter - ユーザ定義のフォーマッタを渡す。

Field

public Field(int row,
             int width,
             FieldType type,
             java.lang.String value)
フィールドに、フィールド桁位置、フィールド幅桁数、固定文字列か置換フィールドの区分、固定文字列か置換キーワードを指定するコンストラクタ。 親ノードは不明なままとなる。ユーザ定義のフォーマッタは存在しない。 他のフィールドとマージするために使用するフィールドを生成する事を想定している。

パラメータ:
row - フィールドの桁位置を渡す。
width - フィールド幅の桁数を渡す。
type - 固定文字列か置換フィールドかの区分 (FieldType) を渡す。
value - 固定文字列か置換キーワードを渡す。
メソッドの詳細

getRow

public int getRow()
フィールドのレコード内の桁位置のゲッタ。

戻り値:
フィールドのレコード内の桁位置を返す。

getWidth

public int getWidth()
フィールド幅の桁数のゲッタ。

戻り値:
フィールド幅の桁数を返す。

getType

public FieldType getType()
フィールドが固定文字列か編集フィールドかを表す区分のゲッタ。

戻り値:
フィールドが固定文字列を保持するか編集フィールドかの区分を返す。

getValue

public java.lang.String getValue()
フィールドの固定文字列あるいは置換キーワードのゲッタ。

戻り値:
フィールドの固定文字列あるいは置換キーワードを返す。

getUserFormatter

FieldFormat getUserFormatter()
パッケージのユーザが編集フィールドのフォーマットを行うために指定したハンドラのゲッタ。

戻り値:
ユーザが指定した編集フィールド・フォーマッタのハンドラを返す。

adda

public Field adda(Node[] children)
           throws ReportException
フィールドに子ノードを配列で指定した場合に例外を発生する。

オーバーライド:
クラス Node 内の adda
パラメータ:
children - 子ノードの配列を渡す。
戻り値:
常に例外を投げるので、戻り値はない。
例外:
常に - ReportException を投げる (フィールドに子ノードは存在しないので)
ReportException

add

public Field add(Node... children)
          throws ReportException
フィールドに可変個の子ノードを指定した場合に例外を発生する。

オーバーライド:
クラス Node 内の add
パラメータ:
children - 可変個の子ノードを渡す。
戻り値:
常に例外を投げるので、戻り値はない。
例外:
常に - ReportException を投げる (フィールドに子ノードは存在しないので)
ReportException

add

public Field add(java.util.List<Node> children)
          throws ReportException
フィールドに子ノードをリストで指定した場合に例外を発生する。

パラメータ:
children - 子ノードのリストを渡す。
戻り値:
常に例外を投げるので、戻り値はない。
例外:
常に - ReportException を投げる (フィールドに子ノードは存在しないので)
ReportException

merge

public Field merge(Node another)
            throws ReportException
他のノードの子ノードをこのフィールドに取り込もうとした場合に例外を発生する。

オーバーライド:
クラス Node 内の merge
パラメータ:
another - 他のノードを渡す。
戻り値:
常に例外を投げるので、戻り値はない。
例外:
常に - ReportException を投げる (フィールドに子ノードは存在しないので)
ReportException

verify

public Field verify()
             throws ReportException
フィールドの正当性を確認する。 親ノードがレコードで、子ノードがなく、桁位置はゼロか正数で、幅桁数はゼロより大きな正数で、置換フィールドであれば置換キーワードが空文字列ではない場合に正当なフィールドと判断される。

オーバーライド:
クラス Node 内の verify
戻り値:
正当性が確認されたこのフィールドを返す。
例外:
正当でない場合に - ReportException を投げる。
ReportException