// Copyright (c) 2008, 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.

using System.Configuration;
using System.Xml;
using TERASOLUNA.Fw.Common.Configuration;

namespace TERASOLUNA.Fw.Client.Configuration.View
{
    /// <summary>
    /// アプリケーション構成ファイル内の viewConfiguration セクションを表します。
    /// </summary>
    /// <remarks>
    /// <see cref="ConfigurationSection"/> クラスを拡張した、ViewConfiguration カスタム構成
    /// ハンドラです。
    /// 詳細については、<see cref="ConfigurationSection"/> を参照してください。
    /// </remarks>
    public class ViewConfigurationSection : ConfigurationSection
    {
        /// <summary>
        /// ViewConfiguraiton の要素名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "viewConfiguration" です。
        /// </remarks>
        private const string SECTION_NAME = "viewConfiguration";

        /// <summary>
        /// <see cref="FilesCollection"/> の要素名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "files" です。
        /// </remarks>
        private const string FILES_ELEMENT_NAME = "files";

        /// <summary>
        /// <see cref="ViewCollection"/> の要素名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "viewConfiguration" です。
        /// </remarks>
        private const string VIEW_CONFIGURATION_ELEMENT_NAME = "viewConfiguration";

        /// <summary>
        /// view 要素の id 属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "id" です。
        /// </remarks>
        private const string ID_ATTRIBUTE_NAME = "id";

        /// <summary>
        ///  view 要素の type 属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "type" です。
        /// </remarks>
        private const string TYPE_ATTRIBUTE_NAME = "type";

        /// <summary>
        /// 画面遷移設定ファイルのXML名前空間です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "http://www.terasoluna.jp/schema/ViewSchema.xsd" です。
        /// </remarks>
        private const string XML_NAMESPACE = "http://www.terasoluna.jp/schema/ViewSchema.xsd";

        /// <summary>
        /// 画面遷移設定ファイルのXML名前空間プレフィックスです。
        /// </summary>
        /// <remarks>
        /// この定数の値は "vw" です。
        /// </remarks>
        private const string XML_NAMESPACE_PREFIX = "vw";

        /// <summary>
        /// 画面遷移設定ファイルマージ処理で基準とする要素の XPATH です。
        /// </summary>
        /// <remarks>
        /// この定数の値は <see cref="XML_NAMESPACE_PREFIX"/> + ":viewConfiguration" です。
        /// </remarks>
        private const string SECTION_XPATH = XML_NAMESPACE_PREFIX + ":viewConfiguration";

        /// <summary>
        /// 画面遷移設定ファイルマージ処理でマージする要素の XPATH です。
        /// </summary>
        /// <remarks>
        /// この定数の値は <see cref="SECTION_XPATH"/> + "/" + <see cref="XML_NAMESPACE_PREFIX"/> + ":view" です。
        /// </remarks>
        private const string ELEMENT_XPATH = SECTION_XPATH + "/" + XML_NAMESPACE_PREFIX + ":view";

        /// <summary>
        /// XML スキーマファイルの完全名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "TERASOLUNA.Fw.Client.Configuration.View.ViewSchema.xsd" です。
        /// </remarks>
        private const string XML_SCHEMA_FILE_NAME = "TERASOLUNA.Fw.Client.Configuration.View.ViewSchema.xsd";

        /// <summary>
        /// <see cref="ViewConfigurationSection"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>
        /// デフォルトコンストラクタです。
        /// </remarks>
        public ViewConfigurationSection()
        {
        }

        /// <summary>
        /// files 要素を取得します。
        /// </summary>
        /// <remarks>
        /// viewConfiguration セクションから
        /// <see cref="FilesCollection"/> を取得します。
        /// </remarks>
        [ConfigurationProperty(FILES_ELEMENT_NAME, IsDefaultCollection = false, IsRequired = true)]
        public FilesCollection Files
        {
            get
            {
                FilesCollection filesCollection = (FilesCollection)base[FILES_ELEMENT_NAME];
                return filesCollection;
            }
        }

        /// <summary>
        /// ViewConfiguration 要素を取得します。
        /// </summary>
        /// <remarks>
        /// viewConfiguration セクションから
        /// <see cref="ViewCollection"/> を取得します。
        /// </remarks>
        [ConfigurationProperty(VIEW_CONFIGURATION_ELEMENT_NAME, IsDefaultCollection = false)]
        public ViewCollection ViewCollection
        {
            get
            {
                ViewCollection viewCollection = (ViewCollection)base[VIEW_CONFIGURATION_ELEMENT_NAME];
                return viewCollection;
            }
        }

        /// <summary>
        /// files 要素の設定内容から view 要素を生成して viewConfiguration 要素に追加します。
        /// </summary>
        /// <remarks>
        /// <para><see cref="MergeConfiguration"/> クラスのインスタンスを生成し、画面遷移設定ファイルの
        /// 設定情報をマージします。</para>
        /// <para>マージした画面遷移設定ファイルの内容から <see cref="ViewElement"/> クラスのインスタンス
        /// を生成し、<see cref="ViewCollection"/> に追加します。</para>
        /// </remarks>
        public void CreateViewElements()
        {
            // 画面遷移設定ファイルの設定情報をマージする
            MergeConfiguration mgConfig = 
                new MergeConfiguration(XML_NAMESPACE, XML_NAMESPACE_PREFIX, XML_SCHEMA_FILE_NAME);
            mgConfig.LoadConfig(SECTION_NAME, Files);
            XmlDocument xmlDoc = mgConfig.MergeXmlDocument(SECTION_XPATH, ELEMENT_XPATH);

            // 画面遷移設定ファイルの設定情報をviewConfiguration要素に追加する
            AddviewElements(xmlDoc);
        }

        /// <summary>
        /// 画面遷移設定ファイルの内容から view 要素を生成し、viewConfiguration 要素に追加します。
        /// </summary>
        /// <param name="xmlDoc">画面遷移設定ファイルの内容を保持する<see cref="XmlDocument" /> 。
        /// </param>
        private void AddviewElements(XmlDocument xmlDoc)
        {
            XmlNodeList list = xmlDoc.DocumentElement.ChildNodes;

            foreach (XmlNode node in list)
            {
                if (node is XmlElement)
                {
                    string name = node.Attributes[ID_ATTRIBUTE_NAME].InnerText;
                    string type = node.Attributes[TYPE_ATTRIBUTE_NAME].InnerText;
                    ViewElement element = new ViewElement(type, name);
                    ViewCollection.Add(element);
                }
            }
        }
    }
}
