Column.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Linq;

namespace kinetica.Records;

    public sealed class Column
    {
        private readonly string _name;
        private readonly ColumnType _columnType;
        private readonly IReadOnlyList<string> _properties;
        private readonly bool _isNullable;
        private readonly bool _isPrimaryKey;
        private readonly bool _isShardKey;

        public Column(string name, ColumnType columnType)
            : this(name, columnType, Array.Empty<string>())
        {
        }

        public Column(string name, ColumnType columnType, IEnumerable<string> properties)
        {
            _name = name ?? throw new ArgumentNullException(nameof(name));
            _columnType = columnType;
            _properties = properties?.ToList().AsReadOnly() ?? (IReadOnlyList<string>)Array.Empty<string>();
            _isNullable = _properties.Any(p => string.Equals(p, "nullable", StringComparison.OrdinalIgnoreCase));
            _isPrimaryKey = _properties.Any(p => string.Equals(p, "primary_key", StringComparison.OrdinalIgnoreCase));
            _isShardKey = _properties.Any(p => string.Equals(p, "shard_key", StringComparison.OrdinalIgnoreCase));
        }

        public static Column WithProperties(string name, ColumnType columnType, IEnumerable<string> properties)
            => new Column(name, columnType, properties);

        public string Name => _name;

        public ColumnType ColumnType => _columnType;

        public ColumnBaseType BaseType => _columnType.GetBaseType();

        public IReadOnlyList<string> Properties => _properties;

        public bool IsNullable => _isNullable;

        public bool IsPrimaryKey => _isPrimaryKey;

        public bool IsShardKey => _isShardKey;

        public string AvroTypeName => _columnType.GetAvroTypeName();

        public Column WithAddedProperties(params string[] additionalProperties)
        {
            var newProps = _properties.Concat(additionalProperties).Distinct().ToList();
            return new Column(_name, _columnType, newProps);
        }

        public Column AsNullable()
        {
            if (_isNullable) return this;
            return WithAddedProperties("nullable");
        }

        public Column AsPrimaryKey()
        {
            if (_isPrimaryKey) return this;
            return WithAddedProperties("primary_key");
        }

        public Column AsShardKey()
        {
            if (_isShardKey) return this;
            return WithAddedProperties("shard_key");
        }

        public override string ToString()
        {
            var props = _properties.Count > 0 ? $" [{string.Join(", ", _properties)}]" : "";
            return $"{_name}: {_columnType}{props}";
        }

        public override bool Equals(object? obj)
        {
            if (obj is not Column other) return false;
            return _name == other._name &&
                   _columnType == other._columnType &&
                   _properties.SequenceEqual(other._properties);
        }

        public override int GetHashCode()
        {
            return HashCode.Combine(_name, _columnType);
        }
    }