// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets 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 .
//
// 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 Core.Common.Base.IO;
using Core.Common.IO.Exceptions;
using Core.Common.Util;
using log4net;
using Ringtoets.AssemblyTool.Data;
using Ringtoets.AssemblyTool.IO;
using Ringtoets.Common.Data.Exceptions;
using Ringtoets.Integration.Data;
using Ringtoets.Integration.Data.Assembly;
using Ringtoets.Integration.IO.Assembly;
using Ringtoets.Integration.IO.Creators;
using Ringtoets.Integration.IO.Exceptions;
using Ringtoets.Integration.IO.Factories;
using Ringtoets.Integration.IO.Properties;
namespace Ringtoets.Integration.IO.Exporters
{
///
/// Exports assembly results of the assessment section.
///
public class AssemblyExporter : IFileExporter
{
private static readonly ILog log = LogManager.GetLogger(typeof(AssemblyExporter));
private readonly AssessmentSection assessmentSection;
private readonly string filePath;
///
/// Creates a new instance of .
///
/// The to retrieve the assembly results from.
/// The path of the file to export to.
/// Thrown when is null.
/// Thrown when is invalid.
public AssemblyExporter(AssessmentSection assessmentSection, string filePath)
{
if (assessmentSection == null)
{
throw new ArgumentNullException(nameof(assessmentSection));
}
IOUtils.ValidateFilePath(filePath);
this.assessmentSection = assessmentSection;
this.filePath = filePath;
}
public bool Export()
{
CheckManualAssembly();
ExportableAssessmentSection exportableAssessmentSection = CreateExportableAssessmentSection();
if (!ValidateExportableAssessmentSection(exportableAssessmentSection))
{
LogErrorMessage();
return false;
}
try
{
SerializableAssemblyWriter.WriteAssembly(SerializableAssemblyCreator.Create(exportableAssessmentSection),
filePath);
}
catch (AssemblyCreatorException)
{
LogErrorMessage();
return false;
}
catch (CriticalFileWriteException e)
{
log.ErrorFormat(Resources.AssemblyExporter_Error_Exception_0_no_AssemblyResult_exported, e.Message);
return false;
}
return true;
}
private void CheckManualAssembly()
{
if (AssessmentSectionHelper.HasManualAssemblyResults(assessmentSection))
{
log.Warn(Resources.AssemblyExporter_CheckManualAssembly_Assembly_result_contains_manual_results_exporter_will_ignore_manual_results);
}
}
private ExportableAssessmentSection CreateExportableAssessmentSection()
{
try
{
return ExportableAssessmentSectionFactory.CreateExportableAssessmentSection(assessmentSection);
}
catch (AssemblyException)
{
return null;
}
}
private static bool ValidateExportableAssessmentSection(ExportableAssessmentSection exportableAssessmentSection)
{
return exportableAssessmentSection != null
&& exportableAssessmentSection.AssessmentSectionAssembly.AssemblyCategory != AssessmentSectionAssemblyCategoryGroup.None
&& exportableAssessmentSection.AssessmentSectionAssembly.AssemblyCategory != AssessmentSectionAssemblyCategoryGroup.NotApplicable;
}
private static void LogErrorMessage()
{
log.Error(Resources.AssemblyExporter_LogErrorMessage_Only_possible_to_export_a_complete_AssemblyResult);
}
}
}