Index: Ringtoets/Common/src/Ringtoets.Common.IO/FileImporters/CalculationConfigurationImporter.cs =================================================================== diff -u -r94066add9735c5429a60d904e8618aae1139c7b8 -rba686f1e57553487d9e0d2ce1e8547b55a162947 --- Ringtoets/Common/src/Ringtoets.Common.IO/FileImporters/CalculationConfigurationImporter.cs (.../CalculationConfigurationImporter.cs) (revision 94066add9735c5429a60d904e8618aae1139c7b8) +++ Ringtoets/Common/src/Ringtoets.Common.IO/FileImporters/CalculationConfigurationImporter.cs (.../CalculationConfigurationImporter.cs) (revision ba686f1e57553487d9e0d2ce1e8547b55a162947) @@ -37,6 +37,8 @@ /// Base class for importing a calculation configuration from an XML file and /// storing it on a . /// + /// The type of the reader to use for reading the XML file. + /// The type of the data read from the XML file by the reader. public abstract class CalculationConfigurationImporter : FileImporterBase where TConfigurationReader : ConfigurationReader @@ -47,12 +49,11 @@ /// /// Creates a new instance of . /// - /// The path to the file to import from. + /// The path to the XML file to import from. /// The calculation group to update. - /// Thrown when any parameter is - /// null. - protected CalculationConfigurationImporter(string filePath, CalculationGroup importTarget) - : base(filePath, importTarget) {} + /// Thrown when any parameter is null. + protected CalculationConfigurationImporter(string xmlFilePath, CalculationGroup importTarget) + : base(xmlFilePath, importTarget) {} protected override void LogImportCanceledMessage() { @@ -71,7 +72,7 @@ NotifyProgress(Resources.CalculationConfigurationImporter_ProgressText_Validating_imported_data, 2, 3); - var validCalculationItems = new List(); + var parsedCalculationItems = new List(); foreach (IReadConfigurationItem readItem in readResult.Items) { @@ -80,22 +81,43 @@ return false; } - ICalculationBase processedItem = ProcessReadItem(readItem); - if (processedItem != null) + ICalculationBase parsedItem = ParseReadConfigurationItem(readItem); + if (parsedItem != null) { - validCalculationItems.Add(processedItem); + parsedCalculationItems.Add(parsedItem); } } NotifyProgress(Resources.Importer_ProgressText_Adding_imported_data_to_data_model, 3, 3); - AddItemsToModel(validCalculationItems); + AddItemsToModel(parsedCalculationItems); + return true; } - protected abstract TConfigurationReader CreateConfigurationReader(string filePath); + /// + /// Creates the reader used for reading the configuration from the provided . + /// + /// The path to the XML file to import from. + /// A reader for reading the configuration. + /// Thrown when is invalid. + /// Thrown when: + /// + /// points to a file that does not exist. + /// points to a file that does not contain valid XML. + /// points to a file that does not pass the schema validation. + /// points to a file that does not contain configuration elements. + /// + /// + protected abstract TConfigurationReader CreateConfigurationReader(string xmlFilePath); - protected abstract ICalculationBase ProcessCalculation(TReadCalculation readCalculation); + /// + /// Parses a calculation from the provided . + /// + /// The calculation read from XML. + /// A parsed calculation instance. + /// Thrown when something goes wrong while parsing. + protected abstract ICalculationBase ParseReadCalculation(TReadCalculation readCalculation); private ReadResult ReadConfiguration() { @@ -116,44 +138,44 @@ } } - private ICalculationBase ProcessReadItem(IReadConfigurationItem readItem) + private ICalculationBase ParseReadConfigurationItem(IReadConfigurationItem readConfigurationItem) { - var readCalculationGroup = readItem as ReadCalculationGroup; + var readCalculationGroup = readConfigurationItem as ReadCalculationGroup; if (readCalculationGroup != null) { - return ProcessCalculationGroup(readCalculationGroup); + return ParseReadCalculationGroup(readCalculationGroup); } - var readCalculation = readItem as TReadCalculation; + var readCalculation = readConfigurationItem as TReadCalculation; if (readCalculation != null) { - return ProcessCalculationInternal(readCalculation); + return ParseReadCalculationInternal(readCalculation); } return null; } - private CalculationGroup ProcessCalculationGroup(ReadCalculationGroup readCalculationGroup) + private CalculationGroup ParseReadCalculationGroup(ReadCalculationGroup readCalculationGroup) { - var group = new CalculationGroup(readCalculationGroup.Name, true); + var calculationGroup = new CalculationGroup(readCalculationGroup.Name, true); foreach (IReadConfigurationItem item in readCalculationGroup.Items) { - ICalculationBase processedItem = ProcessReadItem(item); - if (processedItem != null) + ICalculationBase parsedItem = ParseReadConfigurationItem(item); + if (parsedItem != null) { - group.Children.Add(processedItem); + calculationGroup.Children.Add(parsedItem); } } - return group; + return calculationGroup; } - private ICalculationBase ProcessCalculationInternal(TReadCalculation readCalculation) + private ICalculationBase ParseReadCalculationInternal(TReadCalculation readCalculation) { try { - return ProcessCalculation(readCalculation); + return ParseReadCalculation(readCalculation); } catch (CriticalFileValidationException e) { @@ -165,11 +187,11 @@ } } - private void AddItemsToModel(IEnumerable validCalculationItems) + private void AddItemsToModel(IEnumerable parsedCalculationItems) { - foreach (ICalculationBase validCalculationItem in validCalculationItems) + foreach (ICalculationBase parsedCalculationItem in parsedCalculationItems) { - ImportTarget.Children.Add(validCalculationItem); + ImportTarget.Children.Add(parsedCalculationItem); } } } Index: Ringtoets/Common/test/Ringtoets.Common.IO.Test/FileImporters/CalculationConfigurationImporterTest.cs =================================================================== diff -u -r94066add9735c5429a60d904e8618aae1139c7b8 -rba686f1e57553487d9e0d2ce1e8547b55a162947 --- Ringtoets/Common/test/Ringtoets.Common.IO.Test/FileImporters/CalculationConfigurationImporterTest.cs (.../CalculationConfigurationImporterTest.cs) (revision 94066add9735c5429a60d904e8618aae1139c7b8) +++ Ringtoets/Common/test/Ringtoets.Common.IO.Test/FileImporters/CalculationConfigurationImporterTest.cs (.../CalculationConfigurationImporterTest.cs) (revision ba686f1e57553487d9e0d2ce1e8547b55a162947) @@ -79,12 +79,12 @@ return true; } - protected override TestConfigurationReader CreateConfigurationReader(string filePath) + protected override TestConfigurationReader CreateConfigurationReader(string xmlFilePath) { - return new TestConfigurationReader(filePath); + return new TestConfigurationReader(xmlFilePath); } - protected override ICalculationBase ProcessCalculation(TestReadConfigurationItem readCalculation) + protected override ICalculationBase ParseReadCalculation(TestReadConfigurationItem readCalculation) { throw new NotImplementedException(); } Index: Ringtoets/Piping/src/Ringtoets.Piping.IO/Importers/PipingConfigurationImporter.cs =================================================================== diff -u -r94066add9735c5429a60d904e8618aae1139c7b8 -rba686f1e57553487d9e0d2ce1e8547b55a162947 --- Ringtoets/Piping/src/Ringtoets.Piping.IO/Importers/PipingConfigurationImporter.cs (.../PipingConfigurationImporter.cs) (revision 94066add9735c5429a60d904e8618aae1139c7b8) +++ Ringtoets/Piping/src/Ringtoets.Piping.IO/Importers/PipingConfigurationImporter.cs (.../PipingConfigurationImporter.cs) (revision ba686f1e57553487d9e0d2ce1e8547b55a162947) @@ -48,19 +48,19 @@ /// /// Creates a new instance of . /// - /// The path to the file to import from. + /// The path to the XML file to import from. /// The calculation group to update. /// The hydraulic boundary locations /// used to check if the imported objects contain the right location. /// The piping failure mechanism used to check /// if the imported objects contain the right data. /// Thrown when any parameter is /// null. - public PipingConfigurationImporter(string filePath, + public PipingConfigurationImporter(string xmlFilePath, CalculationGroup importTarget, IEnumerable hydraulicBoundaryLocations, PipingFailureMechanism failureMechanism) - : base(filePath, importTarget) + : base(xmlFilePath, importTarget) { if (hydraulicBoundaryLocations == null) { @@ -74,12 +74,12 @@ this.failureMechanism = failureMechanism; } - protected override PipingConfigurationReader CreateConfigurationReader(string filePath) + protected override PipingConfigurationReader CreateConfigurationReader(string xmlFilePath) { return new PipingConfigurationReader(FilePath); } - protected override ICalculationBase ProcessCalculation(ReadPipingCalculation readCalculation) + protected override ICalculationBase ParseReadCalculation(ReadPipingCalculation readCalculation) { var pipingCalculation = new PipingCalculationScenario(new GeneralPipingInput()) {