source: default/framework/trunk/WebLibrary/Sources/UI/WebControls/CommonDbDataSource.cs @ 1669

// ----------------------------------------------------------------------------
// <copyright company="F.C. Soft., Inc.">
//   Copyright(c) F.C. Soft., Inc.  All rights reserved.
// </copyright>
// <license>
//   Licensed to F.C. Soft., Inc. (FCSoft) under one or more contributor
//   license agreements.  See the NOTICE file distributed with this work for
//   additional information regarding copyright ownership.  FCSoft licenses
//   this file to You 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.
// </license>
// ----------------------------------------------------------------------------

namespace FCSoft.SilverFrost.Framework.Web.UI.WebControls
{
    using System;
    using System.Collections;
    using System.ComponentModel;
    using System.Diagnostics;
    using System.Web.UI;
    using System.Web.UI.WebControls;
    using FCSoft.SilverFrost.Framework.Data;
    using FCSoft.SilverFrost.Framework.Web.Properties;
    using Page = FCSoft.SilverFrost.Framework.Web.UI.Page;


    /// <summary>
    /// 共通 DB プロバイダを元にしたデータソースコントロールです。
    /// </summary>
    /// <remarks>
    /// <para>
    /// このデータソースコントロールは、共通 DB (<c>FCSoft.SilverFrost.Framework.Data</c>)
    /// 機能を元にしています。
    /// データを取得するために <see cref="ConnectionName"/> プロパティに指定された接続先設定名と
    /// <see cref="SelectStatementName"/> プロパティに指定された SQL ステートメントブロック名を使用します。
    /// <see cref="ConnectionName"/> プロパティを元に、このコントロールが配置されているページで
    /// 定義されている接続の中からデータベースコネクションを取得します。
    /// このコントロールは <see cref="FCSoft.SilverFrost.Framework.Web.UI.Page"/>
    /// クラス、またはサブクラスにのみ配置可能です。
    /// </para>
    /// <para>
    /// それ以外の方法として、<see cref="Connection"/> プロパティに
    /// 実際に使用するコネクションを指定する方法もあります。
    /// また、<see cref="Transaction"/> プロパティを指定して
    /// 任意のトランザクションにてデータ取得を行うことも出来ます。
    /// ただしこれらの場合、自動データバインドの機能を使用すると
    /// 任意のタイミングでデータ取得が発生するため、
    /// 有効なコネクション、トランザクションのスコープ内で
    /// <see cref="System.Web.UI.Control.DataBind()"/> メソッドを
    /// 明示的に呼び出す必要があります。
    /// </para>
    /// <para>
    /// スマートなページング機能に対応するためには
    /// <see cref="PagerStartParameterName"/>、<see cref="PagerEndParameterName"/>
    /// プロパティを指定する必要があります。
    /// これらのプロパティは SQL ステートメントのパラメータ名で、
    /// ページに対応するの最初と最後の行番号が指定されます。
    /// SQL ステートメントは、このプロパティによって指定された範囲の行を返すように
    /// 調整する必要があります。
    /// 注意点として、範囲指定がされない場合に、これらのパラメータが設定されません。
    /// そのため、SQL テンプレート内ではパラメータの有無によって
    /// SQL ステートメントが調整されるようにする必要があります。
    /// </para>
    /// <example>
    /// <para>
    /// ASPX の例
    /// </para>
    /// <code>
    /// &lt;sfc:CommonDbDataSource ID="DataSource" runat="server"
    ///     ConnectionName="DatabaseName"
    ///     SelectStatementName="UserSelect"
    ///     PagerStartParameterName="startRows"
    ///     PagerEndParameterName="endRows" /&gt;
    /// </code>
    /// <para>
    /// SQL テンプレートの例
    /// </para>
    /// <code>
    /// UserSelect =
    ///     SELECT
    ///         userId,
    ///         userName
    ///     FROM
    ///         user
    ///     WHERE
    ///         status = '1'
    ///         ${UserSelect_Start:@}
    ///         ${UserSelect_End:@}
    /// #
    /// UserSelect_Start = AND @startRows &lt;= ROWNUM
    /// UserSelect_End   = AND ROWNUM &lt;= @endRows
    /// </code>
    /// </example>
    /// <para>
    /// 汎用的にスマートなページング機能に対応するため
    /// <see cref="CompositeStatementName"/> プロパティを
    /// 指定することが出来ます。
    /// このプロパティは、<see cref="SelectStatementName"/> で
    /// 指定した SQL ステートメントを、スマートなページング機能に対応するための
    /// SQL ステートメントにラップする SQL ステートメントブロック名を指定します。
    /// この機能は、多くのデータベースでサポートされている集計関数を使用して
    /// SQL をラップすることを前提にしているため、<see cref="OrderStatementName"/>
    /// プロパティで並べ替え部分 (<c>ORDER BY</c> 以降) の指定をする必要があります。
    /// この場合、<see cref="SelectStatementName"/> では
    /// 並べ替え部分を指定することは出来ません。
    /// <see cref="SelectStatementName"/> と <see cref="OrderStatementName"/>
    /// の SQL ステートメントは、<see cref="CompositeStatementName"/> プロパティで
    /// 指定した SQL ステートメントブロックにある
    /// <see cref="CompositeSelectTargetStatementName"/>、
    /// <see cref="CompositeOrderTargetStatementName"/> プロパティで指定した
    /// 変数部分に埋め込まれます。
    /// </para>
    /// <para>
    /// これらの機能を使用するために、集計関数を使用した標準的な仕組みが用意されています。
    /// SQL テンプレートで
    /// <c>resource:FCSoft.SilverFrost.Framework.Web/FCSoft.SilverFrost.Framework.Web.Resources.Data.CommonDbDataSource.st</c>
    /// をインクルードし、
    /// <see cref="CompositeStatementName"/> プロパティに <c>SilverFrost.PagerComposite</c>、
    /// <see cref="CompositeSelectTargetStatementName"/> プロパティに <c>SilverFrost.PagerComposite.Select</c>、
    /// <see cref="CompositeOrderTargetStatementName"/> プロパティに <c>SilverFrost.PagerComposite.Order</c>、
    /// <see cref="PagerStartParameterName"/> プロパティに <c>SilverFrost_Pager_Start</c>、
    /// <see cref="PagerEndParameterName"/> プロパティに <c>SilverFrost_Pager_End</c>
    /// を指定します。
    /// </para>
    /// <example>
    /// <para>
    /// ASPX の例
    /// </para>
    /// <code>
    /// &lt;sfc:CommonDbDataSource ID="DataSource" runat="server"
    ///     ConnectionName="DatabaseName"
    ///     SelectStatementName="UserSelect"
    ///     OrderStatementName="UserSelect_Order"
    ///     CompositeStatementName="SilverFrost.PagerComposite"
    ///     CompositeSelectTargetStatementName="SilverFrost.PagerComposite.Select"
    ///     CompositeOrderTargetStatementName="SilverFrost.PagerComposite.Order"
    ///     PagerStartParameterName="SilverFrost_Pager_Start"
    ///     PagerEndParameterName="SilverFrost_Pager_End" /&gt;
    /// </code>
    /// <para>
    /// SQL テンプレートの例
    /// </para>
    /// <code>
    /// @include resource:FCSoft.SilverFrost.Framework.Web/FCSoft.SilverFrost.Framework.Web.Resources.Data.CommonDbDataSource.st
    /// #
    /// UserSelect =
    ///     SELECT
    ///         userId,
    ///         userName
    ///     FROM
    ///         user
    ///     WHERE
    ///         status = '1'
    /// #
    /// UserSelect_Order = userId
    /// </code>
    /// </example>
    /// </remarks>
    [DefaultProperty("SelectStatementName")]
    [ParseChildren(true)]
    [PersistChildren(false)]
    [WebDescription("Description_CommonDbDataSource")]
    [ControlInitializerTarget]
    public class CommonDbDataSource :
        DataSourceControl
    {
        /// <summary>
        /// デフォルトのビュー名。
        /// </summary>
        private const string DefaultViewName = "DefaultView";


        /// <summary>
        /// コネクション。
        /// </summary>
        [DebuggerBrowsable(DebuggerBrowsableState.Never)]
        private ICommonDbConnection connection;

        /// <summary>
        /// トランザクション。
        /// </summary>
        [DebuggerBrowsable(DebuggerBrowsableState.Never)]
        private ICommonDbTransaction transaction;

        /// <summary>
        /// ビュー名のコレクション。
        /// </summary>
        private ICollection viewNames;

        /// <summary>
        /// データソースビュー。
        /// </summary>
        private CommonDbDataSourceView view;


        /// <summary>
        /// インスタンスを作成します。
        /// </summary>
        public CommonDbDataSource()
        {
            ControlInitializer.ApplyProperties(this);
        }


        /// <summary>
        /// 接続先名を取得または設定します。
        /// </summary>
        /// <value>
        /// 接続先名を表す文字列。
        /// 既定値は空の文字列 ("") です。
        /// </value>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_ConnectionName")]
        public virtual string ConnectionName
        {
            get
            {
                return GetView().ConnectionName;
            }

            set
            {
                GetView().ConnectionName = value;
            }
        }

        /// <summary>
        /// データベースコネクションを取得または設定します。
        /// </summary>
        /// <value>
        /// データベースコネクション。
        /// 既定値は <see langword="null"/> 参照です。
        /// </value>
        [Browsable(false)]
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
        public virtual ICommonDbConnection Connection
        {
            get
            {
                return connection;
            }

            set
            {
                connection = value;
            }
        }

        /// <summary>
        /// データベーストランザクションを取得または設定します。
        /// </summary>
        /// <value>
        /// データベーストランザクション。
        /// 既定値は <see langword="null"/> 参照です。
        /// </value>
        /// <remarks>
        /// トランザクションが設定されている場合は、このトランザクションが優先して使用されます。
        /// 自動データバインドの場合、任意のタイミングでトランザクションが使用されるため、
        /// 設定してあるトランザクションが有効ではないかもしれません。
        /// これを避けるため、<see cref="Transaction"/> プロパティを設定した場合、
        /// トランザクションのスコープ内で <see cref="System.Web.UI.Control.DataBind()"/>
        /// メソッドを明示的に呼び出す必要があります。
        /// </remarks>
        [Browsable(false)]
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
        public virtual ICommonDbTransaction Transaction
        {
            get
            {
                return transaction;
            }

            set
            {
                transaction = value;
            }
        }

        /// <summary>
        /// ページング用にデータ取得開始行番号を指定するために
        /// 使用するパラメータ名を取得または設定します。
        /// </summary>
        /// <value>
        /// パラメータ名。
        /// 既定値は空の文字列 ("") です。
        /// 空の文字列を指定した場合、開始行番号は指定されなくなります。
        /// </value>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_PagerStartParameterName")]
        public virtual string PagerStartParameterName
        {
            get
            {
                return GetView().PagerStartParameterName;
            }

            set
            {
                GetView().PagerStartParameterName = value;
            }
        }

        /// <summary>
        /// ページング用にデータ取得終了行番号を指定するために
        /// 使用するパラメータ名を取得または設定します。
        /// </summary>
        /// <value>
        /// パラメータ名。
        /// 既定値は空の文字列 ("") です。
        /// 空の文字列を指定した場合、開始行番号は指定されなくなります。
        /// </value>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_PagerEndParameterName")]
        public virtual string PagerEndParameterName
        {
            get
            {
                return GetView().PagerEndParameterName;
            }

            set
            {
                GetView().PagerEndParameterName = value;
            }
        }

        /// <summary>
        /// SQL ステートメントブロック名に対応する SQL テンプレートのパスを
        /// 取得または設定します。
        /// </summary>
        /// <value>
        /// SQL テンプレートのパス。
        /// 既定値は空の文字列 ("") です。
        /// 空の文字列の場合、使用されるコネクションに設定されている
        /// SQL テンプレートが使用されます。
        /// </value>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_SqlTemplatePath")]
        public virtual string SqlTemplatePath
        {
            get
            {
                return GetView().SqlTemplatePath;
            }

            set
            {
                GetView().SqlTemplatePath = value;
            }
        }

        /// <summary>
        /// データを並び替えるために <see cref="OrderStatementName"/>
        /// プロパティを指定した場合に、
        /// <see cref="SelectStatementName"/> プロパティで指定した
        /// SQL ステートメントを結合させるために使用される
        /// SQL ステートメントブロック名を取得または設定します。
        /// </summary>
        /// <value>
        /// SQL ステートメントブロック名。
        /// 既定値は空の文字列 ("") です。
        /// <see cref="OrderStatementName"/> が指定された場合、
        /// このプロパティも指定する必要があります。
        /// </value>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_CompositeStatementName")]
        public virtual string CompositeStatementName
        {
            get
            {
                return GetView().CompositeStatementName;
            }

            set
            {
                GetView().CompositeStatementName = value;
            }
        }

        /// <summary>
        /// <see cref="CompositeStatementName"/> で指定した
        /// SQL ステートメントブロックに対して、
        /// <see cref="SelectStatementName"/> で指定した
        /// SQL ステートメントブロックを埋め込むときに使用する
        /// SQL ステートメントブロック名です。
        /// </summary>
        /// <value>
        /// SQL ステートメントブロック名。
        /// 既定値は空の文字列 ("") です。
        /// <see cref="CompositeStatementName"/> が指定された場合、
        /// このプロパティも指定する必要があります。
        /// </value>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_CompositeSelectTargetStatementName")]
        public virtual string CompositeSelectTargetStatementName
        {
            get
            {
                return GetView().CompositeSelectTargetStatementName;
            }

            set
            {
                GetView().CompositeSelectTargetStatementName = value;
            }
        }

        /// <summary>
        /// <see cref="CompositeStatementName"/> で指定した
        /// SQL ステートメントブロックに対して、
        /// <see cref="OrderStatementName"/> で指定した
        /// SQL ステートメントブロックを埋め込むときに使用する
        /// SQL ステートメントブロック名です。
        /// </summary>
        /// <value>
        /// SQL ステートメントブロック名。
        /// 既定値は空の文字列 ("") です。
        /// <see cref="OrderStatementName"/> が指定された場合、
        /// このプロパティも指定する必要があります。
        /// </value>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_CompositeOrderTargetStatementName")]
        public virtual string CompositeOrderTargetStatementName
        {
            get
            {
                return GetView().CompositeOrderTargetStatementName;
            }

            set
            {
                GetView().CompositeOrderTargetStatementName = value;
            }
        }

        /// <summary>
        /// データを取得する際に使用する
        /// SQL ステートメントブロック名を取得または設定します。
        /// </summary>
        /// <value>
        /// データを取得するための SQL ステートメントブロック名。
        /// 既定値は空の文字列 ("") です。
        /// </value>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_SelectStatementName")]
        public virtual string SelectStatementName
        {
            get
            {
                return GetView().SelectStatementName;
            }

            set
            {
                GetView().SelectStatementName = value;
            }
        }

        /// <summary>
        /// データを取得する際にデータの並びかえを行うために使用する
        /// SQL ステートメントブロック名を取得または設定します。
        /// </summary>
        /// <value>
        /// データの並び替えをするための SQL ステートメントブロック名。
        /// 既定値は空の文字列 ("") です。
        /// </value>
        /// <remarks>
        /// <para>
        /// このプロパティで使用できる SQL ステートメントは、
        /// <see cref="CompositeStatementName"/> プロパティで指定された
        /// SQL ステートメントに左右されます。
        /// </para>
        /// <para>
        /// 標準の実装の場合、ここで指定された SQL ステートメントは、
        /// <c>ORDER BY</c> の後ろに展開されます。
        /// また、ページング用の SQL ステートメントに展開された場合、
        /// テーブル修飾子が解決できなくなるため、
        /// 必ずテーブル修飾子を付けないフィールド名のみを指定する必要があります。
        /// </para>
        /// <example>
        /// <para>
        /// 正しい例
        /// </para>
        /// <code>
        /// name, age desc, office
        /// </code>
        /// </example>
        /// <example>
        /// <para>
        /// 正しくない例
        /// </para>
        /// <code>
        /// t.name, user.age
        /// </code>
        /// </example>
        /// </remarks>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_OrderStatementName")]
        public virtual string OrderStatementName
        {
            get
            {
                return GetView().OrderStatementName;
            }

            set
            {
                GetView().OrderStatementName = value;
            }
        }

        /// <summary>
        /// データを取得する際にデータの並びかえを行うために使用する
        /// SQL ステートメントブロック名を取得するためのコントロールを取得または設定します。
        /// </summary>
        /// <value>
        /// データの並び替えをするための SQL ステートメントブロック名を取得するコントロール。
        /// 既定値は空の文字列 ("") です。
        /// </value>
        [IDReferenceProperty]
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_ControlToGetOrderStatementName")]
        public virtual string ControlToGetOrderStatementName
        {
            get
            {
                return GetView().ControlToGetOrderStatementName;
            }

            set
            {
                GetView().ControlToGetOrderStatementName = value;
            }
        }

        /// <summary>
        /// <see cref="CommonDbDataSource"/> コントロールに関連付けられた
        /// <see cref="CommonDbDataSourceView"/> オブジェクトから、
        /// <see cref="SelectStatementName"/> プロパティで使用される
        /// ステートメントブロックを格納するパラメータ コレクションを取得します。
        /// </summary>
        /// <value>
        /// <see cref="SelectStatementName"/> プロパティによって使用される
        /// ステートメントブロックを格納している <see cref="ParameterCollection"/>。
        /// </value>
        [Themeable(false)]
        [DefaultValue(null)]
        [PersistenceMode(PersistenceMode.InnerProperty)]
        [MergableProperty(false)]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_StatementBlocks")]
        public ParameterCollection SelectStatementBlocks
        {
            get
            {
                return GetView().SelectStatementBlocks;
            }
        }

        /// <summary>
        /// パラメータの値を自動的に更新するかどうかを取得または設定します。
        /// </summary>
        /// <value>
        /// パラメータの値を自動的に更新する場合は <see langword="true"/>。
        /// それ以外の場合は <see langword="false"/>。
        /// 既定値は <see langword="true"/> です。
        /// </value>
        [Themeable(false)]
        [DefaultValue(true)]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_AutoParameterUpdate")]
        public virtual bool AutoUpdateParameter
        {
            get
            {
                return GetView().AutoUpdateParameter;
            }

            set
            {
                GetView().AutoUpdateParameter = value;
            }
        }

        /// <summary>
        /// <see cref="CommonDbDataSource"/> コントロールに関連付けられた
        /// <see cref="CommonDbDataSourceView"/> オブジェクトから、
        /// <see cref="SelectStatementName"/> プロパティで使用される
        /// パラメータを格納するパラメータ コレクションを取得します。
        /// </summary>
        /// <value>
        /// <see cref="SelectStatementName"/> プロパティによって使用される
        /// パラメータを格納している <see cref="ParameterCollection"/>。
        /// </value>
        [Themeable(false)]
        [DefaultValue(null)]
        [PersistenceMode(PersistenceMode.InnerProperty)]
        [MergableProperty(false)]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_SelectParameters")]
        public ParameterCollection SelectParameters
        {
            get
            {
                return GetView().SelectParameters;
            }
        }

        /// <summary>
        /// データを取得するときの最大行数を取得または設定します。
        /// </summary>
        /// <value>
        /// データを取得するときの最大行数。
        /// 既定値は <c>0</c> です。
        /// <c>0</c> を指定した場合、全てのデータが取得されるようになります。
        /// </value>
        [Themeable(false)]
        [DefaultValue(0)]
        [WebCategory("Data")]
        [WebDescription("Description_CommonDbDataSource_MaximumRows")]
        public virtual int MaximumRows
        {
            get
            {
                return GetView().MaximumRows;
            }

            set
            {
                GetView().MaximumRows = value;
            }
        }

        /// <summary>
        /// パラメータの値を自動的に更新するかどうかを取得します。
        /// </summary>
        /// <value>
        /// パラメータの値を自動的に更新する場合は <see langword="true"/>。
        /// それ以外の場合は <see langword="false"/>。
        /// 既定値は <see langword="true"/> です。
        /// </value>
        internal bool UpdateParameterValue
        {
            get
            {
                return GetView().UpdateParameterValue;
            }
        }


        /// <summary>
        /// 取得したデータ情報を破棄します。
        /// </summary>
        /// <remarks>
        /// このデータソースはページングをサポートしていて、
        /// データのトータル件数はキャッシュされています。
        /// このメソッドを呼び出すことにより、この情報を破棄し再取得されるようになります。
        /// </remarks>
        public virtual void ClearResult()
        {
            GetView().ClearResult();
        }

        /// <summary>
        /// <see cref="AutoUpdateParameter"/> が <see langword="false"/> に設定されている場合、
        /// 次にパラメータの値が必要になった時に最新のパラメータの値を収集します。
        /// </summary>
        /// <remarks>
        /// <see cref="AutoUpdateParameter"/> が <see langword="false"/> に設定されている場合は、
        /// 保存されているパラメータの値が使用されます。
        /// このメソッドを呼び出すことにより、最新のパラメータの値が使用されるようになります。
        /// この呼び出しは1回のポストバックでのみ有効です。
        /// </remarks>
        public virtual void UpdateParameter()
        {
            GetView().UpdateParameter();
        }

        /// <summary>
        /// このデータソースに関連付けられたコネクションを返します。
        /// </summary>
        /// <returns>
        /// コネクション。
        /// </returns>
        /// <exception cref="InvalidOperationException">
        /// コネクションが見つかりません。
        /// </exception>
        internal ICommonDbConnection FindConnection()
        {
            ICommonDbConnection resultConnection = Connection;

            // コネクションが指定されている場合はそれを返す
            if (resultConnection != null)
            {
                return resultConnection;
            }

            // ページが設定されているか
            if (Page == null)
            {
                throw new InvalidOperationException(Utility.Format(
                    Resources.InvalidOperation_CommonDbDataSource_PageNotSet,
                    ID));
            }

            // ページが正しいか
            Page page = Page as Page;
            if (page == null)
            {
                throw new InvalidOperationException(Utility.Format(
                    Resources.InvalidOperation_CommonDbDataSource_InvalidPage,
                    ID));
            }

            string connectionName = ConnectionName;
            if (string.IsNullOrEmpty(connectionName))
            {
                throw new InvalidOperationException(Utility.Format(
                    Resources.InvalidOperation_CommonDbDataSource_ConnectionNameNotSet,
                    ID));
            }

            // 接続先名に対応するコネクションを取得
            if (!page.Connections.TryGetValue(connectionName, out resultConnection))
            {
                throw new InvalidOperationException(Utility.Format(
                    Resources.InvalidOperation_CommonDbDataSource_ConnectionNotFound,
                    ID,
                    connectionName));
            }

            return resultConnection;
        }

        /// <summary>
        /// <see cref="CommonDbDataSource"/> コントロールを格納する
        /// <see cref="UI.Page"/> コントロールに
        /// <see cref="System.Web.UI.Page.LoadComplete"/> イベント ハンドラを追加します。
        /// </summary>
        /// <param name="e">
        /// イベント データを格納している <see cref="EventArgs"/>。
        /// </param>
        protected override void OnInit(EventArgs e)
        {
            base.OnInit(e);

            if (Page != null)
            {
                Page.LoadComplete += LoadCompleteEventHandler;
            }
        }

        /// <summary>
        /// コントロールへの変更の追跡および保存の開始点を、
        /// コントロールのビューステートの一部としてマークします。
        /// </summary>
        protected override void TrackViewState()
        {
            base.TrackViewState();

            if (view != null)
            {
                ((IStateManager)view).TrackViewState();
            }
        }

        /// <summary>
        /// <see cref="CommonDbDataSource"/> コントロールの保存された状態を読み込みます。
        /// </summary>
        /// <param name="savedState">
        /// <see cref="CommonDbDataSource"/> の保存された状態を格納している
        /// <see cref="Object"/>。
        /// </param>
        protected override void LoadViewState(object savedState)
        {
            if (savedState == null)
            {
                base.LoadViewState(null);
                return;
            }

            Pair state = (Pair)savedState;

            base.LoadViewState(state.First);

            if (state.Second != null)
            {
                ((IStateManager)GetView()).LoadViewState(state.Second);
            }
        }

        /// <summary>
        /// <see cref="CommonDbDataSource"/> コントロールの状態を格納します。
        /// </summary>
        /// <returns>
        /// <see cref="CommonDbDataSource"/> の保存された状態を格納しているオブジェクト。
        /// </returns>
        protected override object SaveViewState()
        {
            Pair state = new Pair
            {
                First = base.SaveViewState(),
            };

            if (view != null)
            {
                state.Second = ((IStateManager)view).SaveViewState();
            }

            if (state.First == null && state.Second == null)
            {
                return null;
            }

            return state;
        }

        /// <summary>
        /// データ ソースをサーバー コントロールの子コントロールにバインドします。
        /// </summary>
        protected override void DataBindChildren()
        {
            // 親を呼び出す
            base.DataBindChildren();

            // バインドが必要なパラメータにデータをバインド
            BoundParameter.DataBind(Page, SelectParameters);
        }

        /// <summary>
        /// <see cref="CommonDbDataSource"/> インターフェイスに関連付けられた
        /// ビュー オブジェクトのリストを表す名前のコレクションを取得します。
        /// </summary>
        /// <returns>
        /// <see cref="CommonDbDataSource"/> に関連付けられたビューの名前が格納されている
        /// <see cref="ICollection"/>。
        /// </returns>
        protected override ICollection GetViewNames()
        {
            return viewNames ?? (viewNames = new[] { DefaultViewName });
        }

        /// <summary>
        /// データ ソース コントロールに関連付けられた名前付きデータ ソース ビューを取得します。
        /// </summary>
        /// <param name="viewName">
        /// 取得するビューの名前。
        /// </param>
        /// <returns>
        /// <see cref="CommonDbDataSource"/> に関連付けられた名前付きの
        /// <see cref="CommonDbDataSourceView"/> を返します。
        /// </returns>
        /// <exception cref="ArgumentException">
        /// <paramref name="viewName"/> が正しくありません。
        /// </exception>
        protected override DataSourceView GetView(string viewName)
        {
            if (viewName == null
                || (viewName.Length != 0
                    && !string.Equals(viewName, DefaultViewName, StringComparison.OrdinalIgnoreCase)))
            {
                throw new ArgumentException(
                    Resources.Argument_CommonDbDataSource_ViewName, "viewName");
            }

            return GetView();
        }

        /// <summary>
        /// データ ソース コントロールに関連付けられたデータ ソース ビュー オブジェクトを作成します。
        /// </summary>
        /// <param name="viewName">
        /// データ ソース ビューの名前。
        /// </param>
        /// <returns>
        /// <see cref="CommonDbDataSource"/> に関連付けられた
        /// <see cref="CommonDbDataSourceView"/>。
        /// </returns>
        protected virtual CommonDbDataSourceView CreateDataSourceView(string viewName)
        {
            return new CommonDbDataSourceView(this, viewName, Context);
        }

        /// <summary>
        /// ビューを取得します。
        /// </summary>
        /// <returns>
        /// 関連付けられたビュー。
        /// </returns>
        private CommonDbDataSourceView GetView()
        {
            return view ?? (view = CreateDataSourceView(DefaultViewName));
        }

        /// <summary>
        /// ページのロードが完了したときに呼び出される
        /// <see cref="System.Web.UI.Page.LoadComplete"/> イベント ハンドラです。
        /// </summary>
        /// <param name="sender">
        /// イベントのソース。
        /// </param>
        /// <param name="e">
        /// イベント データを格納している <see cref="EventArgs"/>。
        /// </param>
        private void LoadCompleteEventHandler(object sender, EventArgs e)
        {
            SelectParameters.UpdateValues(Context, this);
        }
    }
}