/*
このファイルの中身は、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) ______________________________________.
*/

//
//	Offline教材 オフラインログドキュメントクラスクラス
//			変更履歴
//				2004.01.08	新規作成	二條　智文
//
package jp.co.ntt.lms.lo.Offline.OfflineLog;

import java.util.*;
import java.io.IOException;
import java.io.FileInputStream;
import java.io.StringReader;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.xerces.parsers.DOMParser;
import org.w3c.dom.*;
import org.xml.sax.SAXException;
import org.xml.sax.InputSource;

/**
 * Offline教材 オフラインログドキュメントクラスクラス<BR>
 * オフラインログをパースし、自身の内部変数にデータを
 * 格納します。
 */
public class OfflineDocument implements OfflineLogConst {

	/** <course> エレメントデータを保持します */
	private OfflineCourse mobjCourse;

	/** <items> エレメントデータを保持します */
	private OfflineItems mobjItems;

	/** <loms> エレメントデータを保持します */
	private OfflineLoms mobjLoms;

	// エラーメッセージ
	private static final String ERR_PRE = "document:";
	private static final String INVALID_ROOT_TAG = ERR_PRE + "ルートタグが不正です。";
	private static final String NO_EXIST_COURSE = ERR_PRE + "courseタグが存在しません。";
	private static final String NO_EXIST_ITEMS = ERR_PRE + "itemsタグが存在しません。";
	private static final String NO_EXIST_LOMS = ERR_PRE + "lomsタグが存在しません。";

	/**
	 * 引数で受け取ったオフラインログのファイルパスのファイルを読み込み、
	 * パースを行います。
	 * @param strLogPath オフラインログファイルパス
	 * @exception OfflineLogParseException パースエラー
	 */
	public void parse(String strLogPath)
		throws OfflineLogParseException, IOException, SAXException
	{
		if( strLogPath == null ) {
			throw new OfflineLogParseException( "ファイルパスが未設定" );
		}


		DocumentBuilder objDocumentBuilder;

		//教材定義ファイルを読み込みＤＯＭツリーを作成する
		//作成失敗した場合には、上位ＡＰにExceptionをthrowする
		//空行及びコメントは無効とする
		DocumentBuilderFactory objDocumentBuilderFactory = DocumentBuilderFactory.newInstance();
		objDocumentBuilderFactory.setIgnoringElementContentWhitespace(true);
		objDocumentBuilderFactory.setIgnoringComments(true);

		try{
			objDocumentBuilder = objDocumentBuilderFactory.newDocumentBuilder();
		}
		catch(ParserConfigurationException ex) {
			throw new OfflineLogParseException( ex.getMessage() );
		}

		Document objXmlDoc;

		FileInputStream objStream = new FileInputStream( strLogPath );
		InputSource objInput = new InputSource(objStream);				//DOMツリー作成
		objXmlDoc = objDocumentBuilder.parse(objInput);
		objStream.close();

		Element objRootElm = objXmlDoc.getDocumentElement();

		String strTagName = objRootElm.getTagName();
		if( !strTagName.equals( YYWLOG_ELM ) ) {
			throw new OfflineLogParseException( INVALID_ROOT_TAG );
		}

		// <course>エレメントの読み込み
		mobjCourse = makeCourse( objRootElm );

		// <items>エレメントの読み込み
		mobjItems = makeItems( objRootElm );

		// <loms> エレメントの読み込み
		mobjLoms = makeLoms( objRootElm );
	}

	/**
	 * <course>エレメントデータを取得します。
	 * パース処理を実行していない場合はnullが返ります。
	 * @return OfflineCourse
	 */
	public OfflineCourse getCourse() {
		return mobjCourse;
	}

	/**
	 * <imtes>エレメントデータを取得します。
	 * パース処理を実行していない場合はnullが返ります。
	 * @return OfflineItems
	 */
	public OfflineItems getItems() {
		return mobjItems;
	}

	/**
	 * <loms>エレメントデータを取得します。
	 * パース処理を実行していない場合はnullが返ります。
	 * @return OfflineLoms
	 */
	public OfflineLoms getLoms() {
		return mobjLoms;
	}


//----------------------------------- 内部関数 ---------------------------------
	/**
	 * <course>エレメントのデータを作成します
	 * @param objElm エレメント
	 * @exception OfflineLogParseException パースエラー
	 */
	private OfflineCourse makeCourse( Element objElm )
		throws OfflineLogParseException
	{
		NodeList objNodeList = objElm.getElementsByTagName( COURSE_ELM );

		int intIndex = objNodeList.getLength();

		if( intIndex == 0 ) {
			throw new OfflineLogParseException( NO_EXIST_COURSE );
		}
		Element objCourseElm = (Element)objNodeList.item( 0 );

		return new OfflineCourse( objCourseElm );

	}

	/**
	 * <items>エレメントのデータを作成します
	 * @param objElm エレメント
	 * @exception OfflineLogParseException パースエラー
	 */
	private OfflineItems makeItems( Element objElm )
		throws OfflineLogParseException
	{
		NodeList objNodeList = objElm.getElementsByTagName( ITEMS_ELM );

		int intIndex = objNodeList.getLength();

		if( intIndex == 0 ) {
			throw new OfflineLogParseException( NO_EXIST_ITEMS );
		}
		Element objItemsElm = (Element)objNodeList.item( 0 );
		return new OfflineItems( objItemsElm );

	}

	/**
	 * <loms>エレメントのデータを作成します。
	 * @param objElm エレメント
	 * @exception OfflineLogParseException パースエラー
	 */
	private OfflineLoms makeLoms( Element objElm )
		throws OfflineLogParseException
	{
		NodeList objNodeList = objElm.getElementsByTagName( LOMS_ELM );

		int intIndex = objNodeList.getLength();

		if( intIndex == 0 ) {
			throw new OfflineLogParseException( NO_EXIST_LOMS );
		}
		Element objLomsElm = (Element)objNodeList.item( 0 );
		return new OfflineLoms( objLomsElm );
	}
//----------------------------------- 内部関数 ---------------------------------

}

