継承

java.lang.Object
|
+-- jp.co.Hitachi.soft.interschema2.Translator

　

形式

public final class Translator
extends java.lang.Object

　

説明

変換処理を行うトランスレータを定義します。トランスレータは，マルチスレッドに対応しているため，プロセス内でTranslatorクラスのインスタンスを複数作成して，変換処理を並列に実行できます。ただし，一つのTranslatorクラスのインスタンスに対して，複数のスレッドから同時にアクセスすることはできません。

コンストラクタの概要

形式	機能
public Translator(String logFileName,Option option)	指定されたログファイル，及び指定された変換オプションで，トランスレータを生成します。
public Translator(String logFileName)	指定されたログファイル，及びデフォルトの変換オプションで，トランスレータを生成します。
public Translator(Option option)	デフォルトのログファイル，及び指定された変換オプションで，トランスレータを生成します。
public Translator()	デフォルトのログファイル，及びデフォルトの変換オプションで，トランスレータを生成します。

メソッドの概要

形式	機能
public int exec(MDLInfo mdlInfo, List inputData,List outputData,java.lang.Object userObj)	指定されたMDL情報に従って，データ変換を行います。変換中に呼び出すJava言語の出口関数に，最後の引数に指定されたオブジェクトを渡します。
public int exec(MDLInfo mdlInfo, List inputData,List outputData)	指定されたMDL情報に従って，データ変換を行います。
public Option getOption()	現在の変換オプションを取得します。
public void setOption(Option option)	指定された変換オプションを設定します。

(a)　Translator

形式

public Translator(String logFileName,Option option)
    throws TranslatorException

　

引数

引数	内容
logFileName	ログの出力先ファイル名を指定します。
option	オプションを指定します。

説明

指定されたログファイル，及び指定された変換オプションで，トランスレータを生成します。

logFileNameにnullが指定された場合，又はlogFileNameに指定されたファイルを作成・更新できなかった場合は，デフォルトのログファイル（Interschemaのインストールディレクトリ/log/errlog.txt）にログを出力します。デフォルトのログファイルを作成・更新できなかった場合は，標準エラー出力にログを出力します。

optionにnullが指定された場合は，デフォルトのオプションが指定されたものとします。オプションのデフォルト値については，「10.2.4　Optionクラス」を参照してください。

例外

例外	内容
TranslatorException	ライブラリの初期化又はトランスレータの生成に失敗した場合に発生します。

(b)　Translator

形式

public Translator(String logFileName)
    throws TranslatorException

　

引数

引数	内容
logFileName	ログの出力先ファイル名を指定します。

説明

指定されたログファイル，及びデフォルトの変換オプションで，トランスレータを生成します。変換オプションにnullを指定してトランスレータを生成する場合と等価です。

例外

例外	内容
TranslatorException	ライブラリの初期化又はトランスレータの生成に失敗した場合に発生します。

(c)　Translator

形式

public Translator(Option option)
    throws TranslatorException

　

引数

引数	内容
option	オプションを指定します。

説明

デフォルトのログファイル，及び指定された変換オプションで，トランスレータを生成します。ログファイルにnullを指定してトランスレータを生成する場合と等価です。

例外

例外	内容
TranslatorException	ライブラリの初期化又はトランスレータの生成に失敗した場合に発生します。

(d)　Translator

形式

public Translator()
    throws TranslatorException

　

引数

なし

説明

デフォルトのログファイル，及びデフォルトの変換オプションで，トランスレータを生成します。ログファイルと変換オプションにnullを指定してトランスレータを生成する場合と等価です。

例外

例外	内容
TranslatorException	ライブラリの初期化又はトランスレータの生成に失敗した場合に発生します。

(a)　exec

形式

public int exec(MDLInfo mdlInfo, List inputData, List outputData, java.lang.Object userObj)
    throws TranslatorException,UserException

　

引数

引数	内容
mdlInfo	変換に使用するMDL情報を指定します。
inputData	入力する変換対象フォーマット情報のリストを指定します。
outputData	出力する変換対象フォーマット情報のリストを指定します。
userObj	出口関数に渡すオブジェクトを指定します。

説明

指定されたMDL情報に従ってデータ変換を行います。

変換対象フォーマット情報は，MDL情報内で指定されている入出力ファイルを，別ファイル又はメモリデータに変換する場合に指定します。変換対象フォーマットは複数指定できます。指定された変換対象フォーマットに対しては，MDL内で設定された入出力データファイル名を無視します。

mdlInfoにnullが指定された場合，パラメタエラーとしてTranslatorExceptionが発生します。

inputData又はoutputDataにnullが指定された場合，MDL情報内で指定されている入出力ファイルを変換します。inputData又はoutputData内にnullの要素が含まれる場合は，その要素を無視します。

userObjに指定されたオブジェクトは，この関数呼び出しの延長で，Java言語の出口関数が呼ばれた時に，第１引数にそのまま渡されます。nullを指定することもできます。

戻り値には，JNI経由で呼び出すETtrans2Exec関数のリタンコードが返されますが，変換の途中でデータ変換を終了するレベルのエラー（ETtrans2Exec関数のリタンコードで0x02yyyyyy又は0x04zzzzzzに該当するエラー）が発生した場合は，TranslatorException例外がスローされて，戻り値は取得できません。

戻り値

JNI経由で呼び出すETtrans2Exec関数のリタンコードが返されます。

例外

例外	内容
TranslatorException	MDL情報にnullが指定された場合，又は変換に失敗した場合に発生します。
UserException	ユーザが定義した変換対象データでエラーが発生した場合に発生します。

(b)　exec

形式

public int exec(MDLInfo mdlInfo, List inputData, List outputData)
    throws TranslatorException, UserException

　

引数

引数	内容
mdlInfo	変換に使用するMDL情報を指定します。
inputData	入力する変換対象フォーマット情報のリストを指定します。
outputData	出力する変換対象フォーマット情報のリストを指定します。

説明

指定されたMDL情報に従ってデータ変換を行います。引数が三つの形式のexecを，出口関数に渡すオブジェクト（引数userObj）にnullを指定して呼び出した場合と等価です。

戻り値

JNI経由で呼び出すETtrans2Exec関数のリタンコードが返されます。

例外

例外	内容
TranslatorException	MDL情報にnullが指定された場合，又は変換に失敗した場合に発生します。
UserException	ユーザが定義した変換対象データでエラーが発生した場合に発生します。

(c)　getOption

形式

public Option getOption()

　

引数

なし

説明

現在のオプションを取得します。

戻り値

オプションが返されます。

(d)　setOption

形式

public void setOption(Option option)
    throws TranslatorException

　

引数

引数	内容
option	オプションを指定します。

説明

指定されたオプションを設定します。optionにnullが指定された場合は，デフォルトのオプションが指定されたものとします。オプションのデフォルト値については，「10.2.4　Optionクラス」を参照してください。

戻り値

なし

例外

例外	内容
TranslatorException	パラメタの更新に失敗した場合に発生します。