/// <summary>
/// Method that generates an Excel (xml/xlsx) file with a time series of species observation counts.
/// </summary>
/// <param name="periodicity">A string value representing the alternative periodicities of the time series.</param>
/// <param name="addSettings"></param>
/// <param name="addProvenance"></param>
/// <returns>An Excel file of the type xml or xlsx.</returns>
public FileResult TimeSeriesOnSpeciesObservationCountsAsExcel(String periodicity, bool addSettings = true, bool addProvenance = true)
{
Periodicity periodicityEnumValue = (Periodicity)SessionHandler.MySettings.Calculation.TimeSeries.DefaultPeriodicityIndex;
if (!string.IsNullOrEmpty(periodicity))
{
switch (periodicity.ToLower())
{
case "dayoftheyear":
periodicityEnumValue = Periodicity.DayOfTheYear;
break;
case "weekoftheyear":
periodicityEnumValue = Periodicity.WeekOfTheYear;
break;
case "monthoftheyear":
periodicityEnumValue = Periodicity.MonthOfTheYear;
break;
case "daily":
periodicityEnumValue = Periodicity.Daily;
break;
case "weekly":
periodicityEnumValue = Periodicity.Weekly;
break;
case "monthly":
periodicityEnumValue = Periodicity.Monthly;
break;
default:
periodicityEnumValue = Periodicity.Yearly;
break;
}
}
SetServerDone();
if (SessionHandler.MySettings.Presentation.FileFormat.ExcelFileSettings.IsSettingsDefault())
{
TimeSeriesOnSpeciesObservationCountsExcelXlsx file =
FileExportManager.GetTimeSeriesOnSpeciesObservationCountsAsExcelXlsx(
GetCurrentUser(),
periodicityEnumValue,
addSettings,
addProvenance);
MemoryStream returnStream = file.ToStream();
return(File(returnStream, XlsxExcelFileMimeType, CreateXlsxExcelFileName("TimeSeriesOnSpeciesObservationCounts")));
}
else
{
TimeSeriesOnSpeciesObservationCountsExcelXml file = FileExportManager.GetTimeSeriesOnSpeciesObservationCountsAsExcelXml(GetCurrentUser(), periodicityEnumValue, addSettings, addProvenance);
MemoryStream returnStream = file.ToStream();
return(File(returnStream, XmlExcelFileMimeType, CreateXmlExcelFileName("TimeSeriesOnSpeciesObservationCounts")));
}
}
/// <summary>
/// Creates an xml excel file with the number of observed species over a selected period of time.
/// </summary>
/// <param name="currentUser">Current user context</param>
/// <param name="periodicity">The periodicity.</param>
/// <param name="addSettings">True if settings sheet should be included</param>
/// <param name="addProvenance">True if provenance sheet should be included.</param>
/// <returns>The xml excel file.</returns>
public static TimeSeriesOnSpeciesObservationCountsExcelXml GetTimeSeriesOnSpeciesObservationCountsAsExcelXml(IUserContext currentUser, Periodicity periodicity, bool addSettings, bool addProvenance)
{
TimeSeriesOnSpeciesObservationCountsExcelXml file = new TimeSeriesOnSpeciesObservationCountsExcelXml(currentUser, periodicity, addSettings, addProvenance);
return(file);
}
