// Copyright (C) Stichting Deltares 2023. All rights reserved.
// 
// This file is part of the application DAM - UI.
// 
// DAM - UI is free software: you can redistribute it and/or modify
// it under the terms of the GNU 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 General Public License for more details.
// 
// You should have received a copy of the GNU 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;

namespace Deltares.Standard;

/// <summary>
/// Importance or the requiremen for a value in the domain object 
/// before it can be used in a dto
/// </summary>
public enum DtoPropertyImportance
{
    /// <summary>
    /// Use this setting when the property or attribute must have a value
    /// </summary>
    Required,

    /// <summary>
    /// Use this setting when the property or attribute value is optional
    /// </summary>
    Optional
}

/// <summary>
/// Defines a mapping class which can be used in the DtoAssemler for creating 
/// mappings between class properties and xml attributes    
/// </summary>
public class DtoPropertyAttriubteMapping
{
    /// <summary>
    /// Holds the property to attribute translation rule
    /// </summary>
    private Func<object, object> toAttributeTranslationRule;

    /// <summary>
    /// Holds the attribute to property translation rule.
    /// </summary>
    private Func<object, object> toPropTranslationRule;

    /// <summary>
    /// Initializes a new instance of the DtoPropertyAttriubteMapping class
    /// </summary>
    public DtoPropertyAttriubteMapping()
    {
        Importance = DtoPropertyImportance.Optional;
    }

    /// <summary>
    /// Gets or sets the name of the property in the domain object
    /// </summary>
    public string PropertyName { get; set; }

    /// <summary>
    /// Gets or sets the name of the xml attribute of the dto
    /// </summary>
    public string AttributeName { get; set; }

    /// <summary>
    /// Gets or sets the importance of the value. Required or optional?
    /// </summary>
    public DtoPropertyImportance Importance { get; set; }

    /// <summary>
    /// Gets or sets the attribute to property translation rule
    /// </summary>
    /// <remarks>
    /// Use this property when a string value in the xml needs to be specifically translated. This can be useful 
    /// in scenario's when a string value needs to be translated to a specific enum value.
    /// For example when the enum string value "Belgian Bessel" needs to be translated to the enum type CoordinateSystem.BelgianBessel
    /// </remarks>
    public Func<object, object> ToPropertyTranslationRule
    {
        get
        {
            return toPropTranslationRule;
        }
        set
        {
            toPropTranslationRule = value;
        }
    }

    /// <summary>
    /// Gets or sets the property to attribute translation rule
    /// </summary>
    /// <remarks>
    /// Use this property when a property value needs to be translated to a specific string value. 
    /// For example when the enum type CoordinateSystem.BelgianBessel needs to be translated to the enum string value "Belgian Bessel"
    /// </remarks>
    public Func<object, object> ToAttributeTranslationRule
    {
        get
        {
            return toAttributeTranslationRule;
        }
        set
        {
            toAttributeTranslationRule = value;
        }
    }
}