info.bix.tokai.bixpp.io
クラス BIXppIO

java.lang.Object
  info.bix.tokai.bixpp.io.BIXppIO

public final class BIXppIO
extends java.lang.Object

BIX-ppファイルとBIXppオブジェクトの相互変換機能及び CSVファイルのインポート・エクスポートの機能を持つクラスです。

BIX-ppファイルからBIXppオブジェクトの変換では、 Fileオブジェクト、URLオブジェクト、 OutputStreamオブジェクトのうち1つを指定します。 BIXppオブジェクトからBIX-ppファイルへの変換では、 BIXppオブジェクトと、Fileオブジェクト又は OutputStreamオブジェクトのどちらかを指定します。 CSVファイルのインポートでは、Fileオブジェクト、URLオブジェクト、 OutputStreamオブジェクトのうち1つを指定します。 CSVファイルのエクスポートでは、BIXppオブジェクトと、Fileオブジェクト又は OutputStreamオブジェクトのどちらかを指定します。

例えば、"http://w3.fb.u-tokai.ac.jp/bix-pp/samples/lettuce/lettuce-j.xml"からBIX-ppファイルを 読み込み、CSVファイルの"inport.csv"をインポート。 この2つのファイルからできたBIXppオブジェクトを元に BIX-ppファイルの"result.xml"と、CSVファイルの"export.csv"を生成するコードを以下に示します。

     try {
 BIXpp bixpp;

 bixpp = BIXppIO
 .read(new URL(
 "http://w3.fb.u-tokai.ac.jp/bix-pp/samples/lettuce/lettuce-j.xml"));

 BIXppIO.importCSV(bixpp, new File("inport.csv").toURL());

 BIXppIO.write(bixpp, new File("result.xml"));

 BIXppIO.exportCSV(bixpp, new File("export.csv"));

 } catch (XMLException e) {
 System.out.println("XMLExceptionが発生");
 } catch (FileNotFoundException e) {
 e.printStackTrace();
 } catch (MalformedURLException e) {
 e.printStackTrace();
 } catch (IOException e) {
 e.printStackTrace();
 }
 

作成者:

Shiozawa

関連項目:

BIXpp

メソッドの概要

static void	exportCSV(BIXpp bixpp, java.io.File csvFile) Base64やHexのデータや、 Vectorを除いた 全てのデータをCSV形式でエクスポートします。
static void	exportCSV(BIXpp bixpp, java.io.File csvFile, long[] indices) 指定されたIndexのデータをCSVファイルにエクスポートします。
static BIXpp	importCSV(BIXpp bixpp, java.io.File csvFile) CSVファイルを指定して、BIXppオブジェクトへインポートします。
static BIXpp	importCSV(BIXpp bixpp, java.io.InputStream csvStream) CSVファイルのバイト入力ストリームを指定して、BIXppオブジェクトへインポートします。
static BIXpp	importCSV(BIXpp bixpp, java.net.URL csvURL) CSVファイルのURLを指定して、BIXppオブジェクトへインポートします。
static BIXpp	read(java.io.File bixppFile) BIX-ppファイルを指定して BIXppオブジェクトへ変換します。
static BIXpp	read(java.io.File bixppFile, boolean validate) BIX-ppファイルを指定して BIXppオブジェクトへ変換します。
static BIXpp	read(java.io.InputStream bixppStream) BIX-ppファイルのバイト入力ストリームを指定して、BIXppオブジェクトへ変換します。
static BIXpp	read(java.io.InputStream bixppStream, boolean validate) BIX-ppファイルのバイト入力ストリームを指定して、BIXppオブジェクトへ変換します。
static BIXpp	read(java.net.URL bixppURL) BIX-ppファイルのURLを指定して、BIXppオブジェクトへ変換します。
static BIXpp	read(java.net.URL bixppURL, boolean validate) BIX-ppファイルのURLを指定して、BIXppオブジェクトへ変換します。
static void	write(BIXpp bixpp, java.io.File bixppFile) BIXppオブジェクトを、指定したファイル名のBIX-ppファイルに変換します。
static void	write(BIXpp bixpp, java.io.OutputStream bixppStream) BIXppオブジェクトを、BIX-ppファイルに変換します。

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

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

メソッドの詳細

read

public static BIXpp read(java.io.File bixppFile)
                  throws ValidationException,
                         XMLException,
                         java.io.IOException

BIX-ppファイルを指定して BIXppオブジェクトへ変換します。 BIX-ppファイルが規格通りに書かれているかどうかの、妥当性チェックを行いません。

パラメータ:

bixppFile - BIX-ppファイルを表すFileオブジェクト

戻り値:

BIXppオブジェクト

例外:

java.lang.IllegalArgumentException - いずれかの引数がnullだった場合

ValidationException - BIX-ppファイルが規格通りに記述されていなかった場合

XMLException - XMLの記述が間違っていたり、変換できないデータが存在した場合

java.io.IOException - BIX-ppファイルの読み込みに失敗した場合

read

public static BIXpp read(java.net.URL bixppURL)
                  throws ValidationException,
                         XMLException,
                         java.io.IOException

BIX-ppファイルのURLを指定して、BIXppオブジェクトへ変換します。 BIX-ppファイルが規格通りに書かれているかどうかの、妥当性チェックを行いません。

パラメータ:

bixppURL - BIX-ppファイルのURL

戻り値:

BIXppオブジェクト

例外:

java.lang.IllegalArgumentException - いずれかの引数がnullだった場合

ValidationException - BIX-ppファイルが規格通りに記述されていなかった場合

XMLException - XMLの記述が間違っていたり、変換できないデータが存在した場合

java.io.IOException - BIX-ppファイルの読み込みに失敗した場合

read

public static BIXpp read(java.io.InputStream bixppStream)
                  throws ValidationException,
                         XMLException,
                         java.io.IOException

BIX-ppファイルのバイト入力ストリームを指定して、BIXppオブジェクトへ変換します。 BIX-ppファイルが規格通りに書かれているかどうかの、妥当性チェックを行いません。

パラメータ:

bixppStream - BIX-ppファイルのInputStreamオブジェクト

戻り値:

BIXppオブジェクト

例外:

java.lang.IllegalArgumentException - いずれかの引数がnullだった場合

ValidationException - BIX-ppファイルが規格通りに記述されていなかった場合

XMLException - XMLの記述が間違っていたり、変換できないデータが存在した場合

java.io.IOException - BIX-ppファイルの読み込みに失敗した場合

write

public static void write(BIXpp bixpp,
                         java.io.File bixppFile)
                  throws java.io.IOException

BIXppオブジェクトを、指定したファイル名のBIX-ppファイルに変換します。

パラメータ:

bixpp - BIXppオブジェクト

bixppFile - BIX-ppファイルを表すFileオブジェクト

例外:

java.lang.IllegalArgumentException - いずれかの引数がnullだった場合に発生

java.io.IOException - BIX-ppファイルの出力に失敗した場合

write

public static void write(BIXpp bixpp,
                         java.io.OutputStream bixppStream)
                  throws java.io.IOException

BIXppオブジェクトを、BIX-ppファイルに変換します。

パラメータ:

bixpp - BIXppオブジェクト

bixppStream - BIX-ppファイルのOutputStreamオブジェクト

例外:

java.lang.IllegalArgumentException - いずれかの引数がnullだった場合に発生

java.io.IOException - BIX-ppファイルの出力に失敗した場合

importCSV

public static BIXpp importCSV(BIXpp bixpp,
                              java.io.File csvFile)
                       throws java.io.IOException

CSVファイルを指定して、BIXppオブジェクトへインポートします。

パラメータ:

bixpp - インポートされるBIXppオブジェクト

csvFile - インポートするCSVファイルを表すFileオブジェクト

戻り値:

インポート済みのBIXppオブジェクト

例外:

java.lang.IllegalArgumentException - csvFileがnullだった場合に発生

java.io.IOException - CSVファイルの読み込みに失敗した場合

importCSV

public static BIXpp importCSV(BIXpp bixpp,
                              java.net.URL csvURL)
                       throws java.io.IOException

CSVファイルのURLを指定して、BIXppオブジェクトへインポートします。

パラメータ:

bixpp - インポートされるBIXppオブジェクト

csvURL - インポートするCSVファイルのURL

戻り値:

インポート済みのBIXppオブジェクト

例外:

java.lang.IllegalArgumentException - csvURLがnullだった場合に発生

java.io.IOException - CSVファイルの読み込みに失敗した場合

importCSV

public static BIXpp importCSV(BIXpp bixpp,
                              java.io.InputStream csvStream)
                       throws java.io.IOException

CSVファイルのバイト入力ストリームを指定して、BIXppオブジェクトへインポートします。

パラメータ:

bixpp - インポートされるBIXppオブジェクト

csvStream - インポートするCSVファイルのInputStreamオブジェクト

戻り値:

インポート済みのBIXppオブジェクト

例外:

java.lang.IllegalArgumentException - csvStreamがnullだった場合に発生

java.io.IOException - CSVファイルの読み込みに失敗した場合

exportCSV

public static void exportCSV(BIXpp bixpp,
                             java.io.File csvFile)
                      throws java.io.IOException

Base64やHexのデータや、 Vectorを除いた 全てのデータをCSV形式でエクスポートします。

パラメータ:

bixpp - エクスポートされるデータを含むBIXppオブジェクト

csvFile - エクスポートするCSVファイルを表すFileオブジェクト

例外:

java.lang.IllegalArgumentException - いずれかの引数がnullだった場合に発生

java.io.IOException - CSVファイルの出力に失敗した場合

exportCSV

public static void exportCSV(BIXpp bixpp,
                             java.io.File csvFile,
                             long[] indices)
                      throws java.io.IOException

指定されたIndexのデータをCSVファイルにエクスポートします。 複数のIndexを配列で指定します。

パラメータ:

bixpp - エクスポートされるデータを含むBIXppオブジェクト

csvFile - エクスポートするCSVファイルを表すFileオブジェクト

indices - 指定されたIndex

例外:

java.lang.IllegalArgumentException - いずれかの引数がnullだった場合に発生

java.io.IOException - CSVファイルの出力に失敗した場合

read

public static BIXpp read(java.io.File bixppFile,
                         boolean validate)
                  throws ValidationException,
                         XMLException,
                         java.io.IOException

BIX-ppファイルを指定して BIXppオブジェクトへ変換します。 第2引数にtrueを指定すると、BIX-ppファイルが規格通りに書かれているか、妥当性をチェックできます。 第2引数にfalseを指定すると、妥当性をチェックせずにBIX-ppデータを読み込みますが、 XMLの記述が間違っていたり、変換できないデータが存在した場合にXMLExceptionが発生します。

パラメータ:

bixppFile - BIX-ppファイルを表すFileオブジェクト

validate - 妥当性チェックのフラグ

戻り値:

BIXppオブジェクト

例外:

java.lang.IllegalArgumentException - bixppFileがnullだった場合

ValidationException - BIX-ppファイルが規格通りに記述されていなかった場合

XMLException - XMLの記述が間違っていたり、変換できないデータが存在した場合

java.io.IOException - BIX-ppファイルの読み込みに失敗した場合

read

public static BIXpp read(java.net.URL bixppURL,
                         boolean validate)
                  throws ValidationException,
                         XMLException,
                         java.io.IOException

BIX-ppファイルのURLを指定して、BIXppオブジェクトへ変換します。 第2引数にtrueを指定すると、BIX-ppファイルが規格通りに書かれているか、妥当性をチェックできます。 第2引数にfalseを指定すると、妥当性をチェックせずにBIX-ppデータを読み込みますが、 XMLの記述が間違っていたり、変換できないデータが存在した場合にXMLExceptionが発生します。

パラメータ:

bixppURL - BIX-ppファイルのURL

validate - 妥当性チェックのフラグ

戻り値:

BIXppオブジェクト

例外:

java.lang.IllegalArgumentException - bixppURLがnullだった場合

ValidationException - BIX-ppファイルが規格通りに記述されていなかった場合

XMLException - XMLの記述が間違っていたり、変換できないデータが存在した場合

java.io.IOException - BIX-ppファイルの読み込みに失敗した場合

read

public static BIXpp read(java.io.InputStream bixppStream,
                         boolean validate)
                  throws ValidationException,
                         XMLException,
                         java.io.IOException

BIX-ppファイルのバイト入力ストリームを指定して、BIXppオブジェクトへ変換します。 第2引数にtrueを指定すると、BIX-ppファイルが規格通りに書かれているか、妥当性をチェックできます。 第2引数にfalseを指定すると、妥当性をチェックせずにBIX-ppデータを読み込みますが、 XMLの記述が間違っていたり、変換できないデータが存在した場合にXMLExceptionが発生します。

パラメータ:

bixppStream - BIX-ppファイルのInputStreamオブジェクト

validate - 妥当性チェックのフラグ

戻り値:

BIXppオブジェクト

例外:

java.lang.IllegalArgumentException - bixppStreamがnullだった場合

ValidationException - BIX-ppファイルが規格通りに記述されていなかった場合

XMLException - XMLの記述が間違っていたり、変換できないデータが存在した場合

java.io.IOException - BIX-ppファイルの読み込みに失敗した場合