単票用レイアウトファイルと、CSV形式のデータファイル又はDAT形式のデータファイル又はオブジェクトデータからIOD又はPDF形式ファイルを生成するAPI。
各定義ファイルおよびデータファイルはStorage-Serviceの管理するディレクトリ(標準では storage/)内に保存しておく必要があります。
また、IOD/PDFファイルおよびログファイルはStorage-Serviceの管理するディレクトリ(標準では storage/)内に生成されます。
メソッド
旧バージョン
からの継続
IODoc() コンストラクタ getMessage() 実行結果メッセージの取得 setCSV() CSV形式のデータファイルパスを設定 setLog() ログファイルパスの設定(※新バージョンでは使用できません) toPDF() PDFファイルの生成 toIOD() IOD中間ファイルの生成 新バージョン
追加
IODoc
データファイルsetDAT() DAT形式のデータファイルパスを設定 IODoc
帳票データsetData() オブジェクトデータの設定 setTextBoxStart() オブジェクトデータ(文字枠用)の開始宣言 setTextBoxData() オブジェクトデータ(文字枠用)の文字列設定 setTextBoxEnd() オブジェクトデータ(文字枠用)の終了宣言 setImageData() オブジェクトデータ(イメージ)の設定 setOutPage() ページ終了(改ページ)を設定
文書情報defineTitle() タイトルの設定 defineSubTitle() サブタイトルの設定 defineAuthor() 作成者の設定 defineApplication() 作成アプリケーション名の設定
セキュリティsetOpenPassword() オープンパスワードの設定 setSecurityPassword() セキュリティパスワードの設定 printSecurity() 印刷許可フラグの設定 modifySecurity() 編集許可フラグの設定 copySecurity() テキスト抽出コピー許可フラグの設定 IOD
中間ファイルcreateTempFile() Storage-Serviceの管理するテンポラリディレクトリ上にテンポラリファイル(IOD)を作成
(Object) IODoc(String iod, String cdd)
(String) iod: レイアウト定義ファイル(IODファイル)(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
(String) cdd: データマップ定義ファイル(CDDファイル)(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
引数に指定した定義ファイルを用いてIOD中間ファイル又はPDFファイルを生成します。
CDDファイルが不要の場合(DAT形式、又はオブジェクトデータ直接指定時)は、CDDファイル名へは空文字をセットして下さい。
文字列型インスタンスメソッド
(String) getMessage()
エラーメッセージを取得
なし
エラーメッセージ文字列
PDF又はIOD中間ファイル作成時にエラーが発生した場合、ステータスコードとして返却されたエラーコードに対応するメッセージを取得し、返却します。
このメソッドは、toPDF メソッドまたは toIOD メソッド実行後に呼び出して下さい。
void 型インスタンスメソッド
(void) setCSV(String path)
CSV形式のデータファイルパスを設定
path: CSV形式のデータファイルパス(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
なし
CSV形式のデータファイルのパスを設定します。
CSV形式のデータファイルを使用する場合は、必ずCDDファイルとセットで使用して下さい。
また、DAT形式ファイル、オブジェクト直接指定方式との同時使用はできません。
void 型インスタンスメソッド
(void) setDAT(String path)
DAT形式のデータファイルパスを設定
path: DAT形式のデータファイルパス(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
なし
DAT形式のデータファイルのパスを設定します。
DAT形式のデータファイルを使用する場合は、CDDファイルは指定できません。
また、CSV形式ファイル、オブジェクト直接指定方式との同時使用はできません。
void 型インスタンスメソッド
(void) setLog(String path)
ログファイルパスの設定
path: ログファイルのパス(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
なし
ログファイルのパスを設定します。
ログファイルは、PDF又はIOD中間ファイル作成時に同時に出力されます。
なお、既存の同名ファイルが存在する場合は内容が上書きされます(ログデータの追記はできません)。
※当メソッドは旧バージョン互換用に残されています。新バージョン機能を用いる場合には使用できません。
数値型インスタンスメソッド
(number) toIOD(String path)
中間ファイル(IOD)の作成
path: 出力IOD中間ファイル(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
ステータスコード
動作が正常に終了した場合 0 が返されます。
IODファイルの生成処理を実行します。
処理内部で発生したエラーについてはステータスコードは戻り値、メッセージについてはgetMessageメソッドにより確認します。
なお当メソッドでは、PDF文書情報/PDFセキュリティ各メソッドの設定値は全て無効となります。
数値型インスタンスメソッド
(number) toPDF(String path)
PDFファイル(PDF)の作成
path: 出力PDFファイル(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
ステータスコード
動作が正常に終了した場合 0 が返されます。
PDFファイルの生成処理を実行します。
処理内部で発生したエラーについてはステータスコードは戻り値、メッセージについてはgetMessageメソッドにより確認します。
void 型インスタンスメソッド
(void) setData(String id,String data)
IODOC出力用オブジェクトデータのセット
id: 埋め込みオブジェクトID
data: 埋め込みオブジェクトデータ文字列
なし
レイアウトに直接データを設定します。
void 型インスタンスメソッド
(void) setTextBoxStart(String id)
IODOC出力用オブジェクトデータ(文字枠用)の開始宣言
id: 埋め込みオブジェクトID
なし
レイアウトの文字枠領域への、文字列設定の開始を宣言します。
(setTextBoxDataメソッドは必ず当メソッドを呼び出してからセットしてください)
void 型インスタンスメソッド
(void) setTextBoxData(String textboxdata)
IODOC出力用オブジェクトデータ(文字枠用)のデータ設定
textboxdata: 埋め込みデータ文字列
なし
Cレイアウトの文字枠領域へ、文字列を設定します。
(当メソッドを呼び出す前に、必ずsetTextBoxStartメソッドで開始宣言をして下さい)
一回のメソッド呼び出しで、1行分の文字列を設定します(行末に改行コードが入ります)。
複数行設定する場合は、当メソッドを連続して呼び出してください。
void 型インスタンスメソッド
(void) setTextBoxEnd()
IODOC出力用オブジェクトデータ(文字枠用)の終了宣言
なし
なし
レイアウトの文字枠領域への、文字列設定の終了を宣言します。
文字枠領域へ文字列を設定した場合は、必ず呼んで下さい。
void 型インスタンスメソッド
(void) setImageData(String id,String filepath)
IODOC出力用オブジェクトデータ(イメージ)のセット
id: 埋め込みオブジェクトID
filepath: 埋め込みイメージファイル(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
なし
レイアウトのイメージへ、画像ファイルのパスを設定します。
埋め込み可能な画像フォーマットは、IOWebDOCの機能に依存します(IOWebDOC 1.9.1では以下フォーマットが使用可能です)。
・Windows-BMP
・JPEG
・TIFF G4
・PNG
・GIF(インターレース、アニメーションは非対応)
void 型インスタンスメソッド
(void) setOutPage()
IODOCのページの終了(改ページ)を設定
なし
なし
IODOCのページ終了(改ページ)を設定します。
void 型インスタンスメソッド
(void) defineTitle(String title)
PDF文書情報のタイトルの設定
title: 文書情報のタイトル
なし
PDFの文書情報のタイトルを設定します。
IOD中間ファイル出力時は当設定値は無効となります。
void 型インスタンスメソッド
(void) defineSubTitle(String subtitle)
PDF文書情報のサブタイトルの設定
subtitle: 文書情報のサブタイトル
なし
PDFの文書情報のサブタイトルを設定します。
IOD中間ファイル出力時は当設定値は無効となります。
void 型インスタンスメソッド
(void) defineAuthor(String author)
PDF文書情報の作成者の設定
author: 文書情報の作成者
なし
PDFの文書情報の作成者を設定します。
IOD中間ファイル出力時は当設定値は無効となります。
void 型インスタンスメソッド
(void) defineApplication(String appliname)
PDF文書情報の作成アプリケーション名の設定
appliname: 文書情報の作成アプリケーション名
なし
PDFの文書情報の作成アプリケーション名を設定します。
IOD中間ファイル出力時は当設定値は無効となります。
void 型インスタンスメソッド
(void) setOpenPassword(String openpass)
PDFファイルのオープンパスワードの設定
openpass: オープンパスワード
なし
PDFファイルのオープンパスワードを設定します。
オープンパスワードとセキュリティパスワードが同一値の場合はエラーとなります。
IOD中間ファイル出力時は当設定値は無効となります。
void 型インスタンスメソッド
(void) setSecurityPassword(String secpass)
PDFファイルのセキュリティパスワードの設定
secpass: セキュリティパスワード
なし
PDFのセキュリティパスワードを設定します。
オープンパスワードとセキュリティパスワードが同一値の場合はエラーとなります。
セキュリティを設定せずにセキュリティパスワードを設定した場合はエラーとなります。
IOD中間ファイル出力時は当設定値は無効となります。
void 型インスタンスメソッド
(void) printSecurity(String flgname)
PDFセキュリティの印刷許可フラグの設定
flgname: 印刷許可フラグ文字列
なし
PDFセキュリティの印刷許可フラグを設定します。
印刷許可フラグ文字列は、以下のいずれかを設定します。
・PRINT_ENABLE(印刷可)
・PRINT_DISABLE(印刷不可)
IOD中間ファイル出力時は当設定値は無効となります。
void 型インスタンスメソッド
(void) modifySecurity(String flgname)
PDFセキュリティの変更許可フラグの設定
flgname: 変更許可フラグ文字列
なし
PDFセキュリティの変更許可フラグを設定します。
変更許可フラグ文字列は、以下のいずれかを設定します。
・MODIFY_FORM_AND_ANNOTATION(注釈の作成、フォームフィールドの入力、および既存の署名フィールドに署名)
・MODIFY_FORM_AND_ASSEMBLY(ページレイアウト、フォームフィールドの入力、および既存の署名フィールドに署名)
・MODIFY_ALL(ページの抽出を除くすべての操作)
・MODIFY_DISABLE(変更不可)
IOD中間ファイル出力時は当設定値は無効となります。
void 型インスタンスメソッド
(void) copySecurity(String flgname)
PDFセキュリティのテキスト抽出コピー許可フラグの設定
flgname: テキスト抽出コピー許可フラグ文字列
なし
PDFセキュリティのテキスト抽出コピー許可フラグを設定します。
テキスト抽出コピー許可フラグ文字列は、以下のいずれかを設定します。
・COPY_AND_ACCESSBILITY_ENABLE(テキスト抽出コピー可)
・COPY_AND_ACCESSBILITY_DISABLE(テキスト抽出コピー不可)
IOD中間ファイル出力時は当設定値は無効となります。
文字列型インスタンスメソッド
(String) createTempFile()
Storage-Serviceの管理するテンポラリディレクトリ上にテンポラリファイル(IOD)を作成
なし
テンポラリファイルの絶対パス
Storage-Serviceの管理するテンポラリディレクトリ上にテンポラリファイル(IOD)を作成し、 その絶対パス名を返却する。