shohaku.ginkgo
クラス Ginkgo

java.lang.Object
  拡張shohaku.ginkgo.Ginkgo

public class Ginkgo
extends java.lang.Object

XMLドキュメントをオブジェクトにマッピングし生成されたオブジェクトを構造化する実行機能を提供します。
XMLドキュメントからのデータ生成に着目したライブラリです。

このライブラリはXMLで定義された情報をshohaku.ginkgo.NodeCompositeRuleの指定するルールに基づきshohaku.ginkgo.Node のツリー構造に変換します。
値型のshohaku.ginkgo.Nodeは自身と内包する要素に基づきオブジェクトを生成します。
複数のノードを再起的に合成する事により、単純なデータ型の集合から複雑なデータ構造を生成します。
また一度定義されたノードは一定の依存関係を含むものの相対的に独立するため複数の文脈で再利用することができます。

Ginkgoのデフォルト実装には基本型と利用頻度が高いと思われるデータ型、および大半のオブジェクトが生成可能な汎用型のノードが提供されています。
また複雑な構造を容易に生成するために反復処理や条件分岐を実現する制御インターフェースが提供されています。
デフォルトノード以外の独自のノードの追加やデフォルトノードとの交換、使用するノードの選択、制約の追加も容易に実現できます。
またXMLタグ名の交換やXML属性に対するデフォルト値の指定や別名の指定を定義レベルで指定出来ます。
この仕様の応用からカスタマイズされたデータ構造の再定義や、汎用ノードを基に特殊なノードを定義する事も可能です。

Ginkgoは汎用的なデータ構造を基に複雑なデータ構造を生成したい場合に有用に設計されています。
解決を求められている問題領域によっては他のAPIの使用を検討してください。

使用例としてshohaku.koshoパッケージを参照する事が出来ます。


コンストラクタの概要
Ginkgo()
          デフォルトコンストラクタ。
Ginkgo(DocumentCompositeRule docRule)
          ドキュメントの合成ルールを指定して初期化します。
 
メソッドの概要
 java.lang.ClassLoader getClassLoader()
          解析処理に使用するClassLoaderを返却します.
 Document getDocument()
          解析中又は直前に解析したドキュメントを返却します。
 DocumentCompositeRule getDocumentCompositeRule()
          ドキュメントの合成ルールを返却します。
 org.apache.commons.logging.Log getLogger()
          解析処理プロセス内で使用するログを返却します。
 NodeCompositeRule getNodeCompositeRule()
          解析中又は直前に使用した構成ルールを返却します。
 SAXDocumentParser getSAXDocumentParser()
          解析処理に使用するSAXパーサーを返却します。
 boolean isErrThrowable()
          解析処理内でエラーが発生した場合に例外を発生させるかを示すフラグを返却します(デフォルトはfalse)。
 void parse(NodeCompositeRule rule, org.xml.sax.InputSource input)
          解析処理を実行します。
 void parse(NodeCompositeRule rule, org.xml.sax.InputSource input, Document parent)
          解析処理を実行します。
 void parse(NodeCompositeRule rule, java.io.InputStream inStream)
          解析処理を実行します。
 void parse(NodeCompositeRule rule, java.io.InputStream inStream, Document parent)
          解析処理を実行します。
 void setClassLoader(java.lang.ClassLoader classLoader)
          解析処理に使用するClassLoaderを設定します.
 void setErrThrowable(boolean errThrowable)
          解析処理内でエラーが発生した場合に例外を発生させるかを示すフラグを格納します。
 void setLogger(org.apache.commons.logging.Log log)
          解析処理プロセス内で使用するログを格納します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

Ginkgo

public Ginkgo()
デフォルトコンストラクタ。


Ginkgo

public Ginkgo(DocumentCompositeRule docRule)
ドキュメントの合成ルールを指定して初期化します。

パラメータ:
docRule - ドキュメントの合成ルール
メソッドの詳細

parse

public void parse(NodeCompositeRule rule,
                  java.io.InputStream inStream)
解析処理を実行します。

パラメータ:
rule - 構成ルール
inStream - XMLデータ入力ストリーム
例外:
GinkgoException - 構成する情報に何らかの誤りが在る場合発生します。

parse

public void parse(NodeCompositeRule rule,
                  java.io.InputStream inStream,
                  Document parent)
解析処理を実行します。

パラメータ:
rule - 構成ルール
inStream - XMLデータ入力ストリーム
parent - 親のドキュメントオブジェクト
例外:
GinkgoException - 構成する情報に何らかの誤りが在る場合発生します。

parse

public void parse(NodeCompositeRule rule,
                  org.xml.sax.InputSource input)
解析処理を実行します。

パラメータ:
rule - 構成ルール
input - XMLデータソース
例外:
GinkgoException - 構成する情報に何らかの誤りが在る場合発生します。

parse

public void parse(NodeCompositeRule rule,
                  org.xml.sax.InputSource input,
                  Document parent)
解析処理を実行します。

パラメータ:
rule - 構成ルール
input - XMLデータソース
parent - 親のドキュメントオブジェクト
例外:
GinkgoException - 構成する情報に何らかの誤りが在る場合発生します。

getLogger

public org.apache.commons.logging.Log getLogger()
解析処理プロセス内で使用するログを返却します。

戻り値:
ログ

setLogger

public void setLogger(org.apache.commons.logging.Log log)
解析処理プロセス内で使用するログを格納します。

パラメータ:
log - ログ

getSAXDocumentParser

public SAXDocumentParser getSAXDocumentParser()
解析処理に使用するSAXパーサーを返却します。

戻り値:
解析処理に使用するSAXパーサー

getClassLoader

public java.lang.ClassLoader getClassLoader()
解析処理に使用するClassLoaderを返却します.

戻り値:
解析処理に使用するClassLoader

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)
解析処理に使用するClassLoaderを設定します.

パラメータ:
classLoader - 解析処理に使用するClassLoader

isErrThrowable

public boolean isErrThrowable()
解析処理内でエラーが発生した場合に例外を発生させるかを示すフラグを返却します(デフォルトはfalse)。

戻り値:
trueの場合は解析処理内でエラーが発生した場合に例外を発生させる

setErrThrowable

public void setErrThrowable(boolean errThrowable)
解析処理内でエラーが発生した場合に例外を発生させるかを示すフラグを格納します。
デフォルトでは、この値はfalseに設定されます。

パラメータ:
errThrowable - trueの場合は解析処理内でエラーが発生した場合に例外を発生させる

getDocument

public Document getDocument()
解析中又は直前に解析したドキュメントを返却します。

戻り値:
解析中又は直前に解析したドキュメント

getNodeCompositeRule

public NodeCompositeRule getNodeCompositeRule()
解析中又は直前に使用した構成ルールを返却します。

戻り値:
解析中又は直前に使用した構成ルール

getDocumentCompositeRule

public DocumentCompositeRule getDocumentCompositeRule()
ドキュメントの合成ルールを返却します。

戻り値:
ドキュメントの合成ルール