jp.co.intra_mart.product.pdfmaker.net
クラス CSVDoc

java.lang.Object
  上位を拡張 jp.co.intra_mart.foundation.service.client.NetworkConnector
      上位を拡張 jp.co.intra_mart.foundation.service.client.NetworkAgent
          上位を拡張 jp.co.intra_mart.foundation.service.client.file.AbstractComponent
              上位を拡張 jp.co.intra_mart.product.pdfmaker.net.AbstractIODOC
                  上位を拡張 jp.co.intra_mart.product.pdfmaker.net.CSVDoc
すべての実装されたインタフェース:
java.io.Serializable, jp.co.intra_mart.foundation.service.client.ActionListener, CompressedPDF

public class CSVDoc
extends AbstractIODOC
implements java.io.Serializable

このクラスは、IOWebDOC の単票用レイアウトファイルと CSV 形式のデータファイル
からIOD中間ファイル、PDFファイルを作成するための機能を提供します。

PDFファイルは、Storage-Service と IOWebDOC が連携して作成します。
その為、このクラスの各メソッド(一部除く)の実行時は Storage-Service との
通信が発生します。
PDFファイルの作成は Storage-Service で実行されるため、レイアウトファイルや
データファイルは、Storage-Service に保存されている必要があります。
また、実行後に作成される PDFファイルやログファイルなどは、
Storage-Service に作られます。
また、IODOCオブジェクトデータからPDFファイルを生成する機能があり、
この場合はオブジェクトデータを内部でファイル変換し、それを元にIOWebDOCで
PDFを生成します。
なお、PDF生成時に登録する文書情報、及びセキュリティ情報を埋め込む必要が有る場合は、
登録用各メソッドを呼び出すことで設定できます。

作成者:
Hisanari.H(09/03,2001),YSS(09/02,2008)
関連項目:
直列化された形式

フィールドの概要
 
クラス jp.co.intra_mart.product.pdfmaker.net.AbstractIODOC から継承されたフィールド
COMPRESS_DEFAULT, COMPRESS_NONE, COMPRESS_SIZE, COMPRESS_SPEED
 
インタフェース jp.co.intra_mart.product.pdfmaker.CompressedPDF から継承されたフィールド
COMPRESSION_DEFAULT, COMPRESSION_NONE, COMPRESSION_SIZE, COMPRESSION_SPEED
 
コンストラクタの概要
CSVDoc(java.lang.String iod, java.lang.String cdd)
          指定されたIODファイル及びCDD定義ファイルからPDFファイルを作成するためのオブジェクトを構築します。
 
メソッドの概要
 java.lang.Object action(java.lang.Object argV)
          推奨されていません。 このメソッドはStorage-Serviceによって呼び出されます。任意に呼び出すことは推奨できません。
 java.lang.String createTempFile()
          Storage-Serviceの管理するテンポラリディレクトリ上にテンポラリファイル(IOD)を作成し、 その絶対パス名を返却する。
 java.lang.String lastMessage()
          PDFファイルまたはIOD中間ファイル生成の実行結果メッセージの取得。
 int makeIOD(java.lang.String path)
          IOD中間ファイルを作成する。
 int makePDF(java.lang.String path)
          PDFファイルを作成する。
 void setCSV(java.lang.String path)
          CSV形式データファイルのパスを設定する。
 void setDAT(java.lang.String path)
          DAT形式データファイルのパスを設定する。
 void setData(java.lang.String id, java.lang.String data)
          IODOC出力用オブジェクトデータを設定する。
 void setImageData(java.lang.String id, java.lang.String filepath)
          IODOC出力用オブジェクトデータ(イメージ)を設定する。
 void setOutPage()
          IODOCのページ終了(改ページ)を設定する。
 void setRecord(java.lang.String datarecord)
          CSVファイル出力用データレコードのセット。
 void setTextBoxData(java.lang.String textboxdata)
          IODOC出力用オブジェクトデータ(文字枠用)のデータを設定する。
 void setTextBoxEnd()
          IODOC出力用オブジェクトデータ(文字枠用)の終了を宣言する。
 void setTextBoxStart(java.lang.String id)
          IODOC出力用オブジェクトデータ(文字枠用)の開始を宣言する。
 
クラス jp.co.intra_mart.product.pdfmaker.net.AbstractIODOC から継承されたメソッド
copySecurity, defineApplication, defineAuthor, defineSubTitle, defineTitle, getCompression, getLog, jsCopySecurity, jsModifySecurity, jsPrintSecurity, modifySecurity, printSecurity, setCompression, setLog, setOpenPassword, setSecurityPassword
 
クラス jp.co.intra_mart.foundation.service.client.file.AbstractComponent から継承されたメソッド
getInstance
 
クラス jp.co.intra_mart.foundation.service.client.NetworkConnector から継承されたメソッド
close, execute, freeMemory, isConnected, serverTime, totalMemory
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

CSVDoc

public CSVDoc(java.lang.String iod,
              java.lang.String cdd)
       throws java.lang.IllegalStateException
指定されたIODファイル及びCDD定義ファイルからPDFファイルを作成するためのオブジェクトを構築します。
CDDファイルが不要の場合(DAT形式、又はオブジェクトデータ直接指定時)は、CDDファイル名へは空文字をセットする。
各ファイルパスは、Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式
で表されるパス名を指定する。

パラメータ:
iod - 入力レイアウト定義ファイル(IOD)のパス
cdd - データマップ定義ファイル(CDD)のパス
例外:
java.lang.IllegalStateException - ライセンス違反の場合にスロー
メソッドの詳細

setCSV

public void setCSV(java.lang.String path)
CSV形式データファイルのパスを設定する。
CSVデータファイルから埋め込み文字列をセットする場合は必ずセットする。
CSVデータファイルを使用する場合は必ずCDDファイルも併せてセットする事。
CSVデータファイルが指定された場合、DATデータファイルと同時には指定できない。
オブジェクトデータ形式でのデータ受け渡しの場合には、CDD/CSV/DAT両データファイルは無効となる。
ファイルパスは、Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式
で表されるパス名を指定する。

パラメータ:
path - CSV形式データファイルのパス

setDAT

public void setDAT(java.lang.String path)
DAT形式データファイルのパスを設定する。
DATデータファイルから埋め込み文字列をセットする場合は必ずセットする。
DATデータファイルが指定された場合、CDD/CSVデータファイルと同時には指定できない。
オブジェクトデータ形式でのデータ受け渡しの場合には、CDD/CSV/DAT各データファイルは無効となる。
ファイルパスは、Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式
で表されるパス名を指定する。

パラメータ:
path - DAT形式データファイルのパス
導入されたバージョン:
PDF-Designer Version 7.0.0

makePDF

public int makePDF(java.lang.String path)
            throws java.io.IOException
PDFファイルを作成する。
与えられたファイル、又はオブジェクトデータの登録データから処理形式を選択し、
それぞれの処理に必要となるパラメータ値のチェックを実施する。
パラメータの形式により、ファイル(V5用/V7用)、オブジェクトデータの何れかを
Storage-Service側へ渡し、webdoc各メソッドを呼び出す。
返却値はwebdocクラスメソッドからの返却値、又は内部処理クラスからの戻り値が返却される。

定義:
クラス AbstractIODOC 内の makePDF
パラメータ:
path - 出力PDFファイル(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
戻り値:
処理戻り値(0:正常終了/-1以下:何らかのエラー)
例外:
java.io.IOException - 入出力エラー

makeIOD

public int makeIOD(java.lang.String path)
            throws java.io.IOException
IOD中間ファイルを作成する。
与えられたファイル、又はオブジェクトデータの登録データから処理形式を選択し、
それぞれの処理に必要となるパラメータ値のチェックを実施する。
パラメータの形式により、ファイル(V5用/V7用)、オブジェクトデータの何れかを
Storage-Service側へ渡し、webdoc各メソッドを呼び出す。
返却値はwebdocクラスメソッドからの返却値、又は内部処理クラスからの戻り値が返却される。

パラメータ:
path - 出力IODファイル(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
戻り値:
処理戻り値(0:正常終了/-1以下:何らかのエラー)
例外:
java.io.IOException - 入出力エラー

lastMessage

public java.lang.String lastMessage()
PDFファイルまたはIOD中間ファイル生成の実行結果メッセージの取得。
PDFファイルまたはIOD中間ファイル作成が正常に終了しなかった場合、
ステータスコードに対応するメッセージをこのメソッドより取得する。

定義:
クラス AbstractIODOC 内の lastMessage
戻り値:
実行結果メッセージ

action

public final java.lang.Object action(java.lang.Object argV)
推奨されていません。 このメソッドはStorage-Serviceによって呼び出されます。任意に呼び出すことは推奨できません。

PDFファイルまたはIOD中間ファイル生成処理呼び出し。

定義:
インタフェース jp.co.intra_mart.foundation.service.client.ActionListener 内の action
定義:
クラス jp.co.intra_mart.foundation.service.client.NetworkAgent 内の action
パラメータ:
argV - 実行引数
戻り値:
実行結果

setRecord

public void setRecord(java.lang.String datarecord)
CSVファイル出力用データレコードのセット。
レコード単位でのデータをセットする。連続で呼び出すことにより複数レコードデータを順次登録する。

パラメータ:
datarecord - 埋め込み用データレコード
導入されたバージョン:
PDF-Designer Version 7.0.0

setData

public void setData(java.lang.String id,
                    java.lang.String data)
IODOC出力用オブジェクトデータを設定する。
識別子データのみの出力の場合は、データ文字列には空文字("")を設定する。

パラメータ:
id - 埋め込み識別子ID
data - 埋め込みデータ文字列
導入されたバージョン:
PDF-Designer Version 7.0.0

setTextBoxStart

public void setTextBoxStart(java.lang.String id)
IODOC出力用オブジェクトデータ(文字枠用)の開始を宣言する。
文字枠内部データ埋め込み前に必ず呼び出す必要が有る。

パラメータ:
id - 埋め込み識別子ID(文字枠)
導入されたバージョン:
PDF-Designer Version 7.0.0

setTextBoxData

public void setTextBoxData(java.lang.String textboxdata)
IODOC出力用オブジェクトデータ(文字枠用)のデータを設定する。
文字枠の1行分(改行コードまで)のデータレコードをセットする。
複数行指定の場合は、連続して当メソッドを呼び出す。

パラメータ:
textboxdata - 埋め込みデータ文字列
導入されたバージョン:
PDF-Designer Version 7.0.0

setTextBoxEnd

public void setTextBoxEnd()
IODOC出力用オブジェクトデータ(文字枠用)の終了を宣言する。
文字枠データ文字列を全てセット後、必ず呼び出す必要が有る。

導入されたバージョン:
PDF-Designer Version 7.0.0

setImageData

public void setImageData(java.lang.String id,
                         java.lang.String filepath)
IODOC出力用オブジェクトデータ(イメージ)を設定する。
イメージファイル本体は、予めStorage-Service側へ転送しておく必要がある。

パラメータ:
id - 埋め込み識別子ID
filepath - 埋め込みイメージファイル(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
導入されたバージョン:
PDF-Designer Version 7.0.0

setOutPage

public void setOutPage()
IODOCのページ終了(改ページ)を設定する。

導入されたバージョン:
PDF-Designer Version 7.0.0

createTempFile

public java.lang.String createTempFile()
                                throws java.io.IOException
Storage-Serviceの管理するテンポラリディレクトリ上にテンポラリファイル(IOD)を作成し、 その絶対パス名を返却する。

戻り値:
テンポラリファイルの絶対パス
例外:
java.io.IOException
導入されたバージョン:
PDF-Designer Version 7.0.2