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

//
// XMLユーティリティクラス
// 
//
//	変更履歴
//	2004/01/08 新規作成	T.Nishiki 
//
package jp.co.ntt.lms.xms.common.util;

import java.util.ArrayList;
import java.util.List;

import jp.co.ntt.lms.xms.framework.XmsException;
import jp.co.ntt.lms.xms.framework.XmsInnerException;

import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * XMLユーティリティ・クラス。<br>
 * 
 * @author T.Nishiki
 */
public final class XmlUtil {

	/**
	 * ノードを検索する。<br>
	 * @param contextNode 検索開始となるノード。
	 * @param str 検索するキーとなるノード・パス。
	 * @return 検索した結果として該当したノードの配列。
	 *          該当するノードがない場合、要素のない配列を戻す。
	 * @throws XmsException 処理中にエラーが発生した場合。
	 */
	public static Node[] selectNodes(Node contextNode, String str)
		throws XmsException {
			
		List pathList  = null;
		List resultList  = null;
		Node[] returnNodes = null;
		try {
			// ノード・パスをスラッシュで区切る。
			pathList = StringUtil.split( str, "/" );
			// 検索を実施。
			resultList = selectNodes(contextNode, pathList);
			// Listを配列に変換。
			returnNodes = new Node[ resultList.size() ];
			for ( int i = 0; i < returnNodes.length; i++ ) {
				returnNodes[i] = (Node)resultList.get( i ) ;
			}
		} catch ( XmsException e ) {
			throw e;
		} catch ( Exception e ) {
			throw new XmsInnerException( e );
		}
		return returnNodes;
	}
	
	/**
	 * ノードを検索する。<br>
	 * @param contextNode 検索開始となるノード。
	 * @param str 検索するキーとなるノード・パス。
	 * @return 検索した結果として該当したノード。
	 *          該当するノードがない場合、nullを戻す。
	 * @throws XmsException 処理中にエラーが発生した場合。
	 */
	public static Node selectNode(Node contextNode, String str)
			throws XmsException {
		List pathList   = null;
		List resultList = null;
		Node returnNode = null;
		try {
			// ノード・パスをスラッシュで区切る。
			pathList = StringUtil.split( str, "/" );
			// 検索を実施。
			resultList = selectNodes(contextNode, pathList);
			
			// 検索結果のうち、先頭要素のみを利用。
			if (resultList.size() > 0 ) {
				returnNode = (Node)resultList.get(0);
			}
		} catch ( XmsException e ) {
			throw e;
		} catch ( Exception e ) {
			throw new XmsInnerException( e );
		}
		return returnNode;
	}
	
	/**
	 * 属性値を取得します。<br>
	 * 指定したノードに指定した名称の属性がある場合、その属性値を戻す。
	 * 上記に当てはまらない場合、nullを戻す。
	 * 
	 * @param node 属性を取得するノード。
	 * @param name 値を確認する属性名称。
	 * @return 指定した属性の値を戻す。
	 *          属性が存在しない、指定した名称の属性がない場合、
	 *          nullを戻す。
	 */
	public static String getAttributeValue( Node node, String name )
			throws XmsException {
		// このメソッドの戻り値
		String attributeValue = null;
		// 属性マップ。
		NamedNodeMap attributes = null;
		// 属性ノード。
		Node   attributeNode = null;
		try {
			// 属性マップを取得
			attributes = node.getAttributes();
			if ( attributes != null ) {
				// 属性を取得
				attributeNode = attributes.getNamedItem( name );
				if ( attributeNode != null ) {
					attributeValue = attributeNode.getNodeValue();
				}
			}
		} catch ( Exception e ) {
			throw new XmsInnerException( e );
		}
		return attributeValue;
	}
	
	/**
	 * ノード・リストから指定した名称・値の属性があるノードを取得する。<br>
	 * @param nodeList 属性を確認するノード。
	 * @param targetName 確認する属性名称。
	 * @param targetValue 確認する属性値。
	 * @return 指定した属性の値を戻す。
	 *          属性が存在しない、指定した名称の属性がない場合、
	 *          nullを戻す。
	 * @throws XmsException
	 */
	public static Node searchNodeByAttribute( NodeList nodeList, String targetName, String targetValue )
			throws XmsException {

		// 属性値確認用
		String attributeValue = null;
		/// このメソッドの戻り値
		Node returnNode = null;
		try {
			for ( int i = 0 ; i < nodeList.getLength(); i++ ) {
				Node node = nodeList.item(i);
				attributeValue = getAttributeValue(node, targetName );
				if ( attributeValue == null ) {
					continue;
				}
				
				if ( attributeValue.equals( targetValue ) == true ) {
					returnNode = node;
					break;
				}
			}
		} catch ( Exception e ) {
			throw new XmsInnerException( e );
		}
		return returnNode;
	}

	
	/**
	 * ノード配列から指定した名称・値の属性があるノードを取得する。<br>
	 * @param nodes 属性を確認するノード。
	 * @param targetName 確認する属性名称。
	 * @param targetValue 確認する属性値。
	 * @return 指定した属性の値を戻す。
	 *          属性が存在しない、指定した名称の属性がない場合、
	 *          nullを戻す。
	 * @throws XmsException
	 */
	public static Node searchNodeByAttribute( Node[] nodes, String targetName, String targetValue )
			throws XmsException {

		// 属性値確認用
		String attributeValue = null;
		/// このメソッドの戻り値
		Node returnNode = null;
		try {
			for ( int i = 0 ; i < nodes.length; i++ ) {
				Node node = nodes[i];
				attributeValue = getAttributeValue(node, targetName );
				if ( attributeValue == null ) {
					continue;
				}
				
				if ( attributeValue.equals( targetValue ) == true ) {
					returnNode = node;
					break;
				}
			}
		} catch ( Exception e ) {
			throw new XmsInnerException( e );
		}
		return returnNode;
	}

	/**
	 * ノードを検索する。<br>
	 * @param contextNode 検索開始となるノード。
	 * @param pathList 検索するキーとなるノード名を要素とするリスト。
	 * @return 検索した結果として該当したノードのリスト。
	 *          該当するノードがない場合、要素のないリストを戻す。
	 * @throws XmsException 処理中にエラーが発生した場合。
	 */
	private static List selectNodes(Node contextNode, List pathList)
		throws XmsException {
		
		// 戻り用のリスト
		List returnList = null;
		// 先頭ノード名（直下の子要素検索用）
		String topPath = null;
		// 直下の子要素リスト
		NodeList children = null;
		// 先頭を除いたノード名リスト（再帰検索用）
		List childPathList = null;
		try {
			// 戻り用のリストを空で準備しておく。
			returnList = new ArrayList();
			// ノード名リストの先頭を取得
			topPath = (String)pathList.get(0);
			// 先頭を除いたノード名リストを取得
			childPathList = pathList.subList(1, pathList.size() );
			
			// 内容に関わらず、直下の子要素を取得し、
			// そのうち、先頭ノード名と一致するノードを取得する。
			// 一致する要素があり、再帰検索用のノード名リストがあれば、
			// さらにその下の要素について再帰検索を実施し、
			// それらの結果を統合した結果を戻す。
			// 一致する要素があり、再帰検索用のノード名リストがなければ、
			// その一致した要素が、該当要素として、まとめて戻す。
			children = contextNode.getChildNodes();
			for ( int i = 0; i < children.getLength(); i++ ) {
				// 子要素を１つ１つチェックする
				Node childNode = null;
				String childNodeName = null;
				childNode = children.item(i);
				// text()取得を指定している場合、取得したノードがTEXTであれば、追加。
				if (( topPath.equals( "text()" ) == true)
					&& (childNode.getNodeType() == Node.TEXT_NODE ) ) {
					returnList.add( childNode );
					continue;
				}
				// =============================================================
				// 要素の名前を取得
				childNodeName = childNode.getNodeName();
				// 要素の名前が一致しなければ無視
				if ( childNodeName.equals(topPath) == false ) {
					continue;
				}
				// =============================================================
				// 一致し、かつ、再帰検索用のノード名リストがなければ、
				// 一致したノードを戻り値に含める。
				if ( childPathList.size() == 0 ) {
					returnList.add( childNode );
					continue;
				}
				// =============================================================
				// 子要素に対して再帰検索を実施し、
				// その結果を併合する。
				List childRetuernedList = null;
				childRetuernedList = selectNodes( childNode, childPathList ); 
				returnList.addAll(childRetuernedList);			
			}
		} catch (Exception e ) {
			throw new XmsInnerException( e );
		}
		return returnList;
	}


}
