DateTimeNode.cs

/*
// <copyright>
// dotNetRDF is free and open source software licensed under the MIT License
// -------------------------------------------------------------------------
// 
// Copyright (c) 2009-2023 dotNetRDF Project (http://dotnetrdf.org/)
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is furnished
// to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
*/

using System;
using System.Globalization;
using VDS.RDF.Parsing;
using VDS.RDF.Query;
using VDS.RDF.Query.Expressions;

namespace VDS.RDF.Nodes
{
    /// <summary>
    /// Valued Node representing a Date Time value.
    /// </summary>
    public class DateTimeNode
        : LiteralNode, IValuedNode
    {
        private DateTime _value;
        private DateTimeOffset? _offsetValue;

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="lexicalValue">Lexical Value.</param>
        /// <param name="datatype">Datatype URI.</param>
        /// <param name="normalizeLiteralValue">Whether to perform unicode normalization on <paramref name="lexicalValue"/>.</param>
        protected DateTimeNode(DateTimeOffset value, string lexicalValue, Uri datatype, bool normalizeLiteralValue = false)
            : base(lexicalValue, datatype, normalizeLiteralValue)
        {
            _value = value.UtcDateTime;
            _offsetValue = value;
        }

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="lexicalValue">Lexical Value.</param>
        /// <param name="datatype">Datatype URI.</param>
        /// <param name="normalizeLiteralValue">Whether to perform unicode normalization on <paramref name="lexicalValue"/>.</param>
        protected DateTimeNode(DateTime value, string lexicalValue, Uri datatype, bool normalizeLiteralValue = false)
            : base(lexicalValue, datatype, normalizeLiteralValue)
        {
            _value = value;
            _offsetValue = null;
        }

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="datatype">Datatype URI.</param>
        protected DateTimeNode(DateTimeOffset value, Uri datatype)
            : this(value, GetStringForm(value, datatype), datatype) { }

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="datatype">Datatype URI.</param>
        protected DateTimeNode(DateTime value, Uri datatype)
            : this(value, GetStringForm(value, datatype), datatype) { }

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        public DateTimeNode(DateTimeOffset value)
            : this(value, UriFactory.Root.Create(XmlSpecsHelper.XmlSchemaDataTypeDateTime)) { }

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        public DateTimeNode(DateTime value)
            : this(value, UriFactory.Root.Create(XmlSpecsHelper.XmlSchemaDataTypeDateTime)) { }

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="lexicalValue">Lexical Value.</param>
        /// <param name="normalizeLiteralValue">Whether to perform unicode normalization on <paramref name="lexicalValue"/>.</param>
        public DateTimeNode(DateTimeOffset value, string lexicalValue, bool normalizeLiteralValue = false)
            : this(value, lexicalValue, UriFactory.Root.Create(XmlSpecsHelper.XmlSchemaDataTypeDateTime), normalizeLiteralValue) { }

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="lexicalValue">Lexical Value.</param>
        /// <param name="normalizeLiteralValue">Whether to perform unicode normalization on <paramref name="lexicalValue"/>.</param>
        public DateTimeNode(DateTime value, string lexicalValue, bool normalizeLiteralValue = false)
            : this(value, lexicalValue, UriFactory.Root.Create(XmlSpecsHelper.XmlSchemaDataTypeDateTime), normalizeLiteralValue) { }

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="offsetValue">Date Time offset value.</param>
        /// <param name="lexicalValue">Lexical Value.</param>
        /// <param name="normalizeLiteralValue">Whether to perform unicode normalization on <paramref name="lexicalValue"/>.</param>
        public DateTimeNode(DateTime value, DateTimeOffset offsetValue, string lexicalValue, bool normalizeLiteralValue = false)
            : this(value, offsetValue, lexicalValue, UriFactory.Root.Create(XmlSpecsHelper.XmlSchemaDataTypeDateTime), normalizeLiteralValue) { }

        /// <summary>
        /// Creates a new Date Time valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="offsetValue">Date Time offset value.</param>
        /// <param name="lexicalValue">Lexical Value.</param>
        /// <param name="datatype">Data Type URI.</param>
        /// <param name="normalizeLiteralValue">Whether to perform unicode normalization on <paramref name="lexicalValue"/>.</param>
        public DateTimeNode(DateTime value, DateTimeOffset offsetValue, string lexicalValue, Uri datatype, bool normalizeLiteralValue = false)
            : base(lexicalValue, datatype, normalizeLiteralValue)
        {
            _value = value;
            _offsetValue = offsetValue;
        }

        /// <summary>
        /// Gets the String form of the Date Time.
        /// </summary>
        /// <param name="value">Value.</param>
        /// <param name="datatype">Datatype URI.</param>
        /// <returns></returns>
        private static string GetStringForm(DateTimeOffset value, Uri datatype)
        {
            switch (datatype.ToString())
            {
                case XmlSpecsHelper.XmlSchemaDataTypeDateTime:
                    return value.ToString(XmlSpecsHelper.XmlSchemaDateTimeFormat);
                case XmlSpecsHelper.XmlSchemaDataTypeDate:
                    return value.ToString(XmlSpecsHelper.XmlSchemaDateFormat);
                default:
                    throw new RdfQueryException("Unable to create a DateTimeNode because datatype URI is invalid");
            }
        }

        /// <summary>
        /// Gets the String form of the Date Time.
        /// </summary>
        /// <param name="value">Value.</param>
        /// <param name="datatype">Datatype URI.</param>
        /// <returns></returns>
        private static string GetStringForm(DateTime value, Uri datatype)
        {
            switch (datatype.ToString())
            {
                case XmlSpecsHelper.XmlSchemaDataTypeDateTime:
                    return value.ToString(XmlSpecsHelper.XmlSchemaDateTimeFormat);
                case XmlSpecsHelper.XmlSchemaDataTypeDate:
                    return value.ToString(XmlSpecsHelper.XmlSchemaDateFormat);
                default:
                    throw new RdfQueryException("Unable to create a DateTimeNode because datatype URI is invalid");
            }
        }

        /// <summary>
        /// Gets the date time value as a string.
        /// </summary>
        /// <returns></returns>
        public string AsString()
        {
            return Value;
        }

        /// <summary>
        /// Throws an error as date times cannot be converted to integers.
        /// </summary>
        /// <returns></returns>
        public long AsInteger()
        {
            throw new RdfQueryException("Cannot convert Date Times to other types");
        }

        /// <summary>
        /// Throws an error as date times cannot be converted to decimals.
        /// </summary>
        /// <returns></returns>
        public decimal AsDecimal()
        {
            throw new RdfQueryException("Cannot convert Date Times to other types");
        }

        /// <summary>
        /// Throws an error as date times cannot be converted to floats.
        /// </summary>
        /// <returns></returns>
        public float AsFloat()
        {
            throw new RdfQueryException("Cannot convert Date Times to other types");
        }

        /// <summary>
        /// Throws an error as date times cannot be converted to doubles.
        /// </summary>
        /// <returns></returns>
        public double AsDouble()
        {
            throw new RdfQueryException("Cannot convert Date Times to other types");
        }

        /// <summary>
        /// Throws an error as date times cannot be converted to booleans.
        /// </summary>
        /// <returns></returns>
        public bool AsBoolean()
        {
            throw new RdfQueryException("Cannot convert Date Times to other types");
        }

        /// <summary>
        /// Gets the date time value of the node.
        /// </summary>
        /// <returns></returns>
        public DateTime AsDateTime()
        {
            return _value;
        }

        /// <summary>
        /// Gets the date time value of the node.
        /// </summary>
        /// <returns></returns>
        public DateTimeOffset AsDateTimeOffset()
        {
            if (_offsetValue.HasValue)
            {
                return _offsetValue.Value;
            }
            else
            {
                // Create the offset
                _offsetValue = DateTimeOffset.TryParse(Value, null, DateTimeStyles.AssumeUniversal, out DateTimeOffset offset)
                                        ? offset
                                        : new DateTimeOffset(_value);
                return _offsetValue.Value;
            }
        }

        /// <summary>
        /// Throws an error as date times cannot be cast to a time span.
        /// </summary>
        /// <returns></returns>
        public TimeSpan AsTimeSpan()
        {
            throw new RdfQueryException("Cannot convert Date Times to other types");
        }

        /// <summary>
        /// Gets the URI of the datatype this valued node represents as a String.
        /// </summary>
        public string EffectiveType
        {
            get
            {
                return DataType.AbsoluteUri;
            }
        }

        /// <summary>
        /// Gets the numeric type of the node.
        /// </summary>
        public SparqlNumericType NumericType
        {
            get 
            {
                return SparqlNumericType.NaN;
            }
        }
    }

    /// <summary>
    /// Valued Node representing a Date value.
    /// </summary>
    public class DateNode
        : DateTimeNode
    {
        /// <summary>
        /// Creates a new Date valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        public DateNode(DateTimeOffset value)
            : base(value, UriFactory.Root.Create(XmlSpecsHelper.XmlSchemaDataTypeDate)) { }

        /// <summary>
        /// Creates a new Date valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="lexicalValue">Lexical Value.</param>
        public DateNode(DateTimeOffset value, string lexicalValue)
            : base(value, lexicalValue, UriFactory.Root.Create(XmlSpecsHelper.XmlSchemaDataTypeDate)) { }

        /// <summary>
        /// Creates a new Date valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        public DateNode(DateTime value)
            : base(value, UriFactory.Root.Create(XmlSpecsHelper.XmlSchemaDataTypeDate)) { }

        /// <summary>
        /// Creates a new Date valued node.
        /// </summary>
        /// <param name="value">Date Time value.</param>
        /// <param name="lexicalValue">Lexical Value.</param>
        public DateNode(DateTime value, string lexicalValue)
            : base(value, UriFactory.Root.Create(XmlSpecsHelper.XmlSchemaDataTypeDate)) { }
    }
}