簡易APIリファレンス ※APIリファレンス(JavaDoc)に近日中に統合予定。



(1)ParseIFクラス


☆テンプレートドキュメント(XML,XHTML,HTML)のパーサファクトリ生成

  ParserFactory#buildメソッドを使用します。

  ParserFactory#build(ドキュメント種別,ドキュメントの絶対パス,エンコーディング名)
  
  ドキュメント種別
    ParserIF.HTML:HTML用
    ParserIF.XHTML:XHTML用
    ParserIF.XML:XML用

☆テンプレートドキュメント(XML,XHTML,HTML)のパーサ取得

  ParserFactory#parserを使用します。

  
  ParserFactory#parser()


☆要素検索

  elementメソッドを使用します。

  elementメソッドは先頭から検索を行い、最初にヒットした要素の情報をElementオブジェクトに格納して返します。
  
  テンプレートドキュメント上の対象となる要素が要素名のみで識別可能な場合は element(要素名)

  対象となる要素が要素名のみで識別できない場合は element(要素名,"属性名","属性値")
  対象となる要素を識別属性「属性名="属性値"」で検索したい場合は element("属性名","属性値")
    
  この場合、テンプレートドキュメント上の対象となる要素に識別属性「属性名="属性値"」を追加する必要が
  あります。

  elementメソッドは検索に失敗した場合、NULLを返します。

☆要素の属性編集

  attributeメソッドを使用します。

  attribute(Elementオブジェクト,"属性名","属性値")

  属性名で指定した属性がある場合には更新し、ない場合には追加します。

☆要素の属性消去

  removeAttributeメソッドを使用します。

  removeAttribute(Elementオブジェクト,"属性名")

☆要素の内容の編集

  contentメソッドを使用します。

  content(Elementオブジェクト,"置換テキスト")

☆要素の属性値取得

  attributeメソッドを使用します。
  
  attribute(Elementオブジェクト,"属性名")

☆要素の内容の取得

  contentメソッドを使用します。
  
  content(Elementオブジェクト)

☆要素の消去

  removeElementメソッドを使用します。

  removeElement(Elementオブジェクト)

☆コメントタグ(<!-- @タグ名 id="識別名" -->要素<!-- /@タグ名-->)の検索


  cxTagメソッドを使用します。

  cxTagメソッドは先頭から検索を行い、最初にヒットしたタグの情報をElementオブジェクトに格納して返します。
  
  cxTag("タグ名","識別名")
  cxTag("識別名")

☆タグ及びコメントタグの要素の動的変更を伴うループ

  executeメソッドを使用します。

  execute(Elementオブジェクト,Hookerクラスのサブクラスのインスタンス)
  execute(Elementオブジェクト,Hookerクラスのサブクラスのインスタンス,Listオブジェクト)

  処理の実体はHookerクラスのサブクラスに記述します。

☆XML文書の取得(XMLParserクラスのみ)

  documentメソッドを使用します。Stringオブジェクトを返り値とします。

  document()

☆HTTP出力

  HttpPrinter#printメソッドを使用します。
  
  HttpPrinter#print(パーサ)

☆GZIP圧縮HTTP出力

  GZipHttpPrinter#printメソッドを使用します。
  
  GZipHttpPrinter#print(パーサ)



(2-1)Hookerクラス

☆execute(Elementオブジェクト,Hookerクラスのサブクラスのインスタンス)に対応するメソッド

  下記のメソッドをサブクラスでオーバーライドし実処理を記述します。

  execute(Element xt)

(2-2)Looperクラス

☆execute(Elementオブジェクト,Looperクラスのサブクラスのインスタンス,Listオブジェクト)に対応するメソッド

  下記のメソッドをサブクラスでオーバーライドし実処理を記述します。

  execute(Element xt,Object obj)


(C)Yasumasa Ashida