/// <summary>
/// Gets the distinct units-of-time contained within a specified reporting period.
/// For example, a reporting period of 2Q2017-4Q2017, contains 2Q2017, 3Q2017, and 4Q2017.
/// </summary>
/// <remarks>
/// The endpoints are considered units within the reporting period.
/// </remarks>
/// <param name="reportingPeriod">The reporting period.</param>
/// <returns>
/// The units-of-time contained within the specified reporting period.
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="reportingPeriod"/> <see cref="ReportingPeriod.Start"/> and/or <see cref="ReportingPeriod.End"/> is unbounded.</exception>
public static IReadOnlyList <UnitOfTime> GetUnitsWithin(
this ReportingPeriod reportingPeriod)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
if (reportingPeriod.HasComponentWithUnboundedGranularity())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} {nameof(reportingPeriod.Start)} and/or {nameof(reportingPeriod.End)} is unbounded."));
}
var allUnits = new List <UnitOfTime>();
var currentUnit = reportingPeriod.Start;
do
{
allUnits.Add(currentUnit);
currentUnit = currentUnit.Plus(1);
}while (currentUnit <= reportingPeriod.End);
return(allUnits);
}
/// <summary>
/// Splits a reporting period into units-of-time by a specified granularity.
/// </summary>
/// <param name="reportingPeriod">The reporting period to split.</param>
/// <param name="granularity">The granularity to use when splitting.</param>
/// <param name="overflowStrategy">
/// OPTIONAL strategy to use when <paramref name="granularity"/> is less granular than
/// the <paramref name="reportingPeriod"/> and, when splitting, the resulting units-of-time
/// cannot be aligned with the start and end of the reporting period.
/// For example, splitting March 2015 - February 2017 by year results in 2015,2016,2017,
/// however only 2016 is fully contained within the reporting period.
/// The reporting period is missing January 2015 - February 2015 and March 2017 to December 2017.
/// DEFAULT is to throw when this happens.
/// </param>
/// <returns>
/// Returns the units-of-time that split the specified reporting period by the specified granularity.
/// The units-of-time will always be in the specified granularity, regardless of the granularity
/// of the reporting period (e.g. splitting a fiscal month reporting period using yearly granularity
/// will return <see cref="FiscalYear"/> objects).
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="reportingPeriod"/> has an <see cref="UnitOfTimeGranularity.Unbounded"/> component.</exception>
/// <exception cref="ArgumentException"><paramref name="granularity"/> is <see cref="UnitOfTimeGranularity.Invalid"/>.</exception>
/// <exception cref="ArgumentException"><paramref name="granularity"/> is <see cref="UnitOfTimeGranularity.Unbounded"/>.</exception>
/// <exception cref="ArgumentException"><paramref name="overflowStrategy"/> is not <see cref="OverflowStrategy.ThrowOnOverflow"/>.</exception>
/// <exception cref="InvalidOperationException">There was some overflow when splitting.</exception>
public static IReadOnlyList <UnitOfTime> Split(
this ReportingPeriod reportingPeriod,
UnitOfTimeGranularity granularity,
OverflowStrategy overflowStrategy = OverflowStrategy.ThrowOnOverflow)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
if (reportingPeriod.HasComponentWithUnboundedGranularity())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} has an {nameof(UnitOfTimeGranularity.Unbounded)} component."));
}
if (granularity == UnitOfTimeGranularity.Invalid)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Invalid}'"), (Exception)null);
}
if (granularity == UnitOfTimeGranularity.Unbounded)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Unbounded}'"), (Exception)null);
}
if ((overflowStrategy != OverflowStrategy.ThrowOnOverflow) && (overflowStrategy != OverflowStrategy.DiscardOverflow))
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(overflowStrategy)}' is not one of {{{OverflowStrategy.ThrowOnOverflow}, {OverflowStrategy.DiscardOverflow}}}."), (Exception)null);
}
var reportingPeriodGranularity = reportingPeriod.GetUnitOfTimeGranularity();
IReadOnlyList <UnitOfTime> result;
if (reportingPeriodGranularity == granularity)
{
result = reportingPeriod.GetUnitsWithin();
}
else if (reportingPeriodGranularity.IsLessGranularThan(granularity))
{
result = reportingPeriod.MakeMoreGranular(granularity).GetUnitsWithin();
}
else
{
var lessGranularReportingPeriod = reportingPeriod.MakeLessGranular(
granularity,
throwOnMisalignment: overflowStrategy == OverflowStrategy.ThrowOnOverflow);
result = lessGranularReportingPeriod.GetUnitsWithin();
if (overflowStrategy == OverflowStrategy.DiscardOverflow)
{
result = result.Where(reportingPeriod.Contains).ToList();
}
}
return(result);
}
public static IReadOnlyCollection <ReportingPeriod> CreatePermutations(
this ReportingPeriod reportingPeriod,
int maxUnitsInAnyReportingPeriod)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
if (reportingPeriod.HasComponentWithUnboundedGranularity())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} has an {nameof(UnitOfTimeGranularity.Unbounded)} component."));
}
if (maxUnitsInAnyReportingPeriod < 1)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(maxUnitsInAnyReportingPeriod)}' < '{1}'"), (Exception)null);
}
var allUnits = reportingPeriod.GetUnitsWithin();
var result = new List <ReportingPeriod>();
for (int unitOfTimeIndex = 0; unitOfTimeIndex < allUnits.Count; unitOfTimeIndex++)
{
for (int numberOfUnits = 1; numberOfUnits <= maxUnitsInAnyReportingPeriod; numberOfUnits++)
{
if (unitOfTimeIndex + numberOfUnits - 1 < allUnits.Count)
{
var subReportingPeriod = new ReportingPeriod(allUnits[unitOfTimeIndex], allUnits[unitOfTimeIndex + numberOfUnits - 1]);
result.Add(subReportingPeriod);
}
}
}
return(result);
}
private static ReportingPeriod MakeMoreGranular(
this ReportingPeriod reportingPeriod,
UnitOfTimeGranularity granularity)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
if (reportingPeriod.HasComponentWithUnboundedGranularity())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} has an {nameof(UnitOfTimeGranularity.Unbounded)} component."));
}
if (granularity == UnitOfTimeGranularity.Invalid)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Invalid}'"), (Exception)null);
}
if (granularity == UnitOfTimeGranularity.Unbounded)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Unbounded}'"), (Exception)null);
}
if (reportingPeriod.GetUnitOfTimeGranularity().IsAsGranularOrMoreGranularThan(granularity))
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} is as granular or more granular than {nameof(granularity)}."));
}
var moreGranularStart = reportingPeriod.Start.MakeMoreGranular(granularity);
var moreGranularEnd = reportingPeriod.End.MakeMoreGranular(granularity);
var result = new ReportingPeriod(moreGranularStart.Start, moreGranularEnd.End);
return(result);
}
/// <summary>
/// Converts the the specified reporting period into the least
/// granular possible, but equivalent, reporting period.
/// </summary>
/// <param name="reportingPeriod">The reporting period to operate on.</param>
/// <returns>
/// A reporting period that addresses the same set of time as <paramref name="reportingPeriod"/>,
/// but is the least granular version possible of that reporting period.
/// Any reporting period with one unbounded and one bounded component will be returned
/// as-is (e.g. Unbounded to 12/31/2017 will not be converted to Unbounded to CalendarYear 2017).
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod"/> is null.</exception>
public static ReportingPeriod ToLeastGranular(
this ReportingPeriod reportingPeriod)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
ReportingPeriod result;
if (reportingPeriod.HasComponentWithUnboundedGranularity())
{
result = reportingPeriod.DeepClone();
}
else
{
var targetGranularity = reportingPeriod.GetUnitOfTimeGranularity().OneNotchLessGranular();
if (targetGranularity == UnitOfTimeGranularity.Unbounded)
{
result = reportingPeriod.DeepClone();
}
else
{
try
{
result = reportingPeriod.MakeLessGranular(targetGranularity).ToLeastGranular();
}
catch (InvalidOperationException)
{
result = reportingPeriod.DeepClone();
}
}
}
return(result);
}
private static ReportingPeriod MakeLessGranular(
this ReportingPeriod reportingPeriod,
UnitOfTimeGranularity granularity,
bool throwOnMisalignment = true)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
if (reportingPeriod.HasComponentWithUnboundedGranularity())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} has an {nameof(UnitOfTimeGranularity.Unbounded)} component."));
}
if (granularity == UnitOfTimeGranularity.Invalid)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Invalid}'"), (Exception)null);
}
if (granularity == UnitOfTimeGranularity.Unbounded)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Unbounded}'"), (Exception)null);
}
var reportingPeriodGranularity = reportingPeriod.GetUnitOfTimeGranularity();
if (reportingPeriodGranularity.IsAsGranularOrLessGranularThan(granularity))
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} is as granular or less granular than {nameof(granularity)}."));
}
ReportingPeriod lessGranularReportingPeriod;
var unitOfTimeKind = reportingPeriod.GetUnitOfTimeKind();
if (reportingPeriodGranularity == UnitOfTimeGranularity.Day)
{
if (unitOfTimeKind == UnitOfTimeKind.Calendar)
{
var startAsCalendarDay = reportingPeriod.Start as CalendarDay;
// ReSharper disable once PossibleNullReferenceException
var startMonth = new CalendarMonth(startAsCalendarDay.Year, startAsCalendarDay.MonthOfYear);
if ((startMonth.GetFirstCalendarDay() != startAsCalendarDay) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a calendar day reporting period to a calendar month reporting period when the reporting period start time is not the first day of a month.");
}
var endAsCalendarDay = reportingPeriod.End as CalendarDay;
// ReSharper disable once PossibleNullReferenceException
var endMonth = new CalendarMonth(endAsCalendarDay.Year, endAsCalendarDay.MonthOfYear);
if ((endMonth.GetLastCalendarDay() != endAsCalendarDay) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a calendar day reporting period to a calendar month reporting period when the reporting period end time is not the last day of a month.");
}
lessGranularReportingPeriod = new ReportingPeriod(startMonth, endMonth);
}
else
{
throw new NotSupportedException("This kind of unit-of-time is not supported: " + unitOfTimeKind);
}
}
else if (reportingPeriodGranularity == UnitOfTimeGranularity.Month)
{
var startAsMonth = reportingPeriod.Start as IHaveAMonth;
var endAsMonth = reportingPeriod.End as IHaveAMonth;
var validStartMonths = new HashSet <int> {
1, 4, 7, 10
};
// ReSharper disable once PossibleNullReferenceException
if ((!validStartMonths.Contains((int)startAsMonth.MonthNumber)) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a monthly reporting period to a quarterly reporting period when the reporting period start time is not the first month of a recognized quarter.");
}
var validEndMonths = new HashSet <int> {
3, 6, 9, 12
};
// ReSharper disable once PossibleNullReferenceException
if ((!validEndMonths.Contains((int)endAsMonth.MonthNumber)) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a monthly reporting period to a quarterly reporting period when the reporting period end time is not the last month of a recognized quarter.");
}
var monthNumberToQuarterMap = new Dictionary <int, QuarterNumber>
{
{ 1, QuarterNumber.Q1 },
{ 2, QuarterNumber.Q1 },
{ 3, QuarterNumber.Q1 },
{ 4, QuarterNumber.Q2 },
{ 5, QuarterNumber.Q2 },
{ 6, QuarterNumber.Q2 },
{ 7, QuarterNumber.Q3 },
{ 8, QuarterNumber.Q3 },
{ 9, QuarterNumber.Q3 },
{ 10, QuarterNumber.Q4 },
{ 11, QuarterNumber.Q4 },
{ 12, QuarterNumber.Q4 },
};
if (unitOfTimeKind == UnitOfTimeKind.Calendar)
{
var startQuarter = new CalendarQuarter(startAsMonth.Year, monthNumberToQuarterMap[(int)startAsMonth.MonthNumber]);
var endQuarter = new CalendarQuarter(endAsMonth.Year, monthNumberToQuarterMap[(int)endAsMonth.MonthNumber]);
lessGranularReportingPeriod = new ReportingPeriod(startQuarter, endQuarter);
}
else if (unitOfTimeKind == UnitOfTimeKind.Fiscal)
{
var startQuarter = new FiscalQuarter(startAsMonth.Year, monthNumberToQuarterMap[(int)startAsMonth.MonthNumber]);
var endQuarter = new FiscalQuarter(endAsMonth.Year, monthNumberToQuarterMap[(int)endAsMonth.MonthNumber]);
lessGranularReportingPeriod = new ReportingPeriod(startQuarter, endQuarter);
}
else if (unitOfTimeKind == UnitOfTimeKind.Generic)
{
var startQuarter = new GenericQuarter(startAsMonth.Year, monthNumberToQuarterMap[(int)startAsMonth.MonthNumber]);
var endQuarter = new GenericQuarter(endAsMonth.Year, monthNumberToQuarterMap[(int)endAsMonth.MonthNumber]);
lessGranularReportingPeriod = new ReportingPeriod(startQuarter, endQuarter);
}
else
{
throw new NotSupportedException("This kind of unit-of-time is not supported: " + unitOfTimeKind);
}
}
else if (reportingPeriodGranularity == UnitOfTimeGranularity.Quarter)
{
var startAsQuarter = reportingPeriod.Start as IHaveAQuarter;
var endAsQuarter = reportingPeriod.End as IHaveAQuarter;
// ReSharper disable once PossibleNullReferenceException
if ((startAsQuarter.QuarterNumber != QuarterNumber.Q1) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a quarterly reporting period to a yearly reporting period when the reporting period start time is not Q1.");
}
// ReSharper disable once PossibleNullReferenceException
if ((endAsQuarter.QuarterNumber != QuarterNumber.Q4) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a quarterly reporting period to a yearly reporting period when the reporting period end is not Q4.");
}
if (unitOfTimeKind == UnitOfTimeKind.Calendar)
{
var startYear = new CalendarYear(startAsQuarter.Year);
var endYear = new CalendarYear(endAsQuarter.Year);
lessGranularReportingPeriod = new ReportingPeriod(startYear, endYear);
}
else if (unitOfTimeKind == UnitOfTimeKind.Fiscal)
{
var startYear = new FiscalYear(startAsQuarter.Year);
var endYear = new FiscalYear(endAsQuarter.Year);
lessGranularReportingPeriod = new ReportingPeriod(startYear, endYear);
}
else if (unitOfTimeKind == UnitOfTimeKind.Generic)
{
var startYear = new GenericYear(startAsQuarter.Year);
var endYear = new GenericYear(endAsQuarter.Year);
lessGranularReportingPeriod = new ReportingPeriod(startYear, endYear);
}
else
{
throw new NotSupportedException("This kind of unit-of-time is not supported: " + unitOfTimeKind);
}
}
else
{
throw new NotSupportedException("This granularity is not supported: " + reportingPeriodGranularity);
}
if (lessGranularReportingPeriod.GetUnitOfTimeGranularity() == granularity)
{
return(lessGranularReportingPeriod);
}
var result = MakeLessGranular(lessGranularReportingPeriod, granularity, throwOnMisalignment);
return(result);
}