// Copyright (C) Stichting Deltares 2018. 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.

namespace Deltares.Standard.Specifications
{
    /// <summary>
    /// With this class a value of an object bound to a property can be tested against the specification.
    /// This is a variant of the ParameterizedSpecification
    /// </summary>
    /// <typeparam name="TCandidate">The candidate type</typeparam>
    /// <typeparam name="TValue">The candidate property type</typeparam>
    public abstract class ValueBoundSpecification<TCandidate, TValue> : SpecificationBase<TCandidate>
    {
        private readonly string attributeName;
        private readonly TValue attributeValue;
        private TValue candidateValue;

        protected ValueBoundSpecification(string attributeName, TValue attributeValue)
        {
            this.attributeName = attributeName;
            this.attributeValue = attributeValue;
        }

        /// <summary>
        /// Gets the attribute value.
        /// </summary>
        public TValue AttributeValue
        {
            get { return attributeValue; }
        }

        /// <summary>
        /// Gets the candidate value.
        /// </summary>
        public TValue CandidateValue
        {
            get { return candidateValue; }
        }

        /// <summary>
        /// Gets the candidate string value.
        /// </summary>
        /// <param name="candidate">The candidate.</param>
        /// <returns></returns>
        protected string GetCandidateStringValue(TCandidate candidate)
        {
            return GetCandidateObjectValue(candidate).ToString();
        }

        /// <summary>
        /// Gets the candidate T value.
        /// </summary>
        /// <param name="candidate">The candidate.</param>
        /// <returns></returns>
        protected TValue GetCandidateTValue(TCandidate candidate)
        {
            if (candidateValue.Equals(default(TValue)))
                candidateValue = (TValue) GetCandidateObjectValue(candidate);

            return candidateValue;
        }

        /// <summary>
        /// Gets the candidate object value.
        /// </summary>
        /// <param name="candidate">The candidate.</param>
        /// <returns></returns>
        private object GetCandidateObjectValue(TCandidate candidate)
        {
            return candidate.GetType().GetProperty(attributeName).GetValue(candidate, null);
        }
    }
}