jp.terasoluna.fw.file.dao
インタフェース FileLineIterator<T>

型パラメータ:
T - ファイル行オブジェクト。
すべてのスーパーインタフェース:
java.util.Iterator
既知の実装クラスの一覧:
AbstractFileLineIterator, CSVFileLineIterator, FixedFileLineIterator, PlainFileLineIterator, VariableFileLineIterator

public interface FileLineIterator<T>
extends java.util.Iterator

ファイルアクセス(データ取得)用のイテレータインタフェース。

テキストファイルを読み、ファイルの文字列をファイル行オブジェクトに格納する。 FileLineIteratorのインスタンス生成はFileQueryDAOが行う。 詳細はFileQueryDAOを参照のこと。
使用例

  • ファイル行オブジェクトを取得する例。
    
     // ファイルから1レコードのデータを入力しFileColumnSample型のオブジェクトに格納する
     ……
         while(fileLineIterator.hasNext()){
            FileColumnSample fileColumnSample = fileLineIterator.next();
     ……
     
    太字はFileLineIteratorが提供するメソッド。 詳細はhasNext()next()を参照のこと。


    メソッドの概要
     void closeFile()
              ファイルクローズ.
     java.util.List<java.lang.String> getHeader()
              ヘッダ部の文字列を返却する。
     java.util.List<java.lang.String> getTrailer()
              トレイラ部の文字列を返却する。
     boolean hasNext()
              ファイルからデータが取得できるか確認する。
     T next()
              ファイル行オブジェクトを返却する。
     void skip(int skipLines)
              スキップ処理。
     
    インタフェース java.util.Iterator から継承されたメソッド
    remove
     

    メソッドの詳細

    hasNext

    boolean hasNext()
    ファイルからデータが取得できるか確認する。

    繰り返し処理でさらに要素がある場合にtrue を返す。

    定義:
    インタフェース java.util.Iterator 内の hasNext
    戻り値:
    反復子がさらに要素を持つ場合はtrue

    next

    T next()
    ファイル行オブジェクトを返却する。

    hasNext()メソッドがfalseを返すまで このメソッド呼び出す毎に、ファイル行オブジェクトを1つ返却する。

    定義:
    インタフェース java.util.Iterator 内の next
    戻り値:
    次のファイル行オブジェクト。

    getHeader

    java.util.List<java.lang.String> getHeader()
    ヘッダ部の文字列を返却する。

    ヘッダ部のデータを文字列のリストとして呼び出し元に返却する。

    戻り値:
    文字型のリスト。

    getTrailer

    java.util.List<java.lang.String> getTrailer()
    トレイラ部の文字列を返却する。

    トレイラ部のデータを文字列のリストとして呼び出し元に返却する。

    戻り値:
    文字型のリスト。

    skip

    void skip(int skipLines)
    スキップ処理。

    ファイル入力機能では、入力を開始する行を指定できる。
    主に、リスタートポイントからファイルの読込を再開するときに利用する。

    パラメータ:
    skipLines - 読み飛ばす行数

    closeFile

    void closeFile()
    ファイルクローズ.

    ファイルの入力ストリームを閉じる。 ファイル入力が完了した段階で必ず実行すること。