/*
このファイルの中身は、NTT オープンソースライセンス　バージョン 1.0（「本
契約」という）の適用を受けます。
本契約を遵守しない限り、このファイルを使用してはなりません。
本契約のコピーは、次のＵＲＬから入手できます。
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

本契約に基づき頒布されるソフトウェアは、現状のまま、明示又は黙示のあらゆ
る種類の保証なしで、頒布されます。本契約に基づく権利及び制限を律する特定
の文言については、本契約を参照してください。

「オリジナルコード」は、 NTT Cyber Space Laboratories Code です。 
「オリジナルコード」の「初期開発者」は、日本電信電話株式会社です。  
日本電信電話株式会社により創作された部分は、Copyright (C) 2004 
日本電信電話株式会社 です。
全ての権利が留保されます。 
「コントリビュータ」：_____________________________________ 


The contents of this file are subject to the NTT Opensource License
Version 1.0 (the License); you may not use this file except in
compliance with the License. You may obtain a copy of the License at
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

Software distributed under the License is distributed on an AS IS
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
License for the specific language governing rights and limitations
under the License.

The Original Code is NTT Cyber Space Laboratories Code .

The Initial Developer of the Original Code is NIPPON TELEGRAPH AND 
TELEPHONE CORPORATION.
Portions created by the NIPPON TELEGRAPH AND TELEPHONE CORPORATION 
are Copyright (C) 2004 NIPPON TELEGRAPH AND TELEPHONE CORPORATION. 
All Rights Reserved.

Contributor(s) ______________________________________.
*/
package jp.co.ntt.lms.installer.lms;

import java.util.Properties;

import jp.co.ntt.lms.installer.core.InstallerOverwriteXmlValue;
import jp.co.ntt.lms.installer.core.InstallerValues;

/**
 * フレームワーク画面表示設定について入力情報を保持するクラス。
 * @author T.Nishiki
 */
public class ScreenDefineInputValue
	implements InstallerOverwriteXmlValue {
	/**
	 * フレームワーク画面表示設定ファイル・パスを取得するためのキー文字列。
	 */
	private static final String KEY_FILE = "framework.screen";

	/**
	 * Xpathロケーションパス：ＣＳＶファイルを出力するディレクトリ。
	 */
	public static final String XPATH_CSV_OUTPUT_PATH
		= "/root/common/property[@name=\"output\"]/@value";

	/**
	 * ＣＳＶファイルを出力するディレクトリ・パス。
	 */
	private String _csvOutputPath;

	/**
	 * ＣＳＶファイルを出力するディレクトリのパスを取得します。
	 * @return ＣＳＶファイルを出力するディレクトリのパス。
	 */
	public String getCsvOutputPath() {
		return _csvOutputPath;
	}

	/**
	 * ＣＳＶファイルを出力するディレクトリのパスを設定します。
	 * @param csvOutputPath ＣＳＶファイルを出力するディレクトリのパス。
	 */
	public void setCsvOutputPath(String csvOutputPath) {
		_csvOutputPath = csvOutputPath;
	}

	/**
	 * 値を上書きするノードの一覧を戻します。<br>
	 * @param values インストーラ共通データ・オブジェクト。
	 * @return 「上書きするノードを取得するためのXPathロケーションパス」と
	 *          「そのノードの新しい値」を組とするPropertiesを戻します。
	 */
	public Properties getOverwrittenNodeValues(InstallerValues values) {
		Properties properties = new Properties();
		// フレームワーク画面表示設定のパス。
		properties.setProperty( XPATH_CSV_OUTPUT_PATH, _csvOutputPath);
		return properties;
	}

	/**
	 * 上書き対象のＸＭＬファイルを取得するためのキーを戻します。<br>
	 * 上書き対象のＸＭＬファイルについて、インストール設定ファイルから
	 * 取得するためのキーを戻します。
	 * @return プロパティファイル取得用のキー文字列。
	 */
	public String getTargetFileKey() {
		return KEY_FILE;
	}

	/**
	 * 対象のXMLファイルの文字コードを取得するためのキーを指定します。<br>
	 * @return 文字コードを取得するためのインストーラ・プロパティ・キー文字列。
	 */
	public String getXmlFileEncodeKey() {
		return "file.encode.framework.screen";
	}

	/**
	 * このクラスオブジェクトの文字列化します。<br>
	 * @return このクラスオブジェクトの文字列表現。
	 */
	public String toString() {
		StringBuffer buffer = new StringBuffer();
		buffer.append("_csvOutputPath=" + _csvOutputPath);
		return buffer.toString();
	}
}
