/// <summary>
/// Generate an inter-comparison summary Excel XML spreadsheet
/// </summary>
/// <param name="dodStats">Dictionary of DoD statistics.</param>
/// <param name="output">File path of the output inter-comparison spreadsheet to be generated</param>
/// <remarks>
/// This method is used from two places for subtly different purposes:
///
/// 1. Every budget segregation will generate a single inter-comparison spreadsheet summarizing the DoD statistics for all classes
/// 2. The user can manually generate an inter-comparison by selecting two or more DoDs in the user interface.
///
/// In both cases the code that calls this method is responsible for building a dictionary of DoD statistics. In the first
/// case the dictionary key will be the budget segregation class ("pool", "riffle" etc). In the second case the key will be
/// the DoD name ("2006 - 2006 Min LoD 0.2m" etc).
///
/// The processing in this class is identical for both cases.</remarks>
public static void Generate(Dictionary <string, GCDConsoleLib.GCD.DoDStats> dodStats, FileInfo output)
{
int DoDCount = 0;
//get template and throw error if it doesnt exists
FileInfo template = new FileInfo(Path.Combine(Project.ProjectManager.ExcelTemplatesFolder.FullName, "InterComparison.xml"));
if (!template.Exists)
{
throw new Exception("The GCD intercomparison spreadsheet template cannot be found at " + template.FullName);
}
//setup ExcelXMLDocument which does the heavy lifting of updating the XML
ExcelXMLDocument xmlExcelDoc = new ExcelXMLDocument(template.FullName);
foreach (KeyValuePair <string, GCDConsoleLib.GCD.DoDStats> kvp in dodStats)
{
//get name and stats from input
string DoDName = kvp.Key;
GCDConsoleLib.GCD.DoDStats dodStat = kvp.Value;
//turn these into a dictionary of named values to replace in XML
Dictionary <string, string> dicStatValues = GetStatValues(dodStat);
dicStatValues.Add("TemplateRowName", DoDName); //Add name so the Named Range for the name (e.g. ArealDoDName) is updated
DoDCount += 1;
//update or clone all template rows. All references are maintained by the ExcelXMLDocument
//e.g. relative references, sum formulas and named ranges
if (DoDCount > 1)
{
xmlExcelDoc.CloneRow("ArealDoDName", DoDCount - 1, dicStatValues);
xmlExcelDoc.CloneRow("VolumeDoDName", DoDCount - 1, dicStatValues);
xmlExcelDoc.CloneRow("VerticalDoDName", DoDCount - 1, dicStatValues);
xmlExcelDoc.CloneRow("PercentagesDoDName", DoDCount - 1, dicStatValues);
}
else
{
xmlExcelDoc.UpdateRow("ArealDoDName", dicStatValues);
xmlExcelDoc.UpdateRow("VolumeDoDName", dicStatValues);
xmlExcelDoc.UpdateRow("VerticalDoDName", dicStatValues);
xmlExcelDoc.UpdateRow("PercentagesDoDName", dicStatValues);
}
}
//cells should be formatted with grey, single weight top and bottom border
CellStyle oCellStyle = new CellStyle();
oCellStyle.TopBorder.Weight = 1;
oCellStyle.TopBorder.Color = "#E7E6E6";
oCellStyle.BottomBorder.Weight = 1;
oCellStyle.BottomBorder.Color = "#E7E6E6";
//loop through all cells and format
for (int i = 0; i < dodStats.Count; i++)
{
xmlExcelDoc.FormatRow("ArealDoDName", i, oCellStyle);
xmlExcelDoc.FormatRow("VolumeDoDName", i, oCellStyle);
xmlExcelDoc.FormatRow("VerticalDoDName", i, oCellStyle);
xmlExcelDoc.FormatRow("PercentagesDoDName", i, oCellStyle);
}
//save output
xmlExcelDoc.Save(output.FullName);
}
