jp.go.aist.dmrc.platform.beans.io

クラス PFWriter

java.lang.Object

jp.go.aist.dmrc.platform.beans.io.PFWriter

すべての実装されたインタフェース:

java.io.Serializable, PFComponent

直系の既知のサブクラス:

PFBinaryFileWriter, 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	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
protected java.io.File	getCurrentFile() ファイルオブジェクトを返す。
boolean	getExceptionIgnoring() Exceptionを無視するか否かを取得する
java.io.File	getFile() ファイル名を返す。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
void	localeUpdated() ロケール更新時の処理。
void	setAllowPullTransfer(boolean flag) 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowPushTransfer(boolean flag) 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowRemoteInvocation(boolean flag) 他PFからのコンポーネント連携要求に対する可否属性を設定する.
void	setComponentID(int id) コンポーネントIDを設定する。
void	setComponentKey(java.lang.String key) コンポーネントキーを設定する。
void	setComponentKeys(PFMultiLocaleString keys) 全ロケール分のコンポーネントキーを設定する。
void	setComponentPublicName(java.lang.String publicName) コンポーネント公開名を設定する.
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()

コンポーネントキーを取得する。

定義:

getComponentKey インタフェース内 PFComponent

戻り値:

コンポーネントキー文字列

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントキーを設定する。

定義:

setComponentKey インタフェース内 PFComponent

パラメータ:

key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()

全ロケール分のコンポーネントキーを返す。

戻り値:

全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

全ロケール分のコンポーネントキーを設定する。

パラメータ:

keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()

コンポーネントIDを取得する。

定義:

getComponentID インタフェース内 PFComponent

戻り値:

コンポーネントID

setComponentID

public void setComponentID(int id)

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

定義:

setComponentID インタフェース内 PFComponent

パラメータ:

id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:

getComponentString インタフェース内 PFComponent

戻り値:

文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

getComponentPublicName インタフェース内 PFComponent

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:

setComponentPublicName インタフェース内 PFComponent

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:

isAllowRemoteInvocation インタフェース内 PFComponent

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

setAllowRemoteInvocation インタフェース内 PFComponent

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPullTransfer インタフェース内 PFComponent

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPullTransfer インタフェース内 PFComponent

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPushTransfer インタフェース内 PFComponent

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPushTransfer インタフェース内 PFComponent

パラメータ:

flag - Push型コンポーネント転送要求に対する可否

localeUpdated

public void localeUpdated()

ロケール更新時の処理。

定義:

localeUpdated インタフェース内 PFComponent

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を無視するか否かを取得する

戻り値:

無視するか否か