uCosminexus Interschema ユーザーズガイド

[目次][用語][索引][前へ][次へ]

10.2.6 FileDataクラス

ここでは,FileDataクラスの仕様について説明します。

<この項の構成>
(1) FileDataクラスの概要
(2) コンストラクタの詳細
(3) メソッドの詳細

(1) FileDataクラスの概要

継承
java.lang.Object
|
+-- jp.co.Hitachi.soft.interschema2.TranslateData
    |
    +-- jp.co.Hitachi.soft.interschema2.FileData

 

形式
public final class FileData
extends jp.co.Hitachi.soft.interschema2.TranslateData

 

説明
ファイル形式の変換対象データを定義します。ファイル形式のデータオブジェクトを変換する場合に使用します。この変換対象データは,入力及び出力のどちらにも使用できます。

コンストラクタの概要
形式 機能
public FileData(String formatName, File file) 指定されたフォーマット名及びファイルから,ファイル形式の変換対象データを生成します。
public FileData(String formatName, String fileName) 指定されたフォーマット名及びファイル名から,ファイル形式の変換対象データを生成します。

メソッドの概要
形式 機能
public String getFileName() 現在の変換対象データのファイル名を取得します。
protected byte[] toByteArray(Object obj) 指定されたデータオブジェクトをバイト列に変換します。
protected Object toDataObject(byte[] byteData) 指定されたバイト列をデータオブジェクトに変換します。

(2) コンストラクタの詳細

(a) FileData

形式
public FileData(String formatName, File file)

 

引数
引数 内容
formatName フォーマット名を指定します。
file ファイルを指定します。

説明
指定されたフォーマット名及びファイルから,ファイル形式の変換対象データを生成します。
(b) FileData

形式
public FileData(String formatName, String fileName)

 

引数
引数 内容
formatName フォーマット名を指定します。
fileName ファイル名を指定します。

説明
指定されたフォーマット名及びファイル名から,ファイル形式の変換対象データを生成します。

(3) メソッドの詳細

(a) getFileName

形式
public String getFileName()

 

引数
なし

説明
現在のデータオブジェクトのファイル名を取得します。

戻り値
ファイル形式データオブジェクトのファイル名が返されます。
(b) toByteArray

形式
protected byte[] toByteArray (Object obj)
    throws TranslatorException

 

引数
引数 内容
obj ファイル形式のデータオブジェクトを指定します。

説明

指定されたデータオブジェクトをバイト列に変換します。ファイル形式のデータオブジェクトを読み込みバイト列に変換します。

戻り値
データオブジェクトのバイト列が返されます。

例外
例外 内容
TranslatorException 指定されたデータオブジェクトがFileクラス,又はStringクラスのインスタンスでない場合,又はデータオブジェクトのバイト列への変換に失敗した場合に発生します。
(c) toDataObject

形式
protected Object toDataObject(byte[] byteData)
    throws TranslatorException

 

引数
引数 内容
byteData データオブジェクトのバイト列を指定します。

説明
指定されたバイト列をデータオブジェクトに変換します。指定されたバイト列を,現在のデータオブジェクトに設定されているファイルに書き込んで,現在のデータオブジェクトを返します。

戻り値

ファイル形式のデータオブジェクトを返します。

例外
例外 内容
TranslatorException バイト列の変換対象フォーマットデータへの変換に失敗した場合に発生します。