report
クラス Node

java.lang.Object
  上位を拡張 report.Node
直系の既知のサブクラス:
Block, Field, Layout, Record

public class Node
extends java.lang.Object

テキスト編集のレイアウトを構成するツリーのすべてのノードの規定クラス。 ツリーを構成するノードの階層は次のとおり。
    ┌───┐
      Layout
    └─┬─┘
    ┌─┴─┐
      Block
    └─┬─┘
    ┌─┴─┐
      Record
    └─┬─┘
    ┌─┴─┐
      Field
    └───┘

Layout はそのサブ・クラス HeaderLayout と FooterLayout を、ヘッダとフッタのレイアウト指定を行うために保持する。
Block はそれ自身も子ノードとする。
Block のサブ・クラス FeedPageRecord は改ページ制御レコードを、LineFeedRecord は改行制御レコードを表す。


フィールドの概要
private  Node ancestor
          親ノード
private  java.util.List<Node> children
          子ノードのリスト
 
コンストラクタの概要
Node()
          ノードのコンストラクタ。
Node(Node ancestor)
          親ノードを指定してノードを生成するコンストラクタ。
 
メソッドの概要
(package private)  Node add(java.util.List<? extends Node> children)
          子ノードのリストを追加する。
(package private)  Node add(Node... children)
          可変個の子ノードを追加する。
(package private)  Node adda(Node[] children)
          子ノードの配列を追加する。
(package private)  Node getAncestor()
          親ノードのゲッタ。
 java.util.List<Node> getChildren()
          子ノードのリストのゲッタ
(package private)  Layout getRootLayout()
          レイアウトのツリーにルート・レイアウトを探索する。
(package private) static boolean isEmpty(java.lang.String str)
          文字列が空であることを判定する。
(package private)  boolean isOrphanNode(Node node)
          ノードの親ノードが不明であることを許容するノードであることを判定する。
(package private)  Node merge(Node another)
          別のノードの子ノードを、このノードに移しかえる。
(package private) static java.lang.String nullSafe(java.lang.Object obj)
          オブジェクトが null であっても文字列に変換する。
(package private)  void setAncestor(Node ancestor)
          親ノードのセッタ。
private  Node setAncestorOfChild(Node node)
          子ノードの親ノードをこのノードに設定する。
(package private)  void setChildren(java.util.List<Node> children)
          子ノードのリストのセッタ
(package private)  Node verify()
          ノードの正当性を確認する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

ancestor

private Node ancestor
親ノード


children

private java.util.List<Node> children
子ノードのリスト

コンストラクタの詳細

Node

Node(Node ancestor)
親ノードを指定してノードを生成するコンストラクタ。

パラメータ:
ancestor - 親ノードを渡す。

Node

Node()
ノードのコンストラクタ。 親ノードは不明 (null) になる。

メソッドの詳細

isEmpty

static boolean isEmpty(java.lang.String str)
文字列が空であることを判定する。

パラメータ:
str - 判定する文字列を渡す。
戻り値:
文字列が null か空文字列であれば true を、そうでなければ false を返す。

nullSafe

static java.lang.String nullSafe(java.lang.Object obj)
オブジェクトが null であっても文字列に変換する。

パラメータ:
obj - null でありうるオブジェクトを渡す。
戻り値:
オブジェクトが null であれば "(nil)" を、そうでなければ obj.toString() を返す。

setAncestor

void setAncestor(Node ancestor)
親ノードのセッタ。

パラメータ:
ancestor - 親ノードを渡す。

getAncestor

Node getAncestor()
親ノードのゲッタ。

戻り値:
親ノードを返す。

getRootLayout

Layout getRootLayout()
レイアウトのツリーにルート・レイアウトを探索する。

戻り値:
ルート・レイアウトを返す。

setChildren

void setChildren(java.util.List<Node> children)
子ノードのリストのセッタ

パラメータ:
children - ノードの子ノードのリストを渡す。

getChildren

public java.util.List<Node> getChildren()
子ノードのリストのゲッタ

戻り値:
ノードの子ノードのリストを返す。

isOrphanNode

boolean isOrphanNode(Node node)
ノードの親ノードが不明であることを許容するノードであることを判定する。
親ノードが不明であることを許容されるノードは、改ページと改行を指定するレコード (Record.PAGE_FEED_RECORD, Record.LINE_FEED_PAGE) のいずれか。

パラメータ:
node - 判定するノードを渡す。
戻り値:
親ノードが不明であることを許容するノードであれば true を、そうでなければ false を返す。

setAncestorOfChild

private Node setAncestorOfChild(Node node)
子ノードの親ノードをこのノードに設定する。

パラメータ:
node - 子ノードを渡す。
戻り値:
このノードを親ノードに設定した子ノードを返す。

adda

Node adda(Node[] children)
    throws ReportException
子ノードの配列を追加する。

パラメータ:
children - 子ノードの配列を渡す。
戻り値:
子ノードを追加したこのノードを返す。
例外:
レイアウトの整合性がない場合に - ReportException を投げる。
ReportException

add

Node add(Node... children)
   throws ReportException
可変個の子ノードを追加する。

パラメータ:
children - 可変個の子ノードを渡す。
戻り値:
子ノードを追加したこのノードを返す。
例外:
レイアウトの整合性がない場合に - ReportException を投げる。
ReportException

add

Node add(java.util.List<? extends Node> children)
   throws ReportException
子ノードのリストを追加する。

パラメータ:
children - 子ノードのリストを渡す。
戻り値:
子ノードを追加したこのノードを返す。
例外:
レイアウトの整合性がない場合に - ReportException を投げる。
ReportException

merge

Node merge(Node another)
     throws ReportException
別のノードの子ノードを、このノードに移しかえる。

パラメータ:
another - 別のノードを渡す。
戻り値:
別のノードの子ノードを移しかえたこのノードを返す。
例外:
レイアウトの整合性が正当でない場合に - ReportException を返す。
ReportException

verify

Node verify()
      throws ReportException
ノードの正当性を確認する。 親ノードが不明であることを許容しないノードが親ノードを持てば、正当であると判定する。

戻り値:
正当であることを確認したこのノードを返す。
例外:
正当でないノードであった場合に - ReportException を投げる。
ReportException