// 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;
using System.Configuration;
using TERASOLUNA.Fw.Common.Logging;

namespace TERASOLUNA.Fw.Client.Configuration.View
{
    /// <summary>
    /// view 要素のコレクションを格納する構成要素を表します。
    /// </summary>
    /// <remarks>
    /// <see cref="ViewCollection"/> は、画面遷移設定ファイル内の view 要素のコレクションを
    /// 表します。 
    /// 詳細については <see cref="ConfigurationElementCollection"/> を参照してください。
    /// </remarks>
    public class ViewCollection : ConfigurationElementCollection
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(ViewCollection));

        /// <summary>
        /// view 要素の要素名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "view" です。
        /// </remarks>
        private static readonly string FORWARDABLE_ELEMENT_NAME = "view";

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

        /// <summary>
        /// <see cref="ViewCollection"/> の型を取得します。
        /// </summary>
        /// <remarks>
        /// このコレクションの <see cref="ConfigurationElementCollectionType"/> は BasicMap です。
        /// </remarks>
        /// <value>
        /// このコレクションの <see cref="ConfigurationElementCollectionType"/> 。
        /// </value>
        public override ConfigurationElementCollectionType CollectionType
        {
            get
            {
                return ConfigurationElementCollectionType.BasicMap;
            }
        }

        /// <summary>
        /// 新しい view 要素を作成します。
        /// </summary>
        /// <returns>新しい view 要素。</returns>
        /// <remarks>
        /// 新しい <see cref="ViewElement"/> クラスのインスタンスを作成します。
        /// </remarks>
        protected override ConfigurationElement CreateNewElement()
        {
            return new ViewElement();
        }

        /// <summary>
        /// 指定したインデックス位置にある view 要素を取得します。
        /// </summary>
        /// <param name="index">取得する ViewElement のインデックス位置。</param>
        /// <returns>指定したインデックス位置にある <see cref="ViewElement"/> 。</returns>
        /// <remarks>
        /// <see cref="ConfigurationElementCollection.BaseGet(int)"/> メソッドを使用して、
        /// <see cref="ViewCollection"/> から <see cref="ViewElement"/> を取得します。
        /// </remarks>
        public ViewElement this[int index]
        {
            get
            {
                return (ViewElement)BaseGet(index);
            }
        }

        /// <summary>
        /// 指定したキーを持つ view 要素を取得します。
        /// </summary>
        /// <param name="name">取得する view 要素のキー。</param>
        /// <returns>指定したキーを持つ <see cref="ViewElement"/> 。それ以外の場合は null 参照。
        /// </returns>
        /// <remarks>
        /// <see cref="ConfigurationElementCollection.BaseGet(object)"/> メソッドを使用して、
        /// <see cref="ViewCollection"/> から <see cref="ViewElement"/> を取得
        /// します。指定したキーを持つ <see cref="ViewElement"/> がコレクションに
        /// 存在しない場合、null 参照を返します。
        /// </remarks>
        public new ViewElement this[string name]
        {
            get
            {
                return (ViewElement)BaseGet(name);
            }
        }

        /// <summary>
        /// 画面遷移設定ファイル内のこの要素のコレクションを識別するために使用する
        /// 名前を取得します。
        /// </summary>
        /// <remarks>
        /// 要素名は view です。
        /// </remarks>
        /// <value>
        /// この要素のコレクションの要素名。
        /// </value>
        protected override string ElementName
        {
            get
            {
                return FORWARDABLE_ELEMENT_NAME;
            }
        }

        /// <summary>
        /// view 要素の要素キーを取得します。
        /// </summary>
        /// <param name="element">取得する <see cref="ViewElement"/> 要素のキー。</param>
        /// <returns>指定したキーを持つ <see cref="ViewElement"/> 。それ以外の場合は null 参照。
        /// </returns>
        /// <exception cref="System.ArgumentNullException"><paramref name="element"/> が null の場合。</exception>
        /// <exception cref="System.ArgumentException"><paramref name="element"/> が 
        /// <see cref="ViewElement"/> ではない場合。</exception>
        protected override Object GetElementKey(ConfigurationElement element)
        {
            if (element == null)
            {
                ArgumentNullException exception = new ArgumentNullException("element");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(
                        Client.Properties.Resources.E_NULL_ARGUMENT, "element"), exception);
                }
                throw exception;
            }
            ViewElement viewElement = element as ViewElement;
            if (viewElement == null)
            {
                string message = string.Format(
                    TERASOLUNA.Fw.Client.Properties.Resources.E_INVALID_CAST,
                    element.GetType().FullName, typeof(ViewElement).FullName);
                ArgumentException exception = new ArgumentException(message);
                if (_log.IsErrorEnabled)
                {
                    _log.Error(message, exception);
                }
                throw exception;
            }

            return viewElement.Id;
        }

        /// <summary>
        /// <see cref="ViewCollection"/> に view 要素を追加します。
        /// </summary>
        /// <param name="element">追加する <see cref="ViewElement"/> 。</param>
        /// <remarks>
        /// <see cref="ViewCollection.BaseAdd(ConfigurationElement)"/> メソッドを使用して、
        /// コレクションに新しい <see cref="ViewElement"/> を追加します。
        /// </remarks>
        public void Add(ViewElement element)
        {
            BaseAdd(element);
        }

        /// <summary>
        /// <see cref="ViewCollection"/> に view 要素を追加します。
        /// </summary>
        /// <param name="element">追加する <see cref="ViewElement"/> 。</param>
        /// <remarks>
        /// 指定した <paramref name="element"/> が view 要素コレクションに既に存在する場合、
        /// 例外は発生しません。
        /// </remarks>
        protected override void BaseAdd(ConfigurationElement element)
        {
            BaseAdd(element, false);
        }

        /// <summary>
        /// <see cref="ViewCollection"/> が読み取り専用かどうかを示す値を取得します。 
        /// </summary>
        /// <returns>
        /// <see cref="ViewCollection"/> が読み取り専用の場合は true 。それ以外の場合は false 。
        /// </returns>
        /// <remarks>
        /// <see cref="ViewCollection"/> は読み取り専用ではありません。
        /// </remarks>
        public override bool IsReadOnly()
        {
            return false;
        }
    }
}
