jp.go.aist.dmrc.platform.beans.io
クラス PFWriter

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.io.PFWriter
すべての実装インタフェース:
PFComponent, java.io.Serializable
直系の既知のサブクラス:
PFCSVWriter, PFImageFileWriter, PFShapeDocumentWriter, PFTextFileWriter

public abstract class PFWriter
extends java.lang.Object
implements PFComponent

データをファイルに書き込むコンポーネントのスーパークラス。

関連項目:
直列化された形式

コンストラクタの概要
PFWriter()
          ファイル出力コンポーネントを生成する。
 
メソッドの概要
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
protected  java.io.File getCurrentFile()
          ファイルオブジェクトを返す。
 boolean getExceptionIgnoring()
          Exceptionを無視するか否かを取得する
 java.io.File getFile()
          ファイル名を返す。
 void localeUpdated()
          ロケール更新時の処理。
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントキーを設定する。
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
 void setExceptionIgnoring(boolean ignoring)
          Exceptionを無視するか否かを設定する
 void setFile(java.io.File file)
          ファイルを設定する。
 void setFile(java.lang.String fileName)
          ファイルを設定する。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース jp.go.aist.dmrc.platform.base.PFComponent から継承したメソッド
getComponentName
 

コンストラクタの詳細

PFWriter

public PFWriter()
ファイル出力コンポーネントを生成する。

メソッドの詳細

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー文字列

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントキーを設定する。

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを返す。

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID

setComponentID

public void setComponentID(int id)
コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式:"Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
文字列表現

localeUpdated

public void localeUpdated()
ロケール更新時の処理。

定義:
インタフェース PFComponent 内の localeUpdated

getFile

public java.io.File getFile()
ファイル名を返す。

戻り値:
ファイル名
関連項目:
setFile(File), setFile(String)

setFile

public void setFile(java.io.File file)
             throws PFComponentException
ファイルを設定する。

パラメータ:
file - ファイル
例外:
PFComponentException - fileがnullの場合
関連項目:
setFile(String), getFile()

setFile

public void setFile(java.lang.String fileName)
             throws PFComponentException
ファイルを設定する。

パラメータ:
fileName - ファイル名
例外:
PFComponentException - fileNameがnullの場合
関連項目:
setFile(File), getFile()

getCurrentFile

protected java.io.File getCurrentFile()
                               throws PFComponentException
ファイルオブジェクトを返す。

戻り値:
ファイルオブジェクト
例外:
PFComponentException - ファイル名が指定されていない場合、 普通のファイルでない場合、ファイルの書込が不許可の場合

setExceptionIgnoring

public void setExceptionIgnoring(boolean ignoring)
Exceptionを無視するか否かを設定する

パラメータ:
ignoring - 無視するか否か

getExceptionIgnoring

public boolean getExceptionIgnoring()
Exceptionを無視するか否かを取得する

戻り値:
無視するか否か