// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of the DAM Engine.
//
// The DAM Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System;
using System.Collections.Generic;
using Deltares.DamEngine.Data.Standard.Language;

namespace Deltares.DamEngine.Data.Standard.Validation
{
    /// <summary>
    /// Class ValidationResult
    /// </summary>
    /// <seealso cref="IValidationResult" />
    [Serializable]
    public class ValidationResult : IValidationResult
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationResult"/> class.
        /// </summary>
        public ValidationResult() : this(ValidationResultType.Error, string.Empty) {}

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationResult"/> class.
        /// </summary>
        /// <param name="messageType">Type of the message.</param>
        /// <param name="text">The text.</param>
        public ValidationResult(ValidationResultType messageType, string text)
            : this(messageType, text, null) {}

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationResult"/> class.
        /// </summary>
        /// <param name="messageType">Type of the message.</param>
        /// <param name="text">The text.</param>
        /// <param name="subject">The object for which the message is of interest (shown in the second column)</param>
        public ValidationResult(ValidationResultType messageType, string text, object subject)
        {
            MessageType = messageType;
            Text = text;
            Subject = subject;
            InvalidProperties = new List<string>();
            ID = new List<string>();
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationResult"/> class.
        /// </summary>
        /// <param name="messageType">Type of the message.</param>
        /// <param name="text">The text.</param>
        /// <param name="subject">The object for which the message is of interest (shown in the second column)</param>
        /// <param name="id">ID for the message (note: does not seem to be shown)</param>
        public ValidationResult(ValidationResultType messageType, string text, string id, object subject)
            : this(messageType, text, subject, "", id) {}

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationResult"/> class.
        /// </summary>
        /// <param name="messageType">Type of the message.</param>
        /// <param name="text">The text.</param>
        /// <param name="subject">The object for which the message is of interest (shown in the second column)</param>
        /// <param name="property">Property for which the message was issued (note: does not seem to be shown)</param>
        /// <param name="id">ID for the message (note: does not seem to be shown)</param>
        public ValidationResult(ValidationResultType messageType, string text, object subject, string property, string id)
        {
            MessageType = messageType;
            Text = text;
            Subject = subject;
            InvalidProperties = new List<string>
                {
                    property
                };
            ID = new List<string>
                {
                    id
                };            
        }

        #region IValidationResult Members

        /// <summary>
        /// Gets the identifier.
        /// </summary>
        /// <value>
        /// The identifier.
        /// </value>
        public List<string> ID { get; private set; }

        /// <summary>
        /// Gets the invalid properties.
        /// </summary>
        /// <value>
        /// The invalid properties.
        /// </value>
        public List<string> InvalidProperties { get; private set; }

        /// <summary>
        /// Gets the type of the message.
        /// </summary>
        /// <value>
        /// The type of the message.
        /// </value>
        public ValidationResultType MessageType { get; set; }


        /// <summary>
        /// Gets or sets the text.
        /// </summary>
        /// <value>
        /// The text.
        /// </value>
        [Translation("Message")]
        public string Text { get; set; }

        /// <summary>
        /// Gets or sets the subject.
        /// </summary>
        /// <value>
        /// The subject.
        /// </value>
        public object Subject { get; set; }

        #endregion

        /// <summary>
        /// Adds the property and identifier.
        /// </summary>
        /// <param name="property">The property.</param>
        /// <param name="aId">The identifier.</param>
        public void AddPropertyAndId(string property, string aId)
        {
            InvalidProperties.Add(property);
            ID.Add(aId);
        }

        /// <summary>
        /// Clears the validation result.
        /// </summary>
        public void ClearValidationResult()
        {
            Subject = null;
            if (InvalidProperties != null)
            {
                InvalidProperties.Clear();
            }
            if (ID != null)
            {
                ID.Clear();
            }
        }
    }
}