// 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>
    /// 画面遷移設定ファイルから <see cref="ViewConfiguration"/> 設定情報を取得します。
    /// </summary>
    public abstract class ViewConfiguration
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(ViewConfiguration));

        /// <summary>
        /// View のタイプ名を取得します。
        /// </summary>
        /// <param name="id">取得する View の識別子。</param>
        /// <returns>存在する場合は、<paramref name="id"/> 引数の値に対応する 
        /// View のタイプ名。それ以外の場合は null 参照。</returns>
        /// <remarks>
        /// 画面遷移設定ファイルから、<paramref name="id"/> の値に対応する type 属性の
        /// 値を取得します。
        /// </remarks>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="id"/> が null 参照です。
        /// </exception>
        /// <exception cref="ArgumentException">
        /// <paramref name="id"/> が空の文字列です。
        /// </exception>
        /// <exception cref="ConfigurationErrorsException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <description>
        /// アプリケーション構成ファイルが読み込めません。
        /// </description>
        /// </item>
        /// <item>
        /// <description>
        /// アプリケーション構成ファイルの設定情報が不正です。
        /// </description>
        /// </item>
        /// <item>
        /// <description>
        /// 画面遷移設定ファイルが読み込めません。
        /// </description>
        /// </item>
        /// <item>
        /// <description>
        /// 画面遷移設定ファイルの XML スキーマが不正です。
        /// </description>
        /// </item>
        /// </list>
        /// </exception>
        public static string GetViewTypeName(string id)
        {
            if (id == null)
            {
                ArgumentNullException exception = new ArgumentNullException("id");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(
                        Properties.Resources.E_NULL_ARGUMENT, "id"), exception);
                }
                throw exception;
            }
            if (id.Length == 0)
            {
                string message = string.Format(Properties.Resources.E_EMPTY_STRING, "id");
                ArgumentException exception = new ArgumentException(message);
                if (_log.IsErrorEnabled)
                {
                    _log.Error(message, exception);
                }
                throw exception;
            }

            ViewConfigurationSection viewConfigSection = TerasolunaClientConfiguration.ViewConfigSection;

            // idに対応する設定が無い場合はnullを返却する
            string elementType = null;
            if (viewConfigSection != null && viewConfigSection.ViewCollection[id] != null)
            {
                elementType = viewConfigSection.ViewCollection[id].Type;
            }

            if (_log.IsTraceEnabled)
            {
                if (elementType == null)
                {
                    _log.Trace(string.Format(
                        Properties.Resources.T_VIEW_CONFIGURATION_NOT_LOAD_PARAMETER, id));
                }
                else
                {
                    _log.Trace(string.Format(
                        Properties.Resources.T_VIEW_CONFIGURATION_LOAD_PARAMETER, id, elementType));
                }
            }

            return elementType;
        }
    }
}
