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

java.lang.Object
  jp.go.aist.dmrc.platform.beans.io.PFWriter
      jp.go.aist.dmrc.platform.beans.io.PFTextFileWriter

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

java.io.Serializable, PFComponent, PFXMLSerializable

public class PFTextFileWriter
extends PFWriter
implements PFXMLSerializable

文字列をテキストファイルに出力するコンポーネント。

このコンポーネントからはイベントが発生しない。

関連項目:

直列化された形式

コンストラクタの概要

PFTextFileWriter()
デフォルトコンストラクタ

メソッドの概要

void	close() ファイルを閉じる
java.lang.String	getComponentName() コンポーネント名称を取得する。
boolean	isAppendingMode() 追記モードを取得する。
boolean	isOpen() ファイルを開いているか判定する
void	localeUpdated() ロケール変更に対応する。
void	open(java.io.File file) ファイルを指定して開く
void	open(java.io.File file, java.lang.String charset, boolean bom) ファイルを指定して開く。
void	open(java.lang.String filename) ファイル名を指定してファイルを開く
void	open(java.lang.String filename, java.lang.String charset, boolean bom) ファイル名と文字コードを指定してファイルを開く 文字コードの規格によりBOM（Byte Order Mark）の出力有無が定まる場合、 引数によるBOM出力指定は無視される。
void	print(java.lang.String text) 開いているファイルに文字列を書き出す(改行なし)。
void	println(java.lang.String text) 開いているファイルに文字列を書き出す(改行あり)。
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
void	setAppendingMode(boolean mode) 追記モードを設定する。
void	write(java.io.File file, java.lang.String text) ファイルオブジェクトを指定して文字列を書き出す。
void	write(java.io.File file, java.lang.String text, java.lang.String charset, boolean bom) 文字コードとファイルオブジェクトを指定して文字列を書き出す。
void	write(java.lang.String filename, java.lang.String text) ファイル名を指定して文字列を書き出す。
void	write(java.lang.String filename, java.lang.String text, java.lang.String charset, boolean bom) 文字コードとファイル名を指定して文字列を書き出す。
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

クラス jp.go.aist.dmrc.platform.beans.io.PFWriter から継承されたメソッド

getComponentID, getComponentKey, getComponentKeys, getComponentPublicName, getComponentString, getCurrentFile, getExceptionIgnoring, getFile, isAllowPullTransfer, isAllowPushTransfer, isAllowRemoteInvocation, setAllowPullTransfer, setAllowPushTransfer, setAllowRemoteInvocation, setComponentID, setComponentKey, setComponentKeys, setComponentPublicName, setExceptionIgnoring, setFile, setFile

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

PFTextFileWriter

public PFTextFileWriter()

デフォルトコンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

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

定義:

インタフェース PFComponent 内の getComponentName

戻り値:

コンポーネント名

関連項目:

PFComponent.getComponentName()

localeUpdated

public void localeUpdated()

ロケール変更に対応する。

定義:

インタフェース PFComponent 内の localeUpdated

オーバーライド:

クラス PFWriter 内の localeUpdated

関連項目:

PFComponent.localeUpdated()

write

public void write(java.lang.String filename,
                  java.lang.String text)
           throws PFComponentException

ファイル名を指定して文字列を書き出す。

パラメータ:

filename - ファイル名

text - 書き出す文字列

例外:

PFComponentException - 文字列書き出しの失敗

write

public void write(java.io.File file,
                  java.lang.String text)
           throws PFComponentException

ファイルオブジェクトを指定して文字列を書き出す。

パラメータ:

file - ファイルオブジェクト

text - 書き出す文字列

例外:

PFComponentException - 文字列書き出しの失敗

open

public void open(java.lang.String filename)
          throws PFComponentException

ファイル名を指定してファイルを開く

パラメータ:

filename - ファイル名

例外:

PFComponentException - すでにファイルを開いているかファイルを開けない場合

open

public void open(java.io.File file)
          throws PFComponentException

ファイルを指定して開く

パラメータ:

file - ファイル

例外:

PFComponentException - すでにファイルを開いているかファイルを開けない場合

close

public void close()

ファイルを閉じる

print

public void print(java.lang.String text)
           throws PFComponentException

開いているファイルに文字列を書き出す(改行なし)。

パラメータ:

text - 書き出す文字列

例外:

PFComponentException - ファイルをオープンしていない場合

println

public void println(java.lang.String text)
             throws PFComponentException

開いているファイルに文字列を書き出す(改行あり)。

パラメータ:

text - 書き出す文字列

例外:

PFComponentException - ファイルをオープンしていない場合

isOpen

public boolean isOpen()

ファイルを開いているか判定する

戻り値:

真偽値

write

public void write(java.lang.String filename,
                  java.lang.String text,
                  java.lang.String charset,
                  boolean bom)
           throws PFComponentException

文字コードとファイル名を指定して文字列を書き出す。 文字コードの規格によりBOM（Byte Order Mark）の出力有無が定まる場合、 引数によるBOM出力指定は無視される。

パラメータ:

file - ファイルオブジェクト

text - 書き出す文字列

charset - 文字コード名（ASCII、EUC_JP、ISO2022JP、SJIS、UnicodeLittle、UTF8等）

bom - BOM（Byte Order Mark）の出力有無（trueの場合出力）

例外:

PFComponentException - 文字列書き出しの失敗

write

public void write(java.io.File file,
                  java.lang.String text,
                  java.lang.String charset,
                  boolean bom)
           throws PFComponentException

文字コードとファイルオブジェクトを指定して文字列を書き出す。 文字コードの規格によりBOM（Byte Order Mark）の出力有無が定まる場合、 引数によるBOM出力指定は無視される。

パラメータ:

file - ファイルオブジェクト

text - 書き出す文字列

charset - 文字コード名（ASCII、EUC_JP、ISO2022JP、SJIS、UnicodeLittle、UTF8等）

bom - BOM（Byte Order Mark）の出力有無（trueの場合出力）

例外:

PFComponentException - 文字列書き出しの失敗

open

public void open(java.lang.String filename,
                 java.lang.String charset,
                 boolean bom)
          throws PFComponentException

ファイル名と文字コードを指定してファイルを開く 文字コードの規格によりBOM（Byte Order Mark）の出力有無が定まる場合、 引数によるBOM出力指定は無視される。

パラメータ:

filename - ファイル名

charset - 文字コード名（ASCII、EUC_JP、ISO2022JP、SJIS、UnicodeLittle、UTF8等）

bom - BOM（Byte Order Mark）の出力有無（trueの場合出力）

例外:

PFComponentException - すでにファイルを開いているかファイルを開けない場合

open

public void open(java.io.File file,
                 java.lang.String charset,
                 boolean bom)
          throws PFComponentException

ファイルを指定して開く。 文字コードの規格によりBOM（Byte Order Mark）の出力有無が定まる場合、 引数によるBOM出力指定は無視される。

パラメータ:

file - ファイル

charset - 文字コード名（ASCII、EUC_JP、ISO2022JP、SJIS、UnicodeLittle、UTF8等）

bom - BOM（Byte Order Mark）の出力有無（trueの場合出力）

例外:

PFComponentException - すでにファイルを開いているかファイルを開けない場合

isAppendingMode

public boolean isAppendingMode()

追記モードを取得する。

setAppendingMode

public void setAppendingMode(boolean mode)

追記モードを設定する。

パラメータ:

mode - 論理値(追記の場合がtrue)

readXML

public void readXML(PFXMLLoader in)

コンポーネントのXML入力.

定義:

インタフェース PFXMLSerializable 内の readXML

パラメータ:

in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

コンポーネントのXML出力.

定義:

インタフェース PFXMLSerializable 内の writeXML

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException