FileUpdateDAO.java

/*
 * Copyright (c) 2007 NTT DATA Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.terasoluna.fw.file.dao;

/**
 * ファイル行オブジェクトの値を出力するFileLineWriterを生成するためのインタフェース。
 * <p>
 * ファイル行オブジェクトから値を取り出してテキストファイルに出力する<code>FileLineWriter</code> を生成するためのインタフェースである。 サブクラスで実装するメソッドは<code>execute</code>のみ。
 * 引数にはデータを書き込むファイルのパス（相対パス/絶対パス）と、 ファイル行オブジェクトのクラスを設定する。<br>
 * FileLineWriterを生成する方法を以下にあげる。
 * </p>
 * <p>
 * <strong>設定例</strong><br>
 * ビジネスロジック(SampleLogic)の中でFileLineWriterを生成する例。
 * 
 * <pre>
 * <li>1.FileUpdateDAOのインスタンスの情報をジョブBean定義ファイルに設定する。</li>
 * <code>
 * <bean id="blogic" 
 * 　class="jp.terasoluna.batch.sample.SampleLogic">
 *  <property name="fileUpdateDAO" ref="csvFileUpdateDao" />
 * </bean>
 * </code>
 * 参照するFileQueryDAOのサブクラスは「FileAccessBean.xml」を参照のこと。
 * 
 * <li>2.FileLineWriterをビジネスロジックの中で生成する。
 * <code>
 * FileUpdateDAO fileDao = null;   //FileUpdateDAOのインスタンス生成はジョブBean定義ファイルに記述する。setterは省略。
 * ……
 * // FileLineWriterを生成。
 * FileLineWriter fileLineWriter = fileDao.execute("【アクセスするファイル名】", 【ファイル行オブジェクトのクラス】);
 * ……
 * </code>
 * </pre>
 * 
 * </p>
 * FileLineWriterの詳細は、{@link jp.terasoluna.fw.file.dao.FileLineWriter}を参照のこと。
 */
public interface FileUpdateDAO {

    /**
     * ファイル名を指定して、<code>FileLineWriter</code>を取得する。
     * @param fileName ファイル名（絶対パスまたは相対パスのどちらか）
     * @param clazz 1行分の文字列を格納するファイル行オブジェクトクラス
     * @param <T> ファイル行オブジェクト
     * @return ファイル出力用Writer
     */
    <T> FileLineWriter<T> execute(String fileName, Class<T> clazz);

}