2 // System.Data.Common.DataColumnMapping.cs
5 // Rodrigo Moya (rodrigo@ximian.com)
6 // Tim Coleman (tim@timcoleman.com)
9 // Copyright (C) Tim Coleman, 2002-2003
13 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
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:
23 // The above copyright notice and this permission notice shall be
24 // included in all copies or substantial portions of the Software.
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.
35 using System.ComponentModel;
38 namespace System.Data.Common {
40 [TypeConverterAttribute ("System.Data.Common.DataColumnMapping+DataColumnMappingConverter, " + Consts.AssemblySystem_Data)]
42 [TypeConverterAttribute (typeof (DataColumnMappingConverter))]
44 public sealed class DataColumnMapping : MarshalByRefObject, IColumnMapping, ICloneable
55 public DataColumnMapping ()
57 sourceColumn = String.Empty;
58 dataSetColumn = String.Empty;
61 public DataColumnMapping (string sourceColumn, string dataSetColumn)
63 this.sourceColumn = sourceColumn;
64 this.dataSetColumn = dataSetColumn;
67 #endregion // Constructors
72 [DataSysDescription ("DataColumn.ColumnName")]
75 public string DataSetColumn {
76 get { return dataSetColumn; }
77 set { dataSetColumn = value; }
81 [DataSysDescription ("Source column name - case sensitive.")]
84 public string SourceColumn {
85 get { return sourceColumn; }
86 set { sourceColumn = value; }
89 #endregion // Properties
93 [EditorBrowsable (EditorBrowsableState.Advanced)]
94 public DataColumn GetDataColumnBySchemaAction (DataTable dataTable, Type dataType, MissingSchemaAction schemaAction)
96 if (dataTable.Columns.Contains (dataSetColumn))
97 return dataTable.Columns [dataSetColumn];
98 if (schemaAction == MissingSchemaAction.Ignore)
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);
106 [EditorBrowsable (EditorBrowsableState.Advanced)]
107 public static DataColumn GetDataColumnBySchemaAction (string sourceColumn, string dataSetColumn, DataTable dataTable, Type dataType, MissingSchemaAction schemaAction)
109 if (dataTable.Columns.Contains (dataSetColumn))
110 return dataTable.Columns [dataSetColumn];
111 if (schemaAction == MissingSchemaAction.Ignore)
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);
119 object ICloneable.Clone ()
121 return new DataColumnMapping (SourceColumn, DataSetColumn);
124 public override string ToString ()
129 #endregion // Methods