// 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.Web.Configuration.Sql
{
    /// <summary>
    /// sql 要素のコレクションを格納する構成要素を表します。
    /// </summary>
    /// <remarks>
    /// <see cref="SqlsCollection"/> は、ページ設定ファイル内の sql 要素のコレクションを表します。 
    /// 詳細については <see cref="ConfigurationElementCollection"/> を参照してください。
    /// </remarks>
    public class SqlsCollection : ConfigurationElementCollection
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(SqlsCollection));

        /// <summary>
        /// sql 要素の要素名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "sql" です。
        /// </remarks>
        private const string SQL_ELEMENT_NAME = "sql";

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

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

        /// <summary>
        /// 新しい sql 要素を作成します。
        /// </summary>
        /// <returns>新しい sql 要素。</returns>
        /// <remarks>
        /// 新しい <see cref="SqlElement"/> オブジェクトを作成します。
        /// </remarks>
        protected override ConfigurationElement CreateNewElement()
        {
            return new SqlElement();
        }

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

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

        /// <summary>
        /// <see cref="SqlsCollection"/> の要素数を取得します。
        /// </summary>
        /// <value>
        /// <see cref="SqlsCollection"/> の要素数。
        /// </value>
        public virtual new int Count
        {
            get
            {
                return base.Count;
            }
        }

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

        /// <summary>
        /// sql 要素の要素キーを取得します。
        /// </summary>
        /// <param name="element">キーを返す <see cref="SqlElement"/>　。</param>
        /// <returns>指定した <see cref="SqlElement"/> のキーとして機能する <see cref="Object"/> 。</returns>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="element"/> が null 参照です。
        /// </exception>
        /// <exception cref="ArgumentException">
        /// <paramref name="element"/> が <see cref="SqlElement"/> ではありません。
        /// </exception>
        protected override Object GetElementKey(ConfigurationElement element)
        {
            if (element == null)
            {
                ArgumentNullException exception = new ArgumentNullException("element");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(
                        Web.Properties.Resources.E_NULL_ARGUMENT, "element"), exception);
                }
                throw exception;
            }
            SqlElement sqlElement = element as SqlElement;
            if (sqlElement == null)
            {
                string message = string.Format(Web.Properties.Resources.E_INVALID_TYPE, "element");
                ArgumentException exception = new ArgumentException(message);
                if (_log.IsErrorEnabled)
                {
                    _log.Error(message, exception);
                }
                throw exception;
            }

            return sqlElement.Name;
        }

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

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

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

    }
}
