mcs/class/System.Data/System.Data.OleDb/OleDbParameter.cs

   1 //
   2 // System.Data.OleDb.OleDbParameter
   3 //
   4 // Authors:
   5 //   Rodrigo Moya (rodrigo@ximian.com)
   6 //   Tim Coleman (tim@timcoleman.com)
   7 //
   8 // Copyright (C) Rodrigo Moya, 2002
   9 // Copyright (C) Tim Coleman, 2002
  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;
  36 using System.Data;
  37 using System.Data.Common;
  38 using System.ComponentModel;
  39
  40 namespace System.Data.OleDb
  41 {
  42         [TypeConverterAttribute (typeof (OleDbParameterConverter))]
  43         public sealed class OleDbParameter : MarshalByRefObject, IDbDataParameter, IDataParameter, ICloneable
  44         {
  45                 #region Fields
  46
  47                 string name;
  48                 object value;
  49                 int size;
  50                 bool isNullable;
  51                 byte precision;
  52                 byte scale;
  53                 DataRowVersion sourceVersion;
  54                 string sourceColumn;
  55                 ParameterDirection direction;
  56                 OleDbType oleDbType;
  57                 DbType dbType;
  58                 OleDbParameterCollection container = null;
  59
  60                 IntPtr gdaParameter;
  61
  62                 #endregion
  63
  64                 #region Constructors
  65
  66                 public OleDbParameter ()
  67                 {
  68                         name = String.Empty;
  69                         value = null;
  70                         size = 0;
  71                         isNullable = true;
  72                         precision = 0;
  73                         scale = 0;
  74                         sourceColumn = String.Empty;
  75                         gdaParameter = IntPtr.Zero;
  76                 }
  77
  78                 public OleDbParameter (string name, object value)
  79                         : this ()
  80                 {
  81                         this.name = name;
  82                         this.value = value;
  83                         OleDbType = GetOleDbType (value);
  84                 }
  85
  86                 public OleDbParameter (string name, OleDbType dataType)
  87                         : this ()
  88                 {
  89                         this.name = name;
  90                         OleDbType = dataType;
  91                 }
  92
  93                 public OleDbParameter (string name, OleDbType dataType, int size)
  94                         : this (name, dataType)
  95                 {
  96                         this.size = size;
  97                 }
  98
  99                 public OleDbParameter (string name, OleDbType dataType, int size, string srcColumn)
 100                         : this (name, dataType, size)
 101                 {
 102                         this.sourceColumn = srcColumn;
 103                 }
 104
 105                 [EditorBrowsableAttribute (EditorBrowsableState.Advanced)]
 106                 public OleDbParameter(string name, OleDbType dataType, int size, ParameterDirection direction, bool isNullable, byte precision, byte scale, string srcColumn, DataRowVersion srcVersion, object value)
 107                         : this (name, dataType, size, srcColumn)
 108                 {
 109                         this.direction = direction;
 110                         this.isNullable = isNullable;
 111                         this.precision = precision;
 112                         this.scale = scale;
 113                         this.sourceVersion = srcVersion;
 114                         this.value = value;
 115                 }
 116
 117                 #endregion
 118
 119                 #region Properties
 120
 121                 [BrowsableAttribute (false)]
 122                 [DataSysDescriptionAttribute ("The parameter generic type")]
 123                 [RefreshPropertiesAttribute (RefreshProperties.All)]
 124                 [DesignerSerializationVisibilityAttribute (DesignerSerializationVisibility.Hidden)]
 125                 [DataCategory ("DataCategory_Data")]
 126                 public DbType DbType {
 127                         get { return dbType; }
 128                         set {
 129                                 dbType = value;
 130                                 oleDbType = DbTypeToOleDbType (value);
 131                         }
 132                 }
 133
 134                 [DataSysDescriptionAttribute ("Input, output, or bidirectional parameter")]                         [DefaultValue (ParameterDirection.Input)]
 135                 [DataCategory ("DataCategory_Data")]
 136                 public ParameterDirection Direction {
 137                         get { return direction; }
 138                         set { direction = value; }
 139                 }
 140
 141                 [BrowsableAttribute (false)]
 142                 [DataSysDescriptionAttribute ("A design-time property used for strongly typed code generation")]
 143                 [DesignOnlyAttribute (true)]
 144                 [EditorBrowsableAttribute (EditorBrowsableState.Advanced)]
 145                 [DefaultValue (false)]
 146                 public bool IsNullable {
 147                         get { return isNullable; }
 148                         set { isNullable = value; }
 149                 }
 150
 151                 [DefaultValue (OleDbType.VarWChar)]
 152                 [DataSysDescriptionAttribute ("The parameter native type")]
 153                 [RefreshPropertiesAttribute (RefreshProperties.All)]
 154                 [DataCategory ("DataCategory_Data")]
 155                 public OleDbType OleDbType {
 156                         get { return oleDbType; }
 157                         set {
 158                                 oleDbType = value;
 159                                 dbType = OleDbTypeToDbType (value);
 160                         }
 161                 }
 162
 163                 [DefaultValue ("")]
 164                 [DataSysDescriptionAttribute ("Name of the parameter")]
 165                 public string ParameterName {
 166                         get { return name; }
 167                         set { name = value; }
 168                 }
 169
 170                 [DefaultValue (0)]
 171                 [DataSysDescriptionAttribute ("For decimal, numeric, varnumeric DBTypes")]
 172                 [DataCategory ("DataCategory_Data")]
 173                 public byte Precision {
 174                         get { return precision; }
 175                         set { precision = value; }
 176                 }
 177
 178                 [DefaultValue (0)]
 179                 [DataSysDescriptionAttribute ("For decimal, numeric, varnumeric DBTypes")]
 180                 [DataCategory ("DataCategory_Data")]
 181                 public byte Scale {
 182                         get { return scale; }
 183                         set { scale = value; }
 184                 }
 185
 186
 187                 [DefaultValue (0)]
 188                 [DataSysDescriptionAttribute ("Size of variable length data types (string & arrays)")]
 189                 [DataCategory ("DataCategory_Data")]
 190                 public int Size {
 191                         get { return size; }
 192                         set { size = value; }
 193                 }
 194
 195                 [DefaultValue ("")]
 196                 [DataSysDescriptionAttribute ("When used by a DataAdapter.Update, the source column name that is used to find the DataSetColumn name in the ColumnMappings. This is to copy a value between the parameter and a datarow")]
 197                 [DataCategory ("DataCategory_Data")]
 198                 public string SourceColumn {
 199                         get { return sourceColumn; }
 200                         set { sourceColumn = value; }
 201                 }
 202
 203                 [DefaultValue (DataRowVersion.Current)]
 204                 [DataSysDescriptionAttribute ("When used by a DataAdapter.Update(UpdateCommand only), the version of the DataRow value that is used to update the data source")]
 205                 [DataCategory ("DataCategory_Data")]
 206                 public DataRowVersion SourceVersion {
 207                         get { return sourceVersion; }
 208                         set { sourceVersion = value; }
 209                 }
 210
 211                 [DefaultValue (null)]
 212                 [DataSysDescriptionAttribute ("value of the parameter")]
 213                 [TypeConverter (typeof (StringConverter))]
 214                 [DataCategory ("DataCategory_Data")]
 215                 public object Value {
 216                         get { return value; }
 217                         set { this.value = value; }
 218                 }
 219
 220                 // Used to ensure that only one collection can contain this
 221                 // parameter
 222                 internal OleDbParameterCollection Container {
 223                         get { return container; }
 224                         set { container = value; }
 225                 }
 226
 227
 228                 #endregion // Properties
 229
 230                 #region Internal Properties
 231
 232                 internal IntPtr GdaParameter {
 233                         get { return gdaParameter; }
 234                 }
 235
 236                 #endregion // Internal Properties
 237
 238                 #region Methods
 239
 240                 [MonoTODO]
 241                 object ICloneable.Clone ()
 242                 {
 243                         throw new NotImplementedException ();
 244                 }
 245
 246                 public override string ToString ()
 247                 {
 248                         return ParameterName;
 249                 }
 250
 251                 private OleDbType DbTypeToOleDbType (DbType dbType)
 252                 {
 253                         switch (dbType) {
 254                         case DbType.AnsiString :
 255                                 return OleDbType.VarChar;
 256                         case DbType.AnsiStringFixedLength :
 257                                 return OleDbType.Char;
 258                         case DbType.Binary :
 259                                 return OleDbType.Binary;
 260                         case DbType.Boolean :
 261                                 return OleDbType.Boolean;
 262                         case DbType.Byte :
 263                                 return OleDbType.UnsignedTinyInt;
 264                         case DbType.Currency :
 265                                 return OleDbType.Currency;
 266                         case DbType.Date :
 267                                 return OleDbType.Date;
 268                         case DbType.DateTime :
 269                                 throw new NotImplementedException ();
 270                         case DbType.Decimal :
 271                                 return OleDbType.Decimal;
 272                         case DbType.Double :
 273                                 return OleDbType.Double;
 274                         case DbType.Guid :
 275                                 return OleDbType.Guid;
 276                         case DbType.Int16 :
 277                                 return OleDbType.SmallInt;
 278                         case DbType.Int32 :
 279                                 return OleDbType.Integer;
 280                         case DbType.Int64 :
 281                                 return OleDbType.BigInt;
 282                         case DbType.Object :
 283                                 return OleDbType.Variant;
 284                         case DbType.SByte :
 285                                 return OleDbType.TinyInt;
 286                         case DbType.Single :
 287                                 return OleDbType.Single;
 288                         case DbType.String :
 289                                 return OleDbType.WChar;
 290                         case DbType.StringFixedLength :
 291                                 return OleDbType.VarWChar;
 292                         case DbType.Time :
 293                                 throw new NotImplementedException ();
 294                         case DbType.UInt16 :
 295                                 return OleDbType.UnsignedSmallInt;
 296                         case DbType.UInt32 :
 297                                 return OleDbType.UnsignedInt;
 298                         case DbType.UInt64 :
 299                                 return OleDbType.UnsignedBigInt;
 300                         case DbType.VarNumeric :
 301                                 return OleDbType.VarNumeric;
 302                         }
 303                         return OleDbType.Variant;
 304                 }
 305
 306                 private DbType OleDbTypeToDbType (OleDbType oleDbType)
 307                 {
 308                         switch (oleDbType) {
 309                         case OleDbType.BigInt :
 310                                 return DbType.Int64;
 311                         case OleDbType.Binary :
 312                                 return DbType.Binary;
 313                         case OleDbType.Boolean :
 314                                 return DbType.Boolean;
 315                         case OleDbType.BSTR :
 316                                 return DbType.AnsiString;
 317                         case OleDbType.Char :
 318                                 return DbType.AnsiStringFixedLength;
 319                         case OleDbType.Currency :
 320                                 return DbType.Currency;
 321                         case OleDbType.Date :
 322                                 return DbType.DateTime;
 323                         case OleDbType.DBDate :
 324                                 return DbType.DateTime;
 325                         case OleDbType.DBTime :
 326                                 throw new NotImplementedException ();
 327                         case OleDbType.DBTimeStamp :
 328                                 return DbType.DateTime;
 329                         case OleDbType.Decimal :
 330                                 return DbType.Decimal;
 331                         case OleDbType.Double :
 332                                 return DbType.Double;
 333                         case OleDbType.Empty :
 334                                 throw new NotImplementedException ();
 335                         case OleDbType.Error :
 336                                 throw new NotImplementedException ();
 337                         case OleDbType.Filetime :
 338                                 return DbType.DateTime;
 339                         case OleDbType.Guid :
 340                                 return DbType.Guid;
 341                         case OleDbType.IDispatch :
 342                                 return DbType.Object;
 343                         case OleDbType.Integer :
 344                                 return DbType.Int32;
 345                         case OleDbType.IUnknown :
 346                                 return DbType.Object;
 347                         case OleDbType.LongVarBinary :
 348                                 return DbType.Binary;
 349                         case OleDbType.LongVarChar :
 350                                 return DbType.AnsiString;
 351                         case OleDbType.LongVarWChar :
 352                                 return DbType.String;
 353                         case OleDbType.Numeric :
 354                                 return DbType.Decimal;
 355                         case OleDbType.PropVariant :
 356                                 return DbType.Object;
 357                         case OleDbType.Single :
 358                                 return DbType.Single;
 359                         case OleDbType.SmallInt :
 360                                 return DbType.Int16;
 361                         case OleDbType.TinyInt :
 362                                 return DbType.SByte;
 363                         case OleDbType.UnsignedBigInt :
 364                                 return DbType.UInt64;
 365                         case OleDbType.UnsignedInt :
 366                                 return DbType.UInt32;
 367                         case OleDbType.UnsignedSmallInt :
 368                                 return DbType.UInt16;
 369                         case OleDbType.UnsignedTinyInt :
 370                                 return DbType.Byte;
 371                         case OleDbType.VarBinary :
 372                                 return DbType.Binary;
 373                         case OleDbType.VarChar :
 374                                 return DbType.AnsiString;
 375                         case OleDbType.Variant :
 376                                 return DbType.Object;
 377                         case OleDbType.VarNumeric :
 378                                 return DbType.VarNumeric;
 379                         case OleDbType.VarWChar :
 380                                 return DbType.StringFixedLength;
 381                         case OleDbType.WChar :
 382                                 return DbType.String;
 383                         }
 384                         return DbType.Object;
 385                 }
 386
 387                 private OleDbType GetOleDbType (object value)
 388                 {
 389                         if (value is Guid) return OleDbType.Guid;
 390                         if (value is TimeSpan) return OleDbType.DBTime;
 391
 392                         switch (Type.GetTypeCode (value.GetType ())) {
 393                         case TypeCode.Boolean :
 394                                 return OleDbType.Boolean;
 395                         case TypeCode.Byte :
 396                                 if (value.GetType().IsArray)
 397                                         return OleDbType.Binary;
 398                                 else
 399                                         return OleDbType.UnsignedTinyInt;
 400                         case TypeCode.Char :
 401                                 return OleDbType.Char;
 402                         case TypeCode.DateTime :
 403                                 return OleDbType.Date;
 404                         case TypeCode.DBNull :
 405                                 return OleDbType.Empty;
 406                         case TypeCode.Decimal :
 407                                 return OleDbType.Decimal;
 408                         case TypeCode.Double :
 409                                 return OleDbType.Double;
 410                         case TypeCode.Empty :
 411                                 return OleDbType.Empty;
 412                         case TypeCode.Int16 :
 413                                 return OleDbType.SmallInt;
 414                         case TypeCode.Int32 :
 415                                 return OleDbType.Integer;
 416                         case TypeCode.Int64 :
 417                                 return OleDbType.BigInt;
 418                         case TypeCode.SByte :
 419                                 return OleDbType.TinyInt;
 420                         case TypeCode.String :
 421                                 return OleDbType.VarChar;
 422                         case TypeCode.Single :
 423                                 return OleDbType.Single;
 424                         case TypeCode.UInt64 :
 425                                 return OleDbType.UnsignedBigInt;
 426                         case TypeCode.UInt32 :
 427                                 return OleDbType.UnsignedInt;
 428                         case TypeCode.UInt16 :
 429                                 return OleDbType.UnsignedSmallInt;
 430                         case TypeCode.Object :
 431                                 return OleDbType.Variant;
 432                         }
 433                         return OleDbType.IUnknown;
 434                 }
 435
 436                 #endregion
 437         }
 438 }