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

namespace Deltares.Dam.Data
{
    /// <summary>
    /// This class helps to build cvs export data. Everytime the builder is ended by calling Build() method, 
    /// the builder is reset and can be used to construct a new CvsExportData item.
    /// </summary>
    internal class DamProjectCalculatorCsvExportDataBuilder
    {
        private Dike Dike { get; set; }
        private Scenario Scenario { get; set; }
        private DamFailureMechanismeCalculationSpecification FailureMechanismSystemType { get; set; }
        private AnalysisType AnalysisType { get; set; }
        private ProbabilisticType ProbabilisticType { get; set; }
        private StringBuilder Message { get; set; }

        /// <summary>
        /// Instantiate a new instance of the <see cref="DamProjectCalculatorCsvExportDataBuilder"/> with general settings which to use in creating
        /// <see cref="CsvExportData"/>.
        /// </summary>
        /// <param name="dike">The <see cref="Dike"/> for which to create <see cref="CsvExportData"/>.</param>
        /// <param name="scenario">The <see cref="Scenario"/> for which to create <see cref="CsvExportData"/>.</param>
        /// <param name="damFailureMechanismCalculationSpecification">The <see cref="DamFailureMechanismeCalculationSpecification"/> for which to create <see cref="CsvExportData"/>.</param>
        /// <param name="analysisType">The <see cref="AnalysisType"/> for which to create <see cref="CsvExportData"/>.</param>
        /// <param name="probabilisticType">The <see cref="ProbabilisticType"/> for which to create <see cref="CsvExportData"/></param>
        public DamProjectCalculatorCsvExportDataBuilder(Dike dike, Scenario scenario, DamFailureMechanismeCalculationSpecification damFailureMechanismCalculationSpecification, AnalysisType analysisType, ProbabilisticType probabilisticType)
        {
            Dike = dike;
            Scenario = scenario;
            FailureMechanismSystemType = damFailureMechanismCalculationSpecification;
            AnalysisType = analysisType;
            ProbabilisticType = probabilisticType;
            Message = new StringBuilder();
        }

        /// <summary>
        /// Returns a new instance of <see cref="CsvExportData"/>. Messages that were added using <see cref="Append"/> are added to the <see cref="CsvExportData"/>
        /// and the message queue is cleared.
        /// </summary>
        /// <param name="soilGeometryProbability">The <see cref="SoilGeometryProbability"/> for which to create this <see cref="CsvExportData"/>.</param>
        /// <param name="kernelType">The <see cref="StabilityKernelType"/> to set for the to be created <see cref="CsvExportData"/>. Default is the 0th <see cref="StabilityKernelType"/>.</param>
        /// <returns>The newly constructed <see cref="CsvExportData"/> with messages appended using <see cref="Append"/>.</returns>
        public CsvExportData Build(SoilGeometryProbability soilGeometryProbability, StabilityKernelType kernelType = (StabilityKernelType) 0)
        {
            return Build(soilGeometryProbability, kernelType, 0);
        }

        /// <summary>
        /// Returns a new instance of <see cref="CsvExportData"/>. Messages that were added using <see cref="Append"/> are added to the <see cref="CsvExportData"/>
        /// and the message queue is cleared.
        /// </summary>
        /// <param name="soilGeometryProbability">The <see cref="SoilGeometryProbability"/> for which to create this <see cref="CsvExportData"/>.</param>
        /// <param name="index">An optional index to associate the <see cref="CsvExportData"/> with some other object of a list.</param>
        /// <returns>The newly constructed <see cref="CsvExportData"/> with messages appended using <see cref="Append"/>.</returns>
        public CsvExportData Build(SoilGeometryProbability soilGeometryProbability, int index)
        {
            return Build(soilGeometryProbability, 0, index);
        }

        private CsvExportData Build(SoilGeometryProbability soilGeometryProbability, StabilityKernelType kernelType, int index)
        {
             var data = new CsvExportData(
                Message.ToString(),
                Dike,
                FailureMechanismSystemType,
                Scenario,
                soilGeometryProbability.SoilProfile,
                soilGeometryProbability.SoilGeometry2DName,
                AnalysisType,
                index,
                ProbabilisticType);
            data.SelectedStabilityKernelType = kernelType;

            Message.Clear();

            return data;
        }
        
        /// <summary>
        /// Append a new message to the message queue.
        /// </summary>
        /// <param name="messageParts">The messages to add to the queue.</param>
        /// <returns>This instance of the <see cref="DamProjectCalculatorCsvExportDataBuilder"/> so that consecutive calls to methods 
        /// of <see cref="DamProjectCalculatorCsvExportDataBuilder"/> can be chained.</returns>
        public DamProjectCalculatorCsvExportDataBuilder Append(params object[] messageParts)
        {
            foreach (var messagePart in messageParts)
            {
                Message.Append(messagePart);
            }
            return this;
        }
    }
}