mcs/class/System.Data/System.Data.Common/DataColumnMapping.cs

   1 //
   2 // System.Data.Common.DataColumnMapping.cs
   3 //
   4 // Authors:
   5 //   Rodrigo Moya (rodrigo@ximian.com)
   6 //   Tim Coleman (tim@timcoleman.com)
   7 //
   8 // (C) Ximian, Inc
   9 // Copyright (C) Tim Coleman, 2002-2003
  10 //
  11
  12 //
  13 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  14 //
  15 // Permission is hereby granted, free of charge, to any person obtaining
  16 // a copy of this software and associated documentation files (the
  17 // "Software"), to deal in the Software without restriction, including
  18 // without limitation the rights to use, copy, modify, merge, publish,
  19 // distribute, sublicense, and/or sell copies of the Software, and to
  20 // permit persons to whom the Software is furnished to do so, subject to
  21 // the following conditions:
  22 //
  23 // The above copyright notice and this permission notice shall be
  24 // included in all copies or substantial portions of the Software.
  25 //
  26 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  27 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  29 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  30 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  31 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  32 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  33 //
  34
  35 using System.ComponentModel;
  36 using System.Data;
  37
  38 namespace System.Data.Common {
  39 #if NET_2_0
  40         [TypeConverterAttribute ("System.Data.Common.DataColumnMapping+DataColumnMappingConverter, " + Consts.AssemblySystem_Data)]
  41 #else
  42         [TypeConverterAttribute (typeof (DataColumnMappingConverter))]
  43 #endif
  44         public sealed class DataColumnMapping : MarshalByRefObject, IColumnMapping, ICloneable
  45         {
  46                 #region Fields
  47
  48                 string sourceColumn;
  49                 string dataSetColumn;
  50
  51                 #endregion // Fields
  52
  53                 #region Constructors
  54
  55                 public DataColumnMapping ()
  56                 {
  57                         sourceColumn = String.Empty;
  58                         dataSetColumn = String.Empty;
  59                 }
  60
  61                 public DataColumnMapping (string sourceColumn, string dataSetColumn)
  62                 {
  63                         this.sourceColumn = sourceColumn;
  64                         this.dataSetColumn = dataSetColumn;
  65                 }
  66
  67                 #endregion // Constructors
  68
  69                 #region Properties
  70
  71 #if ONLY_1_1
  72                 [DataSysDescription ("DataColumn.ColumnName")]
  73 #endif
  74                 [DefaultValue ("")]
  75                 public string DataSetColumn {
  76                         get { return dataSetColumn; }
  77                         set { dataSetColumn = value; }
  78                 }
  79
  80 #if !NET_2_0
  81                 [DataSysDescription ("Source column name - case sensitive.")]
  82 #endif
  83                 [DefaultValue ("")]
  84                 public string SourceColumn {
  85                         get { return sourceColumn; }
  86                         set { sourceColumn = value; }
  87                 }
  88
  89                 #endregion // Properties
  90
  91                 #region Methods
  92
  93                 [EditorBrowsable (EditorBrowsableState.Advanced)]
  94                 public DataColumn GetDataColumnBySchemaAction (DataTable dataTable, Type dataType, MissingSchemaAction schemaAction)
  95                 {
  96                         if (dataTable.Columns.Contains (dataSetColumn))
  97                                 return dataTable.Columns [dataSetColumn];
  98                         if (schemaAction == MissingSchemaAction.Ignore)
  99                                 return null;
 100                         if (schemaAction == MissingSchemaAction.Error)
 101                                 throw new InvalidOperationException (String.Format ("Missing the DataColumn '{0}' in the DataTable '{1}' for the SourceColumn '{2}'", DataSetColumn, dataTable.TableName, SourceColumn));
 102                         return new DataColumn (dataSetColumn, dataType);
 103                 }
 104
 105 #if NET_2_0
 106                 [EditorBrowsable (EditorBrowsableState.Advanced)]
 107                 public static DataColumn GetDataColumnBySchemaAction (string sourceColumn, string dataSetColumn, DataTable dataTable, Type dataType, MissingSchemaAction schemaAction)
 108                 {
 109                         if (dataTable.Columns.Contains (dataSetColumn))
 110                                 return dataTable.Columns [dataSetColumn];
 111                         if (schemaAction == MissingSchemaAction.Ignore)
 112                                 return null;
 113                         if (schemaAction == MissingSchemaAction.Error)
 114                                 throw new InvalidOperationException (String.Format ("Missing the DataColumn '{0}' in the DataTable '{1}' for the SourceColumn '{2}'", dataSetColumn, dataTable.TableName, sourceColumn));
 115                         return new DataColumn (dataSetColumn, dataType);
 116                 }
 117 #endif
 118
 119                 object ICloneable.Clone ()
 120                 {
 121                         return new DataColumnMapping (SourceColumn, DataSetColumn);
 122                 }
 123
 124                 public override string ToString ()
 125                 {
 126                         return SourceColumn;
 127                 }
 128
 129                 #endregion // Methods
 130         }
 131 }