org.seasar.cms.wiki.engine
インタフェース WikiEngine

既知の実装クラスの一覧:

WikiEngineImpl

public interface WikiEngine

与えられた Wiki コンテンツを解釈し、指定された処理方法にて出力を行うエンジン。 最も簡単な利用方法は以下のとおり。

   WikiEngine engine;
   String html = engine.evaluate("This is wiki text.");
 

WikiEngine の実装クラスは、独自に実装する事も可能であるし、標準のエンジンを 利用することも可能。

作成者:

nishioka, someda

関連項目:

Getting Started

メソッドの概要

java.lang.String	evaluate(java.io.Reader reader) 引数で与えられている Wiki コンテンツを評価し、 その結果を文字列として返す。
java.lang.String	evaluate(java.io.Reader reader, WikiContext context) 引数で与えられている Wiki コンテンツを評価し、 その結果を文字列として返す。
java.lang.String	evaluate(java.lang.String text) 引数で与えられている Wiki コンテンツを評価し、 その結果を文字列として返す。
java.lang.String	evaluate(java.lang.String text, WikiContext context) 引数で与えられている Wiki コンテンツを評価し、 その結果を文字列として返す。
WikiBodyFactory	getBodyEvaluator() WikiBodyFactory を取得する。
WikiPageLinkFactory	getLinkFactory() WikiPageLinkFactory を取得する。
WikiParserFactory	getParserFactory() WikiParserFactory を取得する。
PluginExecuter	getPluginExecuter() PluginExecuter を取得する。
java.lang.String	getProperty(java.lang.String key) Wiki エンジンに設定されているプロパティを取得する。
WikiVisitorFactory	getVisitorFactory() WikiVisitorFactory を取得する。
void	merge(java.io.Reader reader, WikiContext context, java.io.OutputStream os) 引数で与えられている Wiki コンテンツを評価し OutputStream に書き出す。
void	merge(java.io.Reader reader, WikiContext context, java.io.Writer writer) 引数で与えられている Wiki コンテンツを評価し Writer に書き出す。
void	merge(java.lang.String text, WikiContext context, java.io.OutputStream os) 引数で与えられている Wiki コンテンツを評価し OutputStream に書き出す。
void	merge(java.lang.String text, WikiContext context, java.io.Writer writer) 引数で与えられている Wiki コンテンツを評価し Writer に書き出す。
void	setBodyEvaluator(WikiBodyFactory bodyEvaluator) WikiBodyFactory を設定する。
void	setLinkFactory(WikiPageLinkFactory linkFactory) WikiPageLinkFactory を設定する。
void	setParserFactory(WikiParserFactory parserFactory) WikiParserFactory を設定する。
void	setPluginExecuter(PluginExecuter pluginExecuter) PluginExecuter を設定する。
void	setProperties(java.util.Properties props) Wiki エンジンのプロパティを設定する。
void	setProperty(java.lang.String name, java.lang.String value) Wiki エンジンのプロパティを設定する。
void	setVisitorFactory(WikiVisitorFactory visitorFactory) WikiVisitorFactory を設定する。

メソッドの詳細

setProperties

void setProperties(java.util.Properties props)

Wiki エンジンのプロパティを設定する。 また同じキーのプロパティが設定されていれば上書きする。 デフォルトでは wikiengine.properties の内容が設定されている。

パラメータ:

props -

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)

Wiki エンジンのプロパティを設定する。 また同じキーのプロパティが設定されていれば上書きする。 デフォルトでは wikiengine.properties の内容が設定されている。

パラメータ:

props -

getProperty

java.lang.String getProperty(java.lang.String key)

Wiki エンジンに設定されているプロパティを取得する。

パラメータ:

key -

戻り値:

evaluate

java.lang.String evaluate(java.lang.String text,
                          WikiContext context)

引数で与えられている Wiki コンテンツを評価し、 その結果を文字列として返す。

パラメータ:

text -

context -

戻り値:

結果

evaluate

java.lang.String evaluate(java.lang.String text)

引数で与えられている Wiki コンテンツを評価し、 その結果を文字列として返す。

パラメータ:

text -

戻り値:

結果

evaluate

java.lang.String evaluate(java.io.Reader reader,
                          WikiContext context)

引数で与えられている Wiki コンテンツを評価し、 その結果を文字列として返す。

パラメータ:

reader -

context -

戻り値:

結果

evaluate

java.lang.String evaluate(java.io.Reader reader)

引数で与えられている Wiki コンテンツを評価し、 その結果を文字列として返す。

パラメータ:

reader -

戻り値:

結果

merge

void merge(java.io.Reader reader,
           WikiContext context,
           java.io.Writer writer)

引数で与えられている Wiki コンテンツを評価し Writer に書き出す。 PDF などの通常の文字列出力以外などの場合に利用する。

パラメータ:

reader -

context -

writer -

merge

void merge(java.lang.String text,
           WikiContext context,
           java.io.Writer writer)

引数で与えられている Wiki コンテンツを評価し Writer に書き出す。 PDF などの通常の文字列出力以外などの場合に利用する。

パラメータ:

text -

context -

writer -

merge

void merge(java.io.Reader reader,
           WikiContext context,
           java.io.OutputStream os)

引数で与えられている Wiki コンテンツを評価し OutputStream に書き出す。 PDF などの通常の文字列出力以外などの場合に利用する。

パラメータ:

reader -

context -

os -

merge

void merge(java.lang.String text,
           WikiContext context,
           java.io.OutputStream os)

引数で与えられている Wiki コンテンツを評価し OutputStream に書き出す。 PDF などの通常の文字列出力以外などの場合に利用する。

パラメータ:

text -

context -

os -

getLinkFactory

WikiPageLinkFactory getLinkFactory()

WikiPageLinkFactory を取得する。

戻り値:

getVisitorFactory

WikiVisitorFactory getVisitorFactory()

WikiVisitorFactory を取得する。

戻り値:

getParserFactory

WikiParserFactory getParserFactory()

WikiParserFactory を取得する。

戻り値:

getPluginExecuter

PluginExecuter getPluginExecuter()

PluginExecuter を取得する。

戻り値:

getBodyEvaluator

WikiBodyFactory getBodyEvaluator()

WikiBodyFactory を取得する。

戻り値:

setLinkFactory

void setLinkFactory(WikiPageLinkFactory linkFactory)

WikiPageLinkFactory を設定する。

パラメータ:

linkFactory -

setVisitorFactory

void setVisitorFactory(WikiVisitorFactory visitorFactory)

WikiVisitorFactory を設定する。

パラメータ:

visitorFactory -

setParserFactory

void setParserFactory(WikiParserFactory parserFactory)

WikiParserFactory を設定する。

パラメータ:

parserFactory -

setPluginExecuter

void setPluginExecuter(PluginExecuter pluginExecuter)

PluginExecuter を設定する。

パラメータ:

pluginExecuter -

setBodyEvaluator

void setBodyEvaluator(WikiBodyFactory bodyEvaluator)

WikiBodyFactory を設定する。

パラメータ:

bodyEvaluator -