/*
このファイルの中身は、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教材 オフラインログのlomタグデータ保持クラス
//			変更履歴
//				2004.01.08	新規作成	二條　智文
//
package jp.co.ntt.lms.lo.Offline.OfflineLog;

import org.w3c.dom.*;
import java.util.*;

/**
 * Offline教材 オフラインログのlomタグデータ保持クラス<BR>
 * オフラインログのlomノードを受け取り、自身の内部変数にデータを
 * 格納します。
 */
public class OfflineLom implements OfflineLogConst {

	// 自身のノードオブジェクトを保持します。
	private Element mobjLomElm = null;

	// エラーメッセージ
	private static final String ERR_PRE = "<loms>-<lom>:";
	private static final String ERR_NOT_LOM = ERR_PRE + "lomタグではありません。";
	private static final String ERR_NOEXIST_LOM = ERR_PRE + "lomタグが存在しません。";
	private static final String ERR_NOEXIST_ID = ERR_PRE + "id属性が存在しません。";
	private static final String ERR_NOEXIST_CMI = ERR_PRE + "cmiタグが存在しません。";

	// cmiエレメントデータを保持します。
	private OfflineCmi mobjCmi;

	// bkエレメントデータを保持します。
	private Vector mvecBk = new Vector();

	// <loms>-<lom>-[id] 属性値を保持します。
	private String mstrID;


	/**
	 * コンストラクタです。
	 * @param objNode lomエレメントオブジェクト
	 * @exception OfflineLogParseException パースエラー
	 */
	OfflineLom( Element objElement )
		throws OfflineLogParseException
	{
		// タグ名のチェック(item以外はエラーとする)
		String strTagName = objElement.getTagName();
		if( strTagName == null || !strTagName.equals( LOM_ELM ) ) {
			throw new OfflineLogParseException( ERR_NOT_LOM );
		}

		mobjLomElm = objElement;

		parse();
	}

	/**
	 * <loms>-<lom>-[id] 属性値を取得します。
	 * @return String <loms>-<lom>-[id] 属性値
	 */
	public String getID() {
		return mstrID;
	}

	/**
	 * <loms>-<lom>-<cmi> エレメントデータを取得します。
	 * @return OfflineCmi <loms>-<lom>-<cmi> エレメントデータ
	 */
	public OfflineCmi getCmi() {
		return mobjCmi;
	}

	/**
	 * <loms>-<lom>-<bk> エレメントデータの長さを取得します。
	 * @return int 長さ
	 */
	public int getBkLength() {
		return mvecBk.size();
	}

	/**
	 * 指定されたインデックスのbkエレメントデータを取得します。
	 * @return OfflineBk
	 */
	public OfflineBk getBk( int index ) {
		return (OfflineBk)mvecBk.get(index);
	}

//------------------------------------ 内部関数 --------------------------------
	/**
	 * コンストラクタで受け取ったエレメントないのデータを
	 * 取得して、自身の変数に格納します。
	 */
	private void parse()
		throws OfflineLogParseException
	{
		// 属性値の設定
		// <loms>-<lom>-[id]属性を保持します
		mstrID = mobjLomElm.getAttribute( LOM_ID_ATTR );
		if( mstrID.equals("") ) {
			// 属性値が空の場合はnullを設定する
			mstrID = null;
		}

		// <loms>-<lom>-<cmi>エレメントデータの設定
		NodeList objCmiList = mobjLomElm.getElementsByTagName( LOM_CMI_ELM );

		int intCmiLen = objCmiList.getLength();

		if( intCmiLen == 0 ) {
			// <loms>-<lom>-<cmi>エレメントが存在しない場合はエラー
			throw new OfflineLogParseException( ERR_NOEXIST_CMI );
		}

		mobjCmi = new OfflineCmi( (Element)objCmiList.item(0) );

		// <loms>-<lom>-<bk> エレメントデータの設定
		NodeList objBkList = mobjLomElm.getElementsByTagName( LOM_BK_ELM );

		int intBkLen = objBkList.getLength();

		for( int i = 0; i < intBkLen; i++ ) {
			mvecBk.add( new OfflineBk( (Element)objBkList.item(i) ) );
		}
	}
//------------------------------------ 内部関数 --------------------------------

}

