//-----------------------------------------------------------------------
// <copyright file="DtoPropertyAttributeMapping.cs" company="Deltares">
//  Copyright (c) 2009 Deltares. All rights reserved.
// </copyright>
// <author>B. Faassen</author>
// <email>barry.faassen@deltares.nl</email>
// <date>9-2-2009</date>
// <summary>
//  Defines a mapping class which can be used in the DtoAssemler for 
//  creating mappings between class properties and xml attributes
// </summary>
//-----------------------------------------------------------------------

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()
        {
            this.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 this.toPropTranslationRule; }
            set { this.toPropTranslationRule = new Func<object, object>(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 this.toAttributeTranslationRule; }
            set { this.toAttributeTranslationRule = new Func<object, object>(value); }
        }
    }
}