IDataSource

.NET Framework クラス ライブラリ リファレンス

IDataSource イベント

パブリック イベント

	名前	説明
	DataSourceChanged	データ バインド コントロールに影響を与える変更がデータ ソース コントロールに加えられたときに発生します。

参照

関連項目

IDataSource インターフェイス
System.Web.UI 名前空間
IDataSource インターフェイス
DataSourceView クラス
HierarchicalDataSourceControl クラス

その他の技術情報

ASP.NET データ アクセスの概要
データ ソース コントロールの概要

IDataSource インターフェイス

メモ : このインターフェイスは、.NET Framework version 2.0 で新しく追加されたものです。

データ バインド コントロールをバインドする抽象データ ソースを表します。

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Interface IDataSource

Visual Basic (使用法)

Dim instance As IDataSource

C#

public interface IDataSource

C++

public interface class IDataSource

J#

public interface IDataSource

JScript

public interface IDataSource

解説

ASP.NET では、Web サーバー コントロールを一貫した方式でデータにバインドできるようにするコントロール データ バインディング アーキテクチャがサポートされています。データにバインドされる Web サーバー コントロールをデータ バインド コントロールといいます。また、そのバインディングを容易にするクラスをデータ ソース コントロールといいます。データ ソース コントロールは、リレーショナル データベース、ファイル、ストリーム、ビジネス オブジェクトなど、あらゆるデータ ソースを表すことができます。データ ソース コントロールにより、基になるデータのソースや形式にかかわらず、一貫した方式でデータがデータ バインド コントロールに提供されます。

独自のカスタム ASP.NET データ ソース コントロールを実装するには、IDataSource インターフェイスを実装します。

IDataSource インターフェイスを実装するクラスはすべてデータ ソース コントロールです。IDataSource インターフェイスは、すべての ASP.NET データ ソース コントロールの基盤となります。また、データ バインディング アーキテクチャの基本的な概念の 1 つを、GetView メソッドおよび GetViewNames メソッドという 2 つのメソッドで定義しています。この概念は、すべてのデータ ソース コントロールがそのデータに対して 1 つ以上の名前付きビューをサポートしていることを意味します。データ ソース ビュー オブジェクトは、System.Data 名前空間内の DataView の抽象化に似ています。このオブジェクトは、並べ替え、フィルタ処理、およびビューで定義されるその他のデータ操作を実行するための、データをバインドできるカスタマイズされたデータのビューを表します。根本的には、データ ソース コントロールで行われる操作はデータのビューを取得することだけです。

データ ソース コントロールには、1 つ以上のデータ ソース ビュー オブジェクトを関連付けることができます。ただし、リレーショナル データベースを表す SqlDataSource や AccessDataSource など、1 つのビューしかサポートされないデータ ソース コントロールもあります。SiteMapDataSource などの階層データ ソース コントロールを含むその他のデータ ソース コントロールでは、多くのビューがサポートされます。データ ソース ビューによって、データ ソースの機能とサポートされる操作が定義されます。

要約すると、IDataSource インターフェイスを実装するデータ ソース コントロールでは、そのコントロールが表すデータに対して 1 つ以上の名前付きビューをサポートし、また、そのコントロールが表すデータ ソースからのデータ取得を常にサポートします。データ ソース コントロールは、常に要求に応じてデータを取得します。たとえば、データ バインド コントロールで DataBind が呼び出されたときなどです。

使用例

IDataSource インターフェイスで定義されたメソッドをクラスに実装して、データ バインド コントロールにデータを指定する方法を次のコード例に示します。この例のデータ ソース コントロールは、コンマ区切りの値が含まれるファイルのデータ ソースとして機能し、コンマ区切りのファイル データを表示する場合には任意のデータ バインド コントロールで使用できます。このコード例は、DataSourceControl クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

Imports System
Imports System.Collections
Imports System.Data
Imports System.IO
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls

Namespace Samples.AspNet.VB.Controls

' The CsvDataSource is a data source control that retrieves its
' data from a comma-separated value file.
<AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)>
 _
Public Class CsvDataSource
   Inherits DataSourceControl

   Public Sub New()
   End Sub 'New

   ' The comma-separated value file to retrieve data from.
   Public Property FileName() As
 String
      Get
         Return CType(Me.GetView([String].Empty),
 CsvDataSourceView).SourceFile
      End Get
      Set
         ' Only set if it is different.
         If CType(Me.GetView([String].Empty),
 CsvDataSourceView).SourceFile <> value Then
            CType(Me.GetView([String].Empty), CsvDataSourceView).SourceFile
 = value
            RaiseDataSourceChangedEvent(EventArgs.Empty)
         End If
      End Set
   End Property

   ' Do not add the column names as a data row. Infer columns if the
 CSV file does
   ' not include column names.

   Public Property IncludesColumnNames() As
 Boolean
      Get
         Return CType(Me.GetView([String].Empty),
 CsvDataSourceView).IncludesColumnNames
      End Get
      Set
         ' Only set if it is different.
         If CType(Me.GetView([String].Empty),
 CsvDataSourceView).IncludesColumnNames <> value Then
            CType(Me.GetView([String].Empty), CsvDataSourceView).IncludesColumnNames
 = value
            RaiseDataSourceChangedEvent(EventArgs.Empty)
         End If
      End Set
   End Property


   ' Return a strongly typed view for the current data source control.
   Private view As CsvDataSourceView = Nothing

   Protected Overrides Function
 GetView(viewName As String) As
 DataSourceView
      If view Is Nothing
 Then
         view = New CsvDataSourceView(Me, String.Empty)
      End If
      Return view
   End Function 'GetView

   ' The ListSourceHelper class calls GetList, which
   ' calls the DataSourceControl.GetViewNames method.
   ' Override the original implementation to return
   ' a collection of one element, the default view name.
   Protected Overrides Function
 GetViewNames() As ICollection
      Dim al As New ArrayList(1)
      al.Add(CsvDataSourceView.DefaultViewName)
      Return CType(al, ICollection)
   End Function 'GetViewNames

End Class 'CsvDataSource


' The CsvDataSourceView class encapsulates the
' capabilities of the CsvDataSource data source control.

Public Class CsvDataSourceView
   Inherits DataSourceView

   Public Sub New(owner
 As IDataSource, name As String)
       MyBase.New(owner, DefaultViewName)
   End Sub 'New

   ' The data source view is named. However, the CsvDataSource
   ' only supports one view, so the name is ignored, and the
   ' default name used instead.
   Public Shared DefaultViewName As
 String = "CommaSeparatedView"

   ' The location of the .csv file.
   Private aSourceFile As String
 = [String].Empty

   Friend Property SourceFile() As
 String
      Get
         Return aSourceFile
      End Get
      Set
         ' Use MapPath when the SourceFile is set, so that files local
 to the
         ' current directory can be easily used.
         Dim mappedFileName As String
         mappedFileName = HttpContext.Current.Server.MapPath(value)
         aSourceFile = mappedFileName
      End Set
   End Property

   ' Do not add the column names as a data row. Infer columns if the
 CSV file does
   ' not include column names.
   Private columns As Boolean
 = False

   Friend Property IncludesColumnNames() As
 Boolean
      Get
         Return columns
      End Get
      Set
         columns = value
      End Set
   End Property

   ' Get data from the underlying data source.
   ' Build and return a DataView, regardless of mode.
   Protected Overrides Function
 ExecuteSelect(selectArgs As DataSourceSelectArguments) _
    As System.Collections.IEnumerable
      Dim dataList As IEnumerable = Nothing
      ' Open the .csv file.
      If File.Exists(Me.SourceFile) Then
         Dim data As New
 DataTable()

         ' Open the file to read from.
         Dim sr As StreamReader = File.OpenText(Me.SourceFile)

         Try
            ' Parse the line
            Dim dataValues() As String
            Dim col As DataColumn

            ' Do the following to add schema.
            dataValues = sr.ReadLine().Split(","c)
            ' For each token in the comma-delimited string, add a column
            ' to the DataTable schema.
            Dim token As String
            For Each token In
 dataValues
               col = New DataColumn(token, System.Type.GetType("System.String"))
               data.Columns.Add(col)
            Next token

            ' Do not add the first row as data if the CSV file includes
 column names.
            If Not IncludesColumnNames Then
               data.Rows.Add(CopyRowData(dataValues, data.NewRow()))
            End If

            ' Do the following to add data.
            Dim s As String
            Do
               s = sr.ReadLine()
               If Not s Is
 Nothing Then
                   dataValues = s.Split(","c)
                   data.Rows.Add(CopyRowData(dataValues, data.NewRow()))
               End If
            Loop Until s Is
 Nothing

         Finally
            sr.Close()
         End Try

         data.AcceptChanges()
         Dim dataView As New
 DataView(data)
         If Not selectArgs.SortExpression Is
 String.Empty Then
             dataView.Sort = selectArgs.SortExpression
         End If
         dataList = dataView
      Else
         Throw New System.Configuration.ConfigurationErrorsException("File
 not found, " + Me.SourceFile)
      End If

      If dataList is Nothing
 Then
         Throw New InvalidOperationException("No
 data loaded from data source.")
      End If

      Return dataList
   End Function 'ExecuteSelect


   Private Function CopyRowData([source]()
 As String, target As DataRow)
 As DataRow
      Try
         Dim i As Integer
         For i = 0 To [source].Length - 1
            target(i) = [source](i)
         Next i
      Catch iore As IndexOutOfRangeException
         ' There are more columns in this row than
         ' the original schema allows.  Stop copying
         ' and return the DataRow.
         Return target
      End Try
      Return target
   End Function 'CopyRowData

   ' The CsvDataSourceView does not currently
   ' permit deletion. You can modify or extend
   ' this sample to do so.
   Public Overrides ReadOnly
 Property CanDelete() As Boolean
      Get
         Return False
      End Get
   End Property

   Protected Overrides Function
 ExecuteDelete(keys As IDictionary, values As
 IDictionary) As Integer
      Throw New NotSupportedException()
   End Function 'ExecuteDelete

   ' The CsvDataSourceView does not currently
   ' permit insertion of a new record. You can
   ' modify or extend this sample to do so.
   Public Overrides ReadOnly
 Property CanInsert() As Boolean
      Get
         Return False
      End Get
   End Property

   Protected Overrides Function
 ExecuteInsert(values As IDictionary) As Integer
      Throw New NotSupportedException()
   End Function 'ExecuteInsert

   ' The CsvDataSourceView does not currently
   ' permit update operations. You can modify or
   ' extend this sample to do so.
   Public Overrides ReadOnly
 Property CanUpdate() As Boolean
      Get
         Return False
      End Get
   End Property

   Protected Overrides Function
 ExecuteUpdate(keys As IDictionary, _
                                              values As IDictionary,
 _
                                              oldValues As IDictionary)
 As Integer
      Throw New NotSupportedException()
   End Function 'ExecuteUpdate

End Class 'CsvDataSourceView
End Namespace

C#

using System;
using System.Collections;
using System.Data;
using System.IO;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

// The CsvDataSource is a data source control that retrieves its
// data from a comma-separated value file.
[AspNetHostingPermission(SecurityAction.Demand, Level=AspNetHostingPermissionLevel.Minimal)]
public class CsvDataSource : DataSourceControl
{
    public CsvDataSource() : base() {}

    // The comma-separated value file to retrieve data from.
    public string FileName {
        get {
            return ((CsvDataSourceView)this.GetView(String.Empty)).SourceFile;
        }
        set {
            // Only set if it is different.
            if ( ((CsvDataSourceView)this.GetView(String.Empty)).SourceFile
 != value) {
                ((CsvDataSourceView)this.GetView(String.Empty)).SourceFile
 = value;
                RaiseDataSourceChangedEvent(EventArgs.Empty);
            }
        }
    }

    // Do not add the column names as a data row. Infer columns if the
 CSV file does
    // not include column names.
    public bool IncludesColumnNames {
        get {
            return ((CsvDataSourceView)this.GetView(String.Empty)).IncludesColumnNames;
        }
        set {
            // Only set if it is different.
            if ( ((CsvDataSourceView)this.GetView(String.Empty)).IncludesColumnNames
 != value) {
                ((CsvDataSourceView)this.GetView(String.Empty)).IncludesColumnNames
 = value;
                RaiseDataSourceChangedEvent(EventArgs.Empty);
            }
        }
    }

    // Return a strongly typed view for the current data source control.
    private CsvDataSourceView view = null;
    protected override DataSourceView GetView(string
 viewName) {
        if (null == view) {
            view = new CsvDataSourceView(this,
 String.Empty);
        }
        return view;
    }
    // The ListSourceHelper class calls GetList, which
    // calls the DataSourceControl.GetViewNames method.
    // Override the original implementation to return
    // a collection of one element, the default view name.
    protected override ICollection GetViewNames() {
        ArrayList al = new ArrayList(1);
        al.Add(CsvDataSourceView.DefaultViewName);
        return al as ICollection;
    }
}

// The CsvDataSourceView class encapsulates the
// capabilities of the CsvDataSource data source control.
public class CsvDataSourceView : DataSourceView
{

    public CsvDataSourceView(IDataSource owner, string
 name) :base(owner, DefaultViewName) {

    }

    // The data source view is named. However, the CsvDataSource
    // only supports one view, so the name is ignored, and the
    // default name used instead.
    public static string
 DefaultViewName = "CommaSeparatedView";

    // The location of the .csv file.
    private string sourceFile = String.Empty;
    internal string SourceFile {
        get {
            return sourceFile;
        }
        set {
            // Use MapPath when the SourceFile is set, so that files
 local to the
            // current directory can be easily used.
            string mappedFileName = HttpContext.Current.Server.MapPath(value);
            sourceFile = mappedFileName;
        }
    }

    // Do not add the column names as a data row. Infer columns if the
 CSV file does
    // not include column names.
    private bool columns = false;
    internal bool IncludesColumnNames {
        get {
            return columns;
        }
        set {
            columns = value;
        }
    }

    // Get data from the underlying data source.
    // Build and return a DataView, regardless of mode.
    protected override IEnumerable ExecuteSelect(DataSourceSelectArguments
 selectArgs) {
        IEnumerable dataList = null;
        // Open the .csv file.
        if (File.Exists(this.SourceFile)) {
            DataTable data = new DataTable();

            // Open the file to read from.
            using (StreamReader sr = File.OpenText(this.SourceFile))
 {
                // Parse the line
                string s = "";
                string[] dataValues;
                DataColumn col;

                // Do the following to add schema.
                dataValues = sr.ReadLine().Split(',');
                // For each token in the comma-delimited string, add
 a column
                // to the DataTable schema.
                foreach (string token in
 dataValues) {
                    col = new DataColumn(token,typeof(string));
                    data.Columns.Add(col);
                }

                // Do not add the first row as data if the CSV file
 includes column names.
                if (! IncludesColumnNames)
                    data.Rows.Add(CopyRowData(dataValues, data.NewRow()));

                // Do the following to add data.
                while ((s = sr.ReadLine()) != null)
 {
                    dataValues = s.Split(',');
                    data.Rows.Add(CopyRowData(dataValues, data.NewRow()));
                }
            }
            data.AcceptChanges();
            DataView dataView = new DataView(data);
            if (selectArgs.SortExpression != String.Empty) {
                dataView.Sort = selectArgs.SortExpression;
            }
            dataList = dataView;
        }
        else {
            throw new System.Configuration.ConfigurationErrorsException("File
 not found, " + this.SourceFile);
        }

        if (null == dataList) {
            throw new InvalidOperationException("No data
 loaded from data source.");
        }

        return dataList;
    }

    private DataRow CopyRowData(string[] source,
 DataRow target) {
        try {
            for (int i = 0;i < source.Length;i++)
 {
                target[i] = source[i];
            }
        }
        catch (System.IndexOutOfRangeException) {
            // There are more columns in this row than
            // the original schema allows.  Stop copying
            // and return the DataRow.
            return target;
        }
        return target;
    }
    // The CsvDataSourceView does not currently
    // permit deletion. You can modify or extend
    // this sample to do so.
    public override bool CanDelete {
        get {
            return false;
        }
    }
    protected override int ExecuteDelete(IDictionary
 keys, IDictionary values)
    {
        throw new NotSupportedException();
    }
    // The CsvDataSourceView does not currently
    // permit insertion of a new record. You can
    // modify or extend this sample to do so.
    public override bool CanInsert {
        get {
            return false;
        }
    }
    protected override int ExecuteInsert(IDictionary
 values)
    {
        throw new NotSupportedException();
    }
    // The CsvDataSourceView does not currently
    // permit update operations. You can modify or
    // extend this sample to do so.
    public override bool CanUpdate {
        get {
            return false;
        }
    }
    protected override int ExecuteUpdate(IDictionary
 keys, IDictionary values, IDictionary oldValues)
    {
        throw new NotSupportedException();
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
IDataSource メンバ
System.Web.UI 名前空間
IDataSource インターフェイス
DataSourceView クラス
HierarchicalDataSourceControl クラス
その他の技術情報
ASP.NET データ アクセスの概要
データ ソース コントロールの概要

IDataSource メソッド

パブリック メソッド

	名前	説明
	GetView	データ ソース コントロールに関連付けられた名前付きデータ ソース ビューを取得します。
	GetViewNames	IDataSource インターフェイスに関連付けられたビュー オブジェクトのリストを表す名前のコレクションを取得します。

参照

関連項目

IDataSource インターフェイス
System.Web.UI 名前空間
IDataSource インターフェイス
DataSourceView クラス
HierarchicalDataSourceControl クラス

その他の技術情報

ASP.NET データ アクセスの概要
データ ソース コントロールの概要

IDataSource メンバ

データ バインド コントロールをバインドする抽象データ ソースを表します。

IDataSource データ型で公開されるメンバを以下の表に示します。

パブリック メソッド

	名前	説明
	GetView	データ ソース コントロールに関連付けられた名前付きデータ ソース ビューを取得します。
	GetViewNames	IDataSource インターフェイスに関連付けられたビュー オブジェクトのリストを表す名前のコレクションを取得します。

パブリック イベント

	名前	説明
	DataSourceChanged	データ バインド コントロールに影響を与える変更がデータ ソース コントロールに加えられたときに発生します。

参照

関連項目

IDataSource インターフェイス
System.Web.UI 名前空間
IDataSource インターフェイス
DataSourceView クラス
HierarchicalDataSourceControl クラス

その他の技術情報

ASP.NET データ アクセスの概要
データ ソース コントロールの概要