// Copyright (C) Stichting Deltares 2016. 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 System.Collections.Generic;
using System.Linq;
using Core.Common.Base;
using Core.Common.Utils;
using Ringtoets.Piping.Data;
using Ringtoets.Piping.Forms;
using Ringtoets.Piping.IO.Importers;
using Ringtoets.Piping.Plugin.Properties;
using Ringtoets.Piping.Primitives;
using Ringtoets.Piping.Service;
namespace Ringtoets.Piping.Plugin.FileImporter
{
///
/// Strategy for updating the current surface lines with the imported surface lines:
///
/// - Adds imported surface lines that are not part of the current collection.
/// - Removes surface lines that are part of the current collection, but are not part of the imported surface line collection.
/// - Updates the surface lines that are part of the current collection and are part of the imported surface line collection.
///
///
public class RingtoetsPipingSurfaceLineUpdateDataStrategy : ISurfaceLineUpdateDataStrategy
{
private readonly PipingFailureMechanism failureMechanism;
///
/// Creates a new instance of .
///
/// The failure mechanism in which the surface lines are updated.
public RingtoetsPipingSurfaceLineUpdateDataStrategy(PipingFailureMechanism failureMechanism)
{
if (failureMechanism == null)
{
throw new ArgumentNullException(nameof(failureMechanism));
}
this.failureMechanism = failureMechanism;
}
public IEnumerable UpdateSurfaceLinesWithImportedData(RingtoetsPipingSurfaceLineCollection targetCollection,
IEnumerable readRingtoetsPipingSurfaceLines,
string sourceFilePath)
{
if (targetCollection == null)
{
throw new ArgumentNullException(nameof(targetCollection));
}
if (readRingtoetsPipingSurfaceLines == null)
{
throw new ArgumentNullException(nameof(readRingtoetsPipingSurfaceLines));
}
if (sourceFilePath == null)
{
throw new ArgumentNullException(nameof(sourceFilePath));
}
try
{
return ModifySurfaceLineCollection(targetCollection, readRingtoetsPipingSurfaceLines, sourceFilePath);
}
catch (InvalidOperationException e)
{
var message = Resources.RingtoetsPipingSurfaceLineUpdateDataStrategy_UpdateSurfaceLinesWithImportedData_Update_of_RingtoetsPipingSurfaceLine_has_failed;
throw new RingtoetsPipingSurfaceLineUpdateException(message, e);
}
}
private IEnumerable ModifySurfaceLineCollection(RingtoetsPipingSurfaceLineCollection existingCollection,
IEnumerable readSurfaceLines,
string sourceFilePath)
{
List readSurfaceLineList = readSurfaceLines.ToList();
List addedSurfaceLines = GetAddedReadSurfaceLines(existingCollection, readSurfaceLineList).ToList();
List updatedSurfaceLines = GetUpdatedSurfaceLines(existingCollection, readSurfaceLineList).ToList();
List removedSurfaceLines = GetRemovedSurfaceLines(existingCollection, readSurfaceLineList).ToList();
var affectedObjects = new List();
if (addedSurfaceLines.Any())
{
affectedObjects.Add(existingCollection);
}
affectedObjects.AddRange(UpdateSurfaceLines(updatedSurfaceLines, readSurfaceLineList));
affectedObjects.AddRange(RemoveSurfaceLines(removedSurfaceLines));
existingCollection.Clear();
try
{
existingCollection.AddRange(addedSurfaceLines.Union(updatedSurfaceLines), sourceFilePath);
}
catch (ArgumentException e)
{
throw new RingtoetsPipingSurfaceLineUpdateException(e.Message, e);
}
return affectedObjects.Distinct(new ReferenceEqualityComparer());
}
private static IEnumerable GetRemovedSurfaceLines(IEnumerable existingCollection,
IEnumerable readSurfaceLine)
{
return existingCollection.Except(readSurfaceLine, new RingtoetsPipingSurfaceLineNameEqualityComparer());
}
private static IEnumerable GetUpdatedSurfaceLines(IEnumerable existingCollection,
IEnumerable readSurfaceLines)
{
return existingCollection.Intersect(readSurfaceLines, new RingtoetsPipingSurfaceLineNameEqualityComparer());
}
private static IEnumerable GetAddedReadSurfaceLines(IEnumerable existingCollection,
IEnumerable readSurfaceLines)
{
return readSurfaceLines.Except(existingCollection, new RingtoetsPipingSurfaceLineNameEqualityComparer());
}
#region Removing surface line helpers
private IEnumerable RemoveSurfaceLines(IEnumerable removedSurfaceLines)
{
var affectedObjects = new List();
foreach (RingtoetsPipingSurfaceLine surfaceLine in removedSurfaceLines)
{
affectedObjects.AddRange(ClearSurfaceLineDependentData(surfaceLine));
}
return affectedObjects;
}
private IEnumerable ClearSurfaceLineDependentData(RingtoetsPipingSurfaceLine surfaceLine)
{
return PipingDataSynchronizationService.RemoveSurfaceLine(failureMechanism, surfaceLine);
}
#endregion
#region Updating surface line helper
private IEnumerable UpdateSurfaceLines(IEnumerable updatedSurfaceLines,
IList readSurfaceLines)
{
var affectedObjects = new List();
foreach (RingtoetsPipingSurfaceLine updatedSurfaceLine in updatedSurfaceLines)
{
RingtoetsPipingSurfaceLine matchingSurfaceLine = readSurfaceLines.Single(sl => sl.Name == updatedSurfaceLine.Name);
updatedSurfaceLine.Update(matchingSurfaceLine);
affectedObjects.Add(updatedSurfaceLine);
affectedObjects.AddRange(UpdateAvailableStochasticSoilModels(updatedSurfaceLine));
}
return affectedObjects;
}
private IEnumerable UpdateAvailableStochasticSoilModels(RingtoetsPipingSurfaceLine updatedSurfaceLine)
{
IEnumerable affectedCalculations =
failureMechanism.Calculations
.Cast()
.Where(calc => ReferenceEquals(updatedSurfaceLine, calc.InputParameters.SurfaceLine));
var affectedObjects = new List();
foreach (PipingCalculation affectedCalculation in affectedCalculations)
{
IEnumerable matchingSoilModels = GetAvailableStochasticSoilModels(updatedSurfaceLine);
PipingInputService.SetMatchingStochasticSoilModel(affectedCalculation.InputParameters, matchingSoilModels);
affectedObjects.Add(affectedCalculation);
affectedObjects.Add(affectedCalculation.InputParameters);
}
return affectedObjects;
}
private IEnumerable GetAvailableStochasticSoilModels(RingtoetsPipingSurfaceLine surfaceLine)
{
return PipingCalculationConfigurationHelper.GetStochasticSoilModelsForSurfaceLine(surfaceLine,
failureMechanism.StochasticSoilModels);
}
#endregion
///
/// Class for comparing by only the name.
///
private class RingtoetsPipingSurfaceLineNameEqualityComparer : IEqualityComparer
{
public bool Equals(RingtoetsPipingSurfaceLine x, RingtoetsPipingSurfaceLine y)
{
return x.Name == y.Name;
}
public int GetHashCode(RingtoetsPipingSurfaceLine obj)
{
return obj.Name.GetHashCode();
}
}
}
}