shohaku.ogdl
クラス Ogdl

java.lang.Object
  拡張shohaku.ogdl.Ogdl

public class Ogdl
extends java.lang.Object

文字列をOGDL式として評価する機能を提供します。
OGDLの詳細な仕様は概要説明を参照してください。


コンストラクタの概要
Ogdl()
          初期化します。
 
メソッドの概要
 java.lang.Object evaluate(java.lang.String pattern)
          文字列の先頭から末尾までを、一つの式として評価して返却します。
 java.lang.Object evaluate(java.lang.String pattern, OgdlParseIndex offset)
          指定された文字列の位置から、一つの式を評価して返却します。
 java.lang.Class evaluateClass(java.lang.String pattern, OgdlParseIndex offset)
          指定された文字列の位置から、一つの式を評価して返却します。
 java.util.List evaluateList(java.lang.String pattern, OgdlParseIndex offset, char close)
          指定された文字列の位置から、コンマ区切りのリストとして評価して返却します。
 java.util.List evaluateList(java.lang.String pattern, OgdlParseIndex offset, char open, char close)
          指定された文字列の位置から、コンマ区切りのリストとして評価して返却します。
 java.util.Map evaluateMap(java.lang.String pattern, OgdlParseIndex offset, char close)
          指定された文字列の位置から、'=' で対応付けられたマッピングをコンマ区切りで列挙したマップとして評価して返却します。
 java.util.Map evaluateMap(java.lang.String pattern, OgdlParseIndex offset, char open, char close)
          指定された文字列の位置から、'=' で対応付けられたマッピングをコンマ区切りで列挙したマップとして評価して返却します。
 java.util.Set evaluateSet(java.lang.String pattern, OgdlParseIndex offset, char close)
          指定された文字列の位置から、コンマ区切りのセットとして評価して返却します。
 java.util.Set evaluateSet(java.lang.String pattern, OgdlParseIndex offset, char open, char close)
          指定された文字列の位置から、コンマ区切りのセットとして評価して返却します。
 OgdlContext getContext()
          コンテキストを取得します。
 void setContext(OgdlContext context)
          コンテキストを格納します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

Ogdl

public Ogdl()
初期化します。

メソッドの詳細

evaluate

public java.lang.Object evaluate(java.lang.String pattern)
                          throws OgdlSyntaxException
文字列の先頭から末尾までを、一つの式として評価して返却します。
式の終端が文字列の末尾でない場合は OgdlSyntaxException を発生させます。
また文字列の前後の空白文字は無視されます。

パラメータ:
pattern - 式構文
戻り値:
オブジェクト
例外:
OgdlSyntaxException - 構文例外

evaluate

public java.lang.Object evaluate(java.lang.String pattern,
                                 OgdlParseIndex offset)
                          throws OgdlSyntaxException
指定された文字列の位置から、一つの式を評価して返却します。
このメソッドは、式の終端が文字列の末尾でなくとも、例外を発生させません。
式の終端インデックスは引数の OgdlParseIndex に格納されて返却されます。
また文字列の前後の空白文字は無視されます。

パラメータ:
pattern - 式構文
offset - 開始インデックス
戻り値:
オブジェクト
例外:
OgdlSyntaxException - 構文例外

evaluateClass

public java.lang.Class evaluateClass(java.lang.String pattern,
                                     OgdlParseIndex offset)
                              throws OgdlSyntaxException
指定された文字列の位置から、一つの式を評価して返却します。
このメソッドは、式の終端が文字列の末尾でなくとも、例外を発生させません。
式の終端インデックスは引数の OgdlParseIndex に格納されて返却されます。
また文字列の前後の空白文字は無視されます。

パラメータ:
pattern - 式構文
offset - 開始インデックス
戻り値:
クラス
例外:
OgdlSyntaxException - 構文例外

evaluateList

public java.util.List evaluateList(java.lang.String pattern,
                                   OgdlParseIndex offset,
                                   char open,
                                   char close)
                            throws OgdlSyntaxException
指定された文字列の位置から、コンマ区切りのリストとして評価して返却します。
このメソッドは開始文字と終了文字の一致を検証します、正しく開始文字と終了文字で式の解析出来ない場合は例外が発生します。
また文字列の前後の空白文字は無視されます。
式の終端インデックスは引数の OgdlParseIndex に格納されて返却されます。
このメソッドは、式の終端が文字列の末尾でなくとも、例外を発生させません。

パラメータ:
pattern - 式構文
offset - 開始インデックス
open - 開始を示すリテラル文字
close - 終了を示すリテラル文字
戻り値:
リスト
例外:
OgdlSyntaxException - 構文例外

evaluateList

public java.util.List evaluateList(java.lang.String pattern,
                                   OgdlParseIndex offset,
                                   char close)
                            throws OgdlSyntaxException
指定された文字列の位置から、コンマ区切りのリストとして評価して返却します。
このメソッドは終了文字の一致を検証します、正しく終了文字で式の終端を解析出来ない場合は例外が発生します。
また文字列の前後の空白文字は無視されます。
式の終端インデックスは引数の OgdlParseIndex に格納されて返却されます。
このメソッドは、式の終端が文字列の末尾でなくとも、例外を発生させません。

パラメータ:
pattern - 式構文
offset - 開始インデックス
close - 終了を示すリテラル文字
戻り値:
リスト
例外:
OgdlSyntaxException - 構文例外

evaluateSet

public java.util.Set evaluateSet(java.lang.String pattern,
                                 OgdlParseIndex offset,
                                 char open,
                                 char close)
                          throws OgdlSyntaxException
指定された文字列の位置から、コンマ区切りのセットとして評価して返却します。
このメソッドは開始文字と終了文字の一致を検証します、正しく開始文字と終了文字で式の解析出来ない場合は例外が発生します。
また文字列の前後の空白文字は無視されます。
式の終端インデックスは引数の OgdlParseIndex に格納されて返却されます。
このメソッドは、式の終端が文字列の末尾でなくとも、例外を発生させません。

パラメータ:
pattern - 式構文
offset - 開始インデックス
open - 開始を示すリテラル文字
close - 終了を示すリテラル文字
戻り値:
セット
例外:
OgdlSyntaxException - 構文例外

evaluateSet

public java.util.Set evaluateSet(java.lang.String pattern,
                                 OgdlParseIndex offset,
                                 char close)
                          throws OgdlSyntaxException
指定された文字列の位置から、コンマ区切りのセットとして評価して返却します。
このメソッドは終了文字の一致を検証します、正しく終了文字で式の終端を解析出来ない場合は例外が発生します。
また文字列の前後の空白文字は無視されます。
式の終端インデックスは引数の OgdlParseIndex に格納されて返却されます。
このメソッドは、式の終端が文字列の末尾でなくとも、例外を発生させません。

パラメータ:
pattern - 式構文
offset - 開始インデックス
close - 終了を示すリテラル文字
戻り値:
セット
例外:
OgdlSyntaxException - 構文例外

evaluateMap

public java.util.Map evaluateMap(java.lang.String pattern,
                                 OgdlParseIndex offset,
                                 char open,
                                 char close)
                          throws OgdlSyntaxException
指定された文字列の位置から、'=' で対応付けられたマッピングをコンマ区切りで列挙したマップとして評価して返却します。
このメソッドは開始文字と終了文字の一致を検証します、正しく開始文字と終了文字で式の解析出来ない場合は例外が発生します。
また文字列の前後の空白文字は無視されます。
式の終端インデックスは引数の OgdlParseIndex に格納されて返却されます。
このメソッドは、式の終端が文字列の末尾でなくとも、例外を発生させません。

パラメータ:
pattern - 式構文
offset - 開始インデックス
open - 開始を示すリテラル文字
close - 終了を示すリテラル文字
戻り値:
マップ
例外:
OgdlSyntaxException - 構文例外

evaluateMap

public java.util.Map evaluateMap(java.lang.String pattern,
                                 OgdlParseIndex offset,
                                 char close)
                          throws OgdlSyntaxException
指定された文字列の位置から、'=' で対応付けられたマッピングをコンマ区切りで列挙したマップとして評価して返却します。
このメソッドは終了文字の一致を検証します、正しく終了文字で式の終端を解析出来ない場合は例外が発生します。
また文字列の前後の空白文字は無視されます。
式の終端インデックスは引数の OgdlParseIndex に格納されて返却されます。
このメソッドは、式の終端が文字列の末尾でなくとも、例外を発生させません。

パラメータ:
pattern - 式構文
offset - 開始インデックス
close - 終了を示すリテラル文字
戻り値:
マップ
例外:
OgdlSyntaxException - 構文例外

getContext

public OgdlContext getContext()
コンテキストを取得します。

戻り値:
コンテキスト

setContext

public void setContext(OgdlContext context)
コンテキストを格納します。

パラメータ:
context - コンテキスト