shohaku.shoin.factory
クラス AbstractGinkgoResourceSetFactory

java.lang.Object
  拡張shohaku.shoin.factory.AbstractResourceSetFactory
      拡張shohaku.shoin.factory.AbstractIOResourceSetFactory
          拡張shohaku.shoin.factory.AbstractGinkgoResourceSetFactory
すべての実装インタフェース:
GinkgoResourceSetFactory, IOResourceSetFactory, ResourceSetFactory
直系の既知のサブクラス:
BindMethodFactory, ClassBindXMLProperties, ClassMappingXMLProperties, ComponentFactory, ShoinContextFactory, XMLProperties

public abstract class AbstractGinkgoResourceSetFactory
extends AbstractIOResourceSetFactory
implements GinkgoResourceSetFactory

Ginkgo API 用いたリソース集合を生成するファクトリの抽象実装を提供します。


コンストラクタの概要
AbstractGinkgoResourceSetFactory()
          プロパティを初期値で初期化します。
 
メソッドの概要
protected  java.lang.ClassLoader findClassLoader()
          使用するクラスローダを検索して返却します。
 java.lang.ClassLoader getClassLoader()
          リソースの生成に使用するクラスローダを返却します。
protected  shohaku.ginkgo.NodeCompositeRule getDefaultNodeCompositeRule()
          デフォルトの構成ルールを返却します。
 shohaku.ginkgo.DocumentCompositeRule getDocumentCompositeRule()
          リソースの生成に使用する銀杏APIのドキュメント構成ルールを返却します。
 shohaku.ginkgo.NodeCompositeRule getNodeCompositeRule()
          リソースの生成に使用する銀杏APIのノード構成ルールを返却します。
 shohaku.ginkgo.Document getParentDocument()
          リソースの生成に指定する親のドキュメントを返却します。
 shohaku.ginkgo.Document getParseDocument()
          直前に解析したドキュメントを返却します。
 ResourceSet getResourceSet()
          Ginkgo API 用いてIOリソースから、リソース集合を生成し返却します。
protected abstract  void initValues(java.util.Map lookup, shohaku.ginkgo.TagNode root, int index)
          リソースの初期化および登録します。
protected  void load(shohaku.ginkgo.Ginkgo ginkgo, java.util.Map lookup, shohaku.core.resource.IOResource[] inreses)
          IOリソースからリソースを読み込みます。
protected  void load(shohaku.ginkgo.Ginkgo ginkgo, java.util.Map lookup, shohaku.core.resource.IOResource inres, int index)
          IOリソースからリソースを読み込みます。
protected  java.util.Map newResourceSetMap()
          リソース集合を格納するマップを生成して返却します。
protected  ResourceSet newResourceSetObject(java.util.Map lookup)
          マップからリソース集合を生成して返却します。
 void setClassLoader(java.lang.ClassLoader classLoader)
          リソースの生成に使用するクラスローダを格納します。
 void setDocumentCompositeRule(shohaku.ginkgo.DocumentCompositeRule documentCompositeRule)
          リソースの生成に使用する銀杏APIのドキュメント構成ルールを格納します。
 void setNodeCompositeRule(shohaku.ginkgo.NodeCompositeRule nodeCompositeRule)
          リソースの生成に使用する銀杏APIのノード構成ルールを格納します。
 void setParentDocument(shohaku.ginkgo.Document parentDocument)
          リソースの生成に指定する親のドキュメントを格納します。
protected  void setParseDocument(shohaku.ginkgo.Document parseDoc)
          直前に解析したドキュメントを格納します。
 
クラス shohaku.shoin.factory.AbstractIOResourceSetFactory から継承したメソッド
getIOResources, setIOResources
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース shohaku.shoin.IOResourceSetFactory から継承したメソッド
getIOResources, setIOResources
 

コンストラクタの詳細

AbstractGinkgoResourceSetFactory

public AbstractGinkgoResourceSetFactory()
プロパティを初期値で初期化します。

メソッドの詳細

getResourceSet

public ResourceSet getResourceSet()
                           throws ResourceSetCreationException
インタフェース GinkgoResourceSetFactory の記述:
Ginkgo API 用いてIOリソースから、リソース集合を生成し返却します。

定義:
インタフェース GinkgoResourceSetFactory 内の getResourceSet
戻り値:
リソース集合
例外:
ResourceSetCreationException - リソース集合の生成に失敗した場合
GinkgoException の発生時も起因例外として格納して、この例外を返す。

getNodeCompositeRule

public shohaku.ginkgo.NodeCompositeRule getNodeCompositeRule()
インタフェース GinkgoResourceSetFactory の記述:
リソースの生成に使用する銀杏APIのノード構成ルールを返却します。

定義:
インタフェース GinkgoResourceSetFactory 内の getNodeCompositeRule
戻り値:
銀杏APIの構成ルール

setNodeCompositeRule

public void setNodeCompositeRule(shohaku.ginkgo.NodeCompositeRule nodeCompositeRule)
インタフェース GinkgoResourceSetFactory の記述:
リソースの生成に使用する銀杏APIのノード構成ルールを格納します。

定義:
インタフェース GinkgoResourceSetFactory 内の setNodeCompositeRule
パラメータ:
nodeCompositeRule - 銀杏APIの構成ルール

getDocumentCompositeRule

public shohaku.ginkgo.DocumentCompositeRule getDocumentCompositeRule()
インタフェース GinkgoResourceSetFactory の記述:
リソースの生成に使用する銀杏APIのドキュメント構成ルールを返却します。

定義:
インタフェース GinkgoResourceSetFactory 内の getDocumentCompositeRule
戻り値:
銀杏APIのドキュメント構成ルール

setDocumentCompositeRule

public void setDocumentCompositeRule(shohaku.ginkgo.DocumentCompositeRule documentCompositeRule)
インタフェース GinkgoResourceSetFactory の記述:
リソースの生成に使用する銀杏APIのドキュメント構成ルールを格納します。

定義:
インタフェース GinkgoResourceSetFactory 内の setDocumentCompositeRule
パラメータ:
documentCompositeRule - 銀杏APIのドキュメント構成ルール

getParentDocument

public shohaku.ginkgo.Document getParentDocument()
インタフェース GinkgoResourceSetFactory の記述:
リソースの生成に指定する親のドキュメントを返却します。

定義:
インタフェース GinkgoResourceSetFactory 内の getParentDocument
戻り値:
親のドキュメント

setParentDocument

public void setParentDocument(shohaku.ginkgo.Document parentDocument)
インタフェース GinkgoResourceSetFactory の記述:
リソースの生成に指定する親のドキュメントを格納します。

定義:
インタフェース GinkgoResourceSetFactory 内の setParentDocument
パラメータ:
parentDocument - 親のドキュメント

getParseDocument

public shohaku.ginkgo.Document getParseDocument()
インタフェース GinkgoResourceSetFactory の記述:
直前に解析したドキュメントを返却します。

定義:
インタフェース GinkgoResourceSetFactory 内の getParseDocument
戻り値:
直前に解析したドキュメント

getClassLoader

public java.lang.ClassLoader getClassLoader()
インタフェース GinkgoResourceSetFactory の記述:
リソースの生成に使用するクラスローダを返却します。

定義:
インタフェース GinkgoResourceSetFactory 内の getClassLoader
戻り値:
クラスローダ

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)
インタフェース GinkgoResourceSetFactory の記述:
リソースの生成に使用するクラスローダを格納します。

定義:
インタフェース GinkgoResourceSetFactory 内の setClassLoader
パラメータ:
classLoader - クラスローダ

findClassLoader

protected java.lang.ClassLoader findClassLoader()
使用するクラスローダを検索して返却します。

戻り値:
クラスローダ

newResourceSetMap

protected java.util.Map newResourceSetMap()
リソース集合を格納するマップを生成して返却します。拡張ポイントです。

戻り値:
リソース集合を格納するマップ

newResourceSetObject

protected ResourceSet newResourceSetObject(java.util.Map lookup)
マップからリソース集合を生成して返却します。拡張ポイントです。

パラメータ:
lookup - リソースを格納するマップ
戻り値:
リソース集合

setParseDocument

protected void setParseDocument(shohaku.ginkgo.Document parseDoc)
直前に解析したドキュメントを格納します。

パラメータ:
parseDoc - 直前に解析したドキュメント

load

protected void load(shohaku.ginkgo.Ginkgo ginkgo,
                    java.util.Map lookup,
                    shohaku.core.resource.IOResource[] inreses)
             throws ResourceSetCreationException
IOリソースからリソースを読み込みます。

パラメータ:
ginkgo - Ginkgo
lookup - リソースを格納するマップ
inreses - IOリソースの配列
例外:
ResourceSetCreationException - リソース集合の生成に失敗した場合

load

protected void load(shohaku.ginkgo.Ginkgo ginkgo,
                    java.util.Map lookup,
                    shohaku.core.resource.IOResource inres,
                    int index)
             throws ResourceSetCreationException
IOリソースからリソースを読み込みます。

パラメータ:
ginkgo - Ginkgo
lookup - リソースを格納するマップ
inres - IOリソース
index - IOリソースのインデックス
例外:
ResourceSetCreationException - リソース集合の生成に失敗した場合

getDefaultNodeCompositeRule

protected shohaku.ginkgo.NodeCompositeRule getDefaultNodeCompositeRule()
デフォルトの構成ルールを返却します。

戻り値:
デフォルトの構成ルール

initValues

protected abstract void initValues(java.util.Map lookup,
                                   shohaku.ginkgo.TagNode root,
                                   int index)
リソースの初期化および登録します。

パラメータ:
lookup - リソースを格納するマップ
root - ルートタグ
index - IOリソースのインデックス