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

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.CSVCela
すべての実装されたインタフェース:
java.io.Serializable, jp.co.intra_mart.foundation.service.client.ActionListener, CompressedPDF

public class CSVCela
extends AbstractIODOC
implements java.io.Serializable

このクラスは、IOWebDOCの連票用レイアウトファイルと CSV形式のデータファイル、
又はレコードデータオブジェクトからIOD中間ファイル、PDFファイルを作成するための機能を提供します。
また、連票(IOCELA)文書内に単票(IODOC)を埋め込む機能を提供します。

PDFファイルは、Storage-Service上で稼動するIOWebDOCが連携して作成します。
その為、このクラスの各メソッド(一部除く)の実行時はファイルサーバとの通信が発生します。
PDFファイルの作成はStorage-Serviceで実行されるため、レイアウトファイルや
データファイルは、Storage-Serviceに保存されている必要があります。
また、IOCELAへ埋め込むレコードオブジェクトデータからCSVデータファイルを内部で生成し、
PDFファイルを生成する機能があり、この場合はレコードデータを内部でファイル変換し、
それを元にIOWebDOCでPDFを生成します。
実行後に作成されるPDFファイルやログファイルなどは、全てStorage-Serviceに作られます。
なお、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
 
コンストラクタの概要
CSVCela(java.lang.String path)
          指定された定義ファイルから PDFファイル又はIOD中間ファイルを作成するためのオブジェクトを構築します。
 
メソッドの概要
 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 setData(java.lang.String id, java.lang.String data)
          IOCELA文書内のIODOCレイアウトファイル(IOD)に、オブジェクトデータの設定する。
 void setDocData(java.lang.String data)
          IOCELA文書内のIODOCレイアウトファイル(IOD)に、埋め込みデータファイル(DAT)を設定する。
 void setDocIod(java.lang.String iod)
          IOCELA文書内に貼り付けるIODOCレイアウトファイル(IOD)を設定する。
 void setImageData(java.lang.String id, java.lang.String filepath)
          IOCELA文書内のIODOCレイアウトファイル(IOD)に、オブジェクトデータ(イメージ)を設定する。
 void setRecord(java.lang.String datarecord)
          IOCELA出力用データレコードのセット。
 void setTextBoxData(java.lang.String textboxdata)
          IOCELA文書内のIODOCレイアウトファイル(IOD)に、オブジェクトデータ(文字枠用)のデータを設定する。
 void setTextBoxEnd()
          IOCELA文書内のIODOCレイアウトファイル(IOD)に、オブジェクトデータ(文字枠用)の終了を宣言する。
 void setTextBoxStart(java.lang.String id)
          IOCELA文書内のIODOCレイアウトファイル(IOD)に、オブジェクトデータ(文字枠用)の開始を宣言する。
 
クラス 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
 

コンストラクタの詳細

CSVCela

public CSVCela(java.lang.String path)
        throws java.lang.IllegalStateException
指定された定義ファイルから PDFファイル又はIOD中間ファイルを作成するためのオブジェクトを構築します。
各ファイルパスは、Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式
で表されるパス名を指定する。

パラメータ:
path - レイアウト定義ファイル(DEF)のパス
例外:
java.lang.IllegalStateException - ライセンス違反の場合スローされます
メソッドの詳細

setCSV

public void setCSV(java.lang.String path)
CSV形式データファイルのパスを設定する。
CSVデータファイルからレコードデータ文字列をセットする場合は必ずセットする。
オブジェクトデータ形式でのレコードデータ登録の場合には、CSVデータファイルは無効となる。
ファイルパスは、Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式
で表されるパス名を指定する。

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

makePDF

public int makePDF(java.lang.String path)
            throws java.io.IOException
PDFファイルを作成する。
与えられたファイル、又はオブジェクトデータの登録データから処理形式を選択し、
それぞれの処理に必要となるパラメータ値のチェックを実施する。
パラメータの形式により、ファイル(V5用/V7用)、オブジェクトデータの何れかを
Storage-Service側へ渡し、webcela各メソッドの処理を実施する。
返却値は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側へ渡し、webcela各メソッドの処理を実施する。
返却値は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)
IOCELA出力用データレコードのセット。
レコード単位でのデータをセットする。連続で呼び出すことにより複数レコードデータを順次登録する。

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

setDocIod

public void setDocIod(java.lang.String iod)
IOCELA文書内に貼り付けるIODOCレイアウトファイル(IOD)を設定する。

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

setDocData

public void setDocData(java.lang.String data)
IOCELA文書内のIODOCレイアウトファイル(IOD)に、埋め込みデータファイル(DAT)を設定する。

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

setData

public void setData(java.lang.String id,
                    java.lang.String data)
IOCELA文書内のIODOCレイアウトファイル(IOD)に、オブジェクトデータの設定する。
識別子データのみの出力の場合は、データ文字列にはブランクを設定する。

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

setTextBoxStart

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

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

setTextBoxData

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

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

setTextBoxEnd

public void setTextBoxEnd()
IOCELA文書内のIODOCレイアウトファイル(IOD)に、オブジェクトデータ(文字枠用)の終了を宣言する。
文字枠データ文字列を全てセット後、必ず呼び出す必要が有る。

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

setImageData

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

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