src/Apache.IoTDB.Data/IoTDBParameter.cs

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.
 */

using System;
using System.Data;
using System.Data.Common;

namespace Apache.IoTDB.Data
{
    // TODO: Truncate to specified size
    // TODO: Infer type and size from value
    /// <summary>
    ///     Represents a parameter and its value in a <see cref="IoTDBCommand" />.
    /// </summary>
    /// <remarks>Due to IoTDB's dynamic type system, parameter values are not converted.</remarks>
    public class IoTDBParameter : DbParameter
    {
        private string _parameterName = string.Empty;
        private object _value;
        private int? _size;
        private TSDataType? _IoTDBType;

        /// <summary>
        ///     Initializes a new instance of the <see cref="IoTDBParameter" /> class.
        /// </summary>
        public IoTDBParameter()
        {
        }

        /// <summary>
        ///     Initializes a new instance of the <see cref="IoTDBParameter" /> class.
        /// </summary>
        /// <param name="name">The name of the parameter.</param>
        /// <param name="value">The value of the parameter. Can be null.</param>
        public IoTDBParameter(string name, object value)
        {
            if (string.IsNullOrEmpty(name))
            {
                throw new ArgumentNullException(nameof(name));
            }

            _parameterName = name;
            Value = value;
        }

        /// <summary>
        ///     Initializes a new instance of the <see cref="IoTDBParameter" /> class.
        /// </summary>
        /// <param name="name">The name of the parameter.</param>
        /// <param name="type">The type of the parameter.</param>
        public IoTDBParameter(string name, TSDataType type)
        {
            if (string.IsNullOrEmpty(name))
            {
                throw new ArgumentNullException(nameof(name));
            }

            _parameterName = name;
            IoTDBType = type;
        }

        /// <summary>
        ///     Initializes a new instance of the <see cref="IoTDBParameter" /> class.
        /// </summary>
        /// <param name="name">The name of the parameter.</param>
        /// <param name="type">The type of the parameter.</param>
        /// <param name="size">The maximum size, in bytes, of the parameter.</param>
        public IoTDBParameter(string name, TSDataType type, int size)
            : this(name, type)
            => Size = size;

        /// <summary>
        ///     Initializes a new instance of the <see cref="IoTDBParameter" /> class.
        /// </summary>
        /// <param name="name">The name of the parameter.</param>
        /// <param name="type">The type of the parameter.</param>
        /// <param name="size">The maximum size, in bytes, of the parameter.</param>
        /// <param name="sourceColumn">The source column used for loading the value. Can be null.</param>
        public IoTDBParameter(string name, TSDataType type, int size, string sourceColumn)
            : this(name, type, size)
            => SourceColumn = sourceColumn;

        /// <summary>
        ///     Gets or sets the type of the parameter.
        /// </summary>
        /// <value>The type of the parameter.</value>
        /// <remarks>Due to IoTDB's dynamic type system, parameter values are not converted.</remarks>

        public override DbType DbType { get; set; } = DbType.String;

        /// <summary>
        ///     Gets or sets the IoTDB type of the parameter.
        /// </summary>
        /// <value>The IoTDB type of the parameter.</value>
        /// <remarks>Due to IoTDB's dynamic type system, parameter values are not converted.</remarks>

        public virtual TSDataType IoTDBType
        {
            get => _IoTDBType.GetValueOrDefault();//?? IoTDBValueBinder.GetIoTDBType(_value);
            set => _IoTDBType = value;
        }

        /// <summary>
        ///     Gets or sets the direction of the parameter. Only <see cref="ParameterDirection.Input" /> is supported.
        /// </summary>
        /// <value>The direction of the parameter.</value>
        public override ParameterDirection Direction
        {
            get => ParameterDirection.Input;
            set
            {
                if (value != ParameterDirection.Input)
                {
                    throw new ArgumentException($"InvalidParameterDirection{value}");
                }
            }
        }

        /// <summary>
        ///     Gets or sets a value indicating whether the parameter is nullable.
        /// </summary>
        /// <value>A value indicating whether the parameter is nullable.</value>
        public override bool IsNullable { get; set; }

        /// <summary>
        ///     Gets or sets the name of the parameter.
        /// </summary>
        /// <value>The name of the parameter.</value>
        public override string ParameterName
        {
            get => _parameterName;
            set
            {
                if (string.IsNullOrEmpty(value))
                {
                    throw new ArgumentNullException(nameof(value));
                }

                _parameterName = value;
            }
        }

        /// <summary>
        ///     Gets or sets the maximum size, in bytes, of the parameter.
        /// </summary>
        /// <value>The maximum size, in bytes, of the parameter.</value>
        public override int Size
        {
            get => _size
                ?? (_value is string stringValue
                    ? stringValue.Length
                    : _value is byte[] byteArray
                        ? byteArray.Length
                        : 0);

            set
            {
                if (value < -1)
                {
                    // NB: Message is provided by the framework
                    throw new ArgumentOutOfRangeException(nameof(value), value, message: null);
                }

                _size = value;
            }
        }

        /// <summary>
        ///     Gets or sets the source column used for loading the value.
        /// </summary>
        /// <value>The source column used for loading the value.</value>
        public override string SourceColumn { get; set; } = string.Empty;

        /// <summary>
        ///     Gets or sets a value indicating whether the source column is nullable.
        /// </summary>
        /// <value>A value indicating whether the source column is nullable.</value>
        public override bool SourceColumnNullMapping { get; set; }

        /// <summary>
        ///     Gets or sets the value of the parameter.
        /// </summary>
        /// <value>The value of the parameter.</value>
        /// <remarks>Due to IoTDB's dynamic type system, parameter values are not converted.</remarks>
        public override object Value
        {
            get => _value;
            set { _value = value; }
        }
#if NET45
        public override DataRowVersion SourceVersion { get; set; }
#endif
        /// <summary>
        ///     Resets the <see cref="DbType" /> property to its original value.
        /// </summary>
        public override void ResetDbType()
            => ResetIoTDBType();

        /// <summary>
        ///     Resets the <see cref="IoTDBType" /> property to its original value.
        /// </summary>
        public virtual void ResetIoTDBType()
        {
            DbType = DbType.String;
            IoTDBType = TSDataType.NONE;
        }


    }
}