otsu.symphonie

クラス SyntaxConverter

java.lang.Object

otsu.symphonie.SyntaxConverter

public class SyntaxConverter
extends Object

構文木表現への変換機.

構文定義と文を与えると、構文定義に従い文を解析し、解析結果の 構文木をXML文字列またはJSON文字列にして返します。

構文定義法、入力解析法などの総合的な説明を パッケージ otsu.symphonieの説明 で行ってありますので、まずご覧ください。

 標準的使い方

標準的な使い方は次のようになります。

   SyntaxConverter syn= new SyntaxConverter();    // 変換機生成
   syn.readSyntaxFile("syntax.sn","utf-8");       // 構文定義読み込み
   String xml= syn.parseFile("data.txt","utf-8"
                             ,syn.AS_XML);        // 文解析(XMLで取得)
   String json= syn.parseFile("data.txt","utf-8"
                             ,syn.AS_JSON);       // 文解析(JSONで取得)

ただしjson形式は現在試験中であり、文字列型、数値型の表現分けなどの変更 が入る可能性があります。

 symphonieで用意されるその他の解析法

SyntaxConverterの他、symphonieには

(1)構文解析を行い要素毎にアプリケーションに情報を上げる
 SyntaxReader

(2)構文木をXML-DOMで取得する
 SyntaxDom

(3)ファイルを解析し構文木を表示するコマンド
 java -jar symphonie.jar syntax-check

(4)構文解析アプレット（試験中)
 SymphonieApp
などを用意してあります。。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static int	AS_JSON json文字列を得る
static int	AS_XML xml文字列を得る（デフォルト)
static int	KEEP_REDUNDANCY トークン値とトークン名が同じでも表示
static int	NO_ESCAPE XMLで&を実体参照エスケープ(&)にしない
static int	NO_INDENT インデントを付けない
static int	WITH_BEGIN_END トークンをタグで囲む
static int	WITH_TYPE (未)json時に値をタイプ別に書き分ける.デフォルトでは全て文字列

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SyntaxConverter()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	parse(BufferedReader br_, long option_) 構文解析を行い、構文木を文字列(XMLまたはjson)で得る.
String	parseFile(String fileName_, long option_) 指定ファイルの構文解析を行い、構文木を文字列(XMLまたはjson)で得る.
String	parseFile(String fileName_, String charSet_, long option_) 指定ファイルの構文解析を行い、構文木を文字列(XMLまたはjson)で得る.
String	parseString(String[] text_, long option_) 指定文字列の構文解析を行い、構文木を文字列(XMLまたはjson)で得る.
String	parseString(String text_, long option_) 指定文字列の構文解析を行い、構文木を文字列(XMLまたはjson)で得る.
Object	parseToObject(BufferedReader br_) 解析結果をObjectで得る(試験中).
Object	parseToObject(String text_) 解析結果をObjectで得る(試験中).
static void	printJSON(PrintWriter pr_, SyntaxReader sr_, long option_, boolean dispName_) 構文解析を行いjson出力を得る(試験中)。
void	readSyntax(BufferedReader br_) 構文定義を読み込む
void	readSyntaxFile(String fileName_) 構文定義ファイルを読む.
void	readSyntaxFile(String fileName_, String charSet_) 構文定義ファイルを読む.
void	readSyntaxString(String text_) 構文定義文字列を読む
void	readSyntaxString(String[] text_) 構文定義文字列配列を読む.

クラスから継承されたメソッド java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

NO_ESCAPE

public static final int NO_ESCAPE

XMLで&を実体参照エスケープ(&)にしない

関連項目:

定数フィールド値

WITH_BEGIN_END

public static final int WITH_BEGIN_END

トークンをタグで囲む

関連項目:

定数フィールド値

WITH_TYPE

public static final int WITH_TYPE

(未)json時に値をタイプ別に書き分ける.デフォルトでは全て文字列

関連項目:

定数フィールド値

KEEP_REDUNDANCY

public static final int KEEP_REDUNDANCY

トークン値とトークン名が同じでも表示

関連項目:

定数フィールド値

NO_INDENT

public static final int NO_INDENT

インデントを付けない

関連項目:

定数フィールド値

AS_JSON

public static final int AS_JSON

json文字列を得る

関連項目:

定数フィールド値

AS_XML

public static final int AS_XML

xml文字列を得る（デフォルト)

関連項目:

定数フィールド値

コンストラクタの詳細

SyntaxConverter

public SyntaxConverter()

メソッドの詳細

readSyntaxFile

public void readSyntaxFile(String fileName_)
                    throws Exception

構文定義ファイルを読む.

パラメータ:

fileName_ - 構文定義ファイル

例外:

Exception - 読み込み/解析失敗

readSyntaxFile

public void readSyntaxFile(String fileName_,
                           String charSet_)
                    throws Exception

構文定義ファイルを読む.

パラメータ:

fileName_ - 構文定義ファイル

charSet_ - ファイルの文字コード

例外:

Exception - 読み込み/解析失敗

readSyntaxString

public void readSyntaxString(String text_)
                      throws Exception

構文定義文字列を読む

パラメータ:

text_ - 構文定義記述

例外:

Exception - 解析失敗

readSyntaxString

public void readSyntaxString(String[] text_)
                      throws Exception

構文定義文字列配列を読む.

配列の各要素は行と見なされます。文字列自体に改行は入れないでください。

パラメータ:

text_ - 構文定義記述

例外:

Exception - 解析失敗

readSyntax

public void readSyntax(BufferedReader br_)
                throws Exception

構文定義を読み込む

パラメータ:

br_ - 構文定義の媒体

例外:

Exception - 解析失敗

parseFile

public String parseFile(String fileName_,
                        long option_)
                 throws Exception

指定ファイルの構文解析を行い、構文木を文字列(XMLまたはjson)で得る.

予めreadSyntax関数群でセットされた 構文定義に基づき構文解析を行い、結果を XML文字列またはjson文字列による構文木で得ます。

option_で表示形式が指定できます。

値	説明
AS_JSON	結果をjsonで得ます。
AS_XML	結果をXMLで得ます。これはデフォルトであり、指定の必要はありません。
NO_ESCAPE	XML出力で&を実体参照エスケープ(&)しません。
WITH_BEGIN_END	XML出力でトークンをタグで囲みます。
KEEP_REDUNDANCY	XML出力でトークン名とトークン値が同じでもトークン値を 省略しません。WITH_BEGIN_END指定の場合常にトークン値は 出ますので、この指定は意味を持ちません。
NO_INDENT	XML,JSON両出力共通で、インデント無しにします。

パラメータ:

fileName_ - 入力ファイル名

option_ - 表示オプション

戻り値:

解析結果(XMLまたはJSON)

例外:

Exception - 解析失敗

parseFile

public String parseFile(String fileName_,
                        String charSet_,
                        long option_)
                 throws Exception

指定ファイルの構文解析を行い、構文木を文字列(XMLまたはjson)で得る.

パラメータ:

fileName_ - 入力ファイル名

charSet_ - 入力ファイルの文字コード

option_ - オプションparseFile(String,long)参照

戻り値:

解析結果(XMLまたはJSON)

例外:

Exception - 解析失敗

parseString

public String parseString(String text_,
                          long option_)
                   throws Exception

指定文字列の構文解析を行い、構文木を文字列(XMLまたはjson)で得る.

パラメータ:

text_ - 解析すべき文字列

option_ - オプションparseFile(String,long)参照

戻り値:

解析結果(XMLまたはJSON)

例外:

Exception - 解析失敗

parseString

public String parseString(String[] text_,
                          long option_)
                   throws Exception

指定文字列の構文解析を行い、構文木を文字列(XMLまたはjson)で得る.

文字列配列による文を解析します。
配列の各要素は行と解釈されます。文字列自体には改行コードを入れない でください。

パラメータ:

text_ - 解析すべき文字列

option_ - オプションparseFile(String,long)参照

戻り値:

解析結果(XMLまたはJSON)

例外:

Exception - 解析失敗

parse

public String parse(BufferedReader br_,
                    long option_)
             throws Exception

構文解析を行い、構文木を文字列(XMLまたはjson)で得る.

パラメータ:

br_ - 解析すべき文の媒体

option_ - オプションparseFile(String,long)参照

戻り値:

解析結果(XMLまたはJSON)

例外:

Exception - 解析失敗

parseToObject

public Object parseToObject(BufferedReader br_)
                     throws Exception

解析結果をObjectで得る(試験中).

解析結果は次の型のObject構成となります。

• LinkedHashMap<String,Object>
• ArrayList<Object>
• String

パラメータ:

br_ - 解析すべき文の媒体

戻り値:

解析結果Object

例外:

Exception - 解析失敗

parseToObject

public Object parseToObject(String text_)
                     throws Exception

解析結果をObjectで得る(試験中).

解析結果は次の型のObject構成となります。

• LinkedHashMap<String,Object>
• ArrayList<Object>
• String

パラメータ:

text_ - 解析すべき文

戻り値:

解析結果Object

例外:

Exception - 解析失敗

printJSON

public static void printJSON(PrintWriter pr_,
                             SyntaxReader sr_,
                             long option_,
                             boolean dispName_)
                      throws Exception

構文解析を行いjson出力を得る(試験中)。

パラメータ:

pr_ - 出力先

sr_ - 構文定義と解析すべき文がセットされたSyntaxReader

option_ - オプションparseFile(String,long)参照

dispName_ - 構造の要素として名前を出す。falseを指定すること

例外:

Exception - 解析失敗