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

java.lang.Object
  上位を拡張 jp.go.aist.dmrc.platform.beans.io.PFReader
      上位を拡張 jp.go.aist.dmrc.platform.beans.io.PFTextFileReader
すべての実装されたインタフェース:
java.io.Serializable, PFComponent, PFXMLSerializable, PFDataCreateEventSource, PFEventSource

public class PFTextFileReader
extends PFReader
implements PFXMLSerializable

テキストファイルから文字列を読み込むためのコンポーネント。

このコンポーネントから以下のイベントが発生する。

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

コンストラクタの概要
PFTextFileReader()
          デフォルトコンストラクタ
 
メソッドの概要
 void close()
          ファイルを閉じる
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 boolean isOpen()
          ファイルを開いているか判定する
 void localeUpdated()
          ロケール変更に対応する。
 void open(java.io.File file)
          ファイルオブジェクトを指定してファイルを開く
 void open(java.io.File file, java.lang.String charset)
          ファイルオブジェクトと文字コードを指定してファイルを開く
 void open(java.lang.String filename)
          ファイル名を指定してファイルを開く
 void open(java.lang.String filename, java.lang.String charset)
          ファイル名と文字コードを指定してファイルを開く
 void read(java.io.File file)
          ファイルオブジェクトを指定してテキストデータを読み込む。
 void read(java.io.File file, java.lang.String charset)
          ファイルオブジェクトと文字コードを指定してテキストデータを読み込む。
 void read(java.lang.String fileName)
          ファイル名を指定してテキストデータを読み込む。
 void read(java.lang.String fileName, java.lang.String charset)
          ファイル名と文字コードを指定してテキストデータを読み込む。
 void readLines()
          開いているファイルから一行ずつ読み込む。
 void readTokens()
          開いているファイルから一単語ずつ読み込む。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス jp.go.aist.dmrc.platform.beans.io.PFReader から継承されたメソッド
addPFDataCreateListener, firePFDataCreated, getComponentID, getComponentKey, getComponentKeys, getComponentPublicName, getComponentString, getCurrentFile, getExceptionIgnoring, getFile, getPFDataCreateListenerList, isAllowPullTransfer, isAllowPushTransfer, isAllowRemoteInvocation, removePFDataCreateListener, setAllowPullTransfer, setAllowPushTransfer, setAllowRemoteInvocation, setComponentID, setComponentKey, setComponentKeys, setComponentPublicName, setExceptionIgnoring, setFile, setFile
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFTextFileReader

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

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名
関連項目:
PFComponent.getComponentName()

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

定義:
インタフェース PFComponent 内の localeUpdated
オーバーライド:
クラス PFReader 内の localeUpdated
関連項目:
PFComponent.localeUpdated()

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

read

public void read(java.io.File file)
          throws PFComponentException,
                 PFMethodException,
                 PFRuntimeException
ファイルオブジェクトを指定してテキストデータを読み込む。 ファイル全体を読み込んだらデータ生成イベントが発生する。 ファイル全体のテキストデータがイベント内包データとなる。

パラメータ:
file - ファイルオブジェクト
例外:
PFComponentException - 読み込みまたはイベント生成の失敗
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

read

public void read(java.lang.String fileName)
          throws PFComponentException,
                 PFMethodException,
                 PFRuntimeException
ファイル名を指定してテキストデータを読み込む。 ファイル全体を読み込んだらデータ生成イベントが発生する。 ファイル全体のテキストデータがイベント内包データとなる。

パラメータ:
fileName - ファイル名
例外:
PFComponentException - 読み込みまたはイベント生成の失敗
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

read

public void read(java.io.File file,
                 java.lang.String charset)
          throws PFComponentException,
                 PFMethodException,
                 PFRuntimeException
ファイルオブジェクトと文字コードを指定してテキストデータを読み込む。 ファイル全体を読み込んだらデータ生成イベントが発生する。 ファイル全体のテキストデータがイベント内包データとなる。

パラメータ:
file - ファイルオブジェクト
charset - 文字コード名(ASCII、EUC_JP、ISO2022JP、SJIS、UnicodeLittle、UTF8等)
例外:
PFComponentException - 読み込みまたはイベント生成の失敗
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

read

public void read(java.lang.String fileName,
                 java.lang.String charset)
          throws PFComponentException,
                 PFMethodException,
                 PFRuntimeException
ファイル名と文字コードを指定してテキストデータを読み込む。 ファイル全体を読み込んだらデータ生成イベントが発生する。 ファイル全体のテキストデータがイベント内包データとなる。

パラメータ:
fileName - ファイル名
charset - 文字コード名(ASCII、EUC_JP、ISO2022JP、SJIS、UnicodeLittle、UTF8等)
例外:
PFComponentException - 読み込みまたはイベント生成の失敗
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

open

public void open(java.lang.String filename,
                 java.lang.String charset)
          throws PFComponentException
ファイル名と文字コードを指定してファイルを開く

パラメータ:
filename - ファイル名
charset - 文字コード名(ASCII、EUC_JP、ISO2022JP、SJIS、UnicodeLittle、UTF8等)
例外:
PFComponentException - ファイルオープンの失敗

open

public void open(java.io.File file,
                 java.lang.String charset)
          throws PFComponentException
ファイルオブジェクトと文字コードを指定してファイルを開く

パラメータ:
file - ファイルオブジェクト
charset - 文字コード名(ASCII、EUC_JP、ISO2022JP、SJIS、UnicodeLittle、UTF8等)
例外:
PFComponentException - ファイルオープンの失敗

readLines

public void readLines()
               throws PFComponentException,
                      PFMethodException,
                      PFRuntimeException
開いているファイルから一行ずつ読み込む。 行を読み込むごとにデータ生成イベントが発生する。 一行分のテキストデータ(改行文字含まない)がイベント内包データとなる。

例外:
PFComponentException - 読み込み失敗またはイベント生成の失敗
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

readTokens

public void readTokens()
                throws PFComponentException,
                       PFMethodException,
                       PFRuntimeException
開いているファイルから一単語ずつ読み込む。 単語を読み込むごとにデータ生成イベントが発生する。 一単語文のテキストデータ(区切り文字含まない)がイベント内包データとなる。

例外:
PFComponentException - 読み込み失敗またはイベント生成の失敗
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

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()
           throws PFComponentException
ファイルを閉じる

例外:
PFComponentException - ファイルクローズの失敗

isOpen

public boolean isOpen()
ファイルを開いているか判定する

戻り値:
真偽値