パッケージ org.opengion.fukurou.xml

クラス OGDocument

java.lang.Object
org.opengion.fukurou.xml.OGNode
org.opengion.fukurou.xml.OGDocument
public class OGDocument extends OGNode
JSP/XMLファイルを読み取って、構築される最上位の OGDocument オブジェクト を定義します。 JspSaxParser での read/write で構築される トップレベルの OGNode になります。
変更履歴:
5.1.8.0 (2010/07/01) 新規作成
導入されたバージョン:
JDK6.0,

  • コンストラクタの詳細

    • OGDocument

      public OGDocument()
      デフォルトコンストラクター NodeType を Document に設定し、デフォルトの OGNode を構築します。
      変更履歴:
      8.5.3.2 (2023/10/13) JDK21対応。警告: [this-escape] サブクラスが初期化される前の'this'エスケープの可能性があります

  • メソッドの詳細

    • getTopElement

      public OGElement getTopElement()
      最上位の エレメントを返します。 ノードが、まだ登録されていない、または、エレメントノードでない場合は、null が返されます。
      戻り値:
      最上位のエレメント

    • setFilename

      public void setFilename(String name)
      このドキュメントの読み込み元のファイル名をセットします。 ドキュメントの処理の可否を判断したり、デバッグ時に使用します。
      パラメータ:
      name - 読み込んだファイル名

    • getFilename

      public String getFilename()
      このドキュメントの読み込み元のファイル名を取得します。 ドキュメントの処理の可否を判断したり、デバッグ時に使用します。
      戻り値:
      読み込んだファイル名

    • setEncode

      public void setEncode(String encode)
      このドキュメントのXML宣言のエンコード属性をセットします(初期値:UTF-8)。 ドキュメントの出力時の XML 宣言に付与します。 null の設定が可能です。 null をセットすると、XML宣言出力時に、 encode 属性になにもセットしません。
      パラメータ:
      encode - XML宣言のエンコード属性

    • getEncode

      public String getEncode()
      このドキュメントのXML宣言のエンコード属性を取得します(初期値:UTF-8)。 ドキュメントの出力時の XML 宣言に付与します。 encode 属性になにもセットされていない場合は、null が返されます。
      戻り値:
      XML宣言のエンコード属性

    • getNameSpace

      public String getNameSpace()
      このドキュメントの "hybs-taglib.tld" の nameSpace(名前空間)を返します。 通常は、標準エンジンの場合は "og" になります。 社内システムの場合は、互換性の関係から、"mis" になっています。 Ver3 の時代は、"mis-taglib.tld" だったので、この処理はできません。
      戻り値:
      名前空間(存在しないときは、ゼロ文字列)
      変更履歴:
      5.2.1.0 (2010/10/01) 新規作成

    • setIdMap

      public void setIdMap(ConcurrentMap<String,OGElement> map)
      このドキュメントに含まれる id に対する、エレメントのマップをセットします。 id 指定されているエレメントは、特別にキャッシュされます。 また、ドキュメント中には、id は、一意に設定されていることとします。 複数、おなじ id が存在する場合は、(保障されませんが)性質上、最後に登録された エレメントが、設定されます。 ※ 6.4.3.1 (2016/02/12) で、セットするMapを、ConcurrentHashMap に置き換えているため、 key,value ともに、not null制限が入っています。
      パラメータ:
      map - エレメントのマップ
      変更履歴:
      6.4.3.3 (2016/03/04) ConcurrentHashMap を受け取ることを明確にするため、I/FをConcurrentMapに変更します。

    • getElementById

      public OGElement getElementById(String id)
      指定の id に対するエレメントを返します。 id に対するエレメントが存在しない場合は、null が返されます。
      パラメータ:
      id - 指定のID
      戻り値:
      OGエレメント
      変更履歴:
      6.4.3.3 (2016/03/04) ConcurrentHashMap の not null制限のチェック追加

    • toString

      public String toString()
      オブジェクトの文字列表現を返します。 ここでは、ドキュメントにXML宣言をつけた状態の文字列を返します。 基本的には、ドキュメントには、一つだけ エレメントを含むことになります。 よって、XML宣言をつけない状態で出力する場合は、#getTopElement() で エレメントを取得して、それを、toString() してください。
      オーバーライド:
      toString クラス内 OGNode
      戻り値:
      このオブジェクトの文字列表現
      関連項目:
      変更履歴:
      5.6.4.4 (2013/05/31) 改行３つを改行２つに置換します。
      このﾒｿｯﾄﾞは、nullを返しません