Class DatePartAggregation

Aggregation plugin: Extract a date part, specified as a modifier

Inheritance

object

AggregationPluginBase

DatePartAggregation

Implements

IAggregationScalarPlugin

IAggregationPlugin

Inherited Members

AggregationPluginBase.HasModifier(string)

AggregationPluginBase.FirstModifier()

AggregationPluginBase.SetModifiers(string[])

AggregationPluginBase.AddItem(ArchiveColumnData[])

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.ArchiveLists.Aggregation

Assembly: SoDataBase.dll

Syntax

[AggregationPlugin("DatePart")]
public class DatePartAggregation : AggregationPluginBase, IAggregationScalarPlugin, IAggregationPlugin

Remarks

This aggregator produces no aggregated value; instead it returns modified detail rows. The return value is an integer, the specified part of the date that is the incoming item.

Modifier	What you get
Year	4-digit year
Quarter	Single-digit quarter, starting at 1
Month	2-digit month
Day	2-digit day of month
DayOfYear	Day of year, 1-366
DayOfWeek	Day of week, 0=Sunday, 6=Saturday
Hour	2-digit 24h-hour
Weekno	Week number
YearMonth	4-digit year slash 2-digit month
YearWeekno	4-digit year slash 2-digit week number
YearQuarter	4-digit year slash single-digit quarter number

Constructors

DatePartAggregation()

Aggregation plugin: Extract a date part, specified as a modifier

Declaration

public DatePartAggregation()

Remarks

This aggregator produces no aggregated value; instead it returns modified detail rows. The return value is an integer, the specified part of the date that is the incoming item.

Modifier	What you get
Year	4-digit year
Quarter	Single-digit quarter, starting at 1
Month	2-digit month
Day	2-digit day of month
DayOfYear	Day of year, 1-366
DayOfWeek	Day of week, 0=Sunday, 6=Saturday
Hour	2-digit 24h-hour
Weekno	Week number
YearMonth	4-digit year slash 2-digit month
YearWeekno	4-digit year slash 2-digit week number
YearQuarter	4-digit year slash single-digit quarter number

Fields

PluginName

Aggregation plugin: Extract a date part, specified as a modifier

Declaration

public const string PluginName = "DatePart"

Field Value

Type	Description
string

Remarks

This aggregator produces no aggregated value; instead it returns modified detail rows. The return value is an integer, the specified part of the date that is the incoming item.

Modifier	What you get
Year	4-digit year
Quarter	Single-digit quarter, starting at 1
Month	2-digit month
Day	2-digit day of month
DayOfYear	Day of year, 1-366
DayOfWeek	Day of week, 0=Sunday, 6=Saturday
Hour	2-digit 24h-hour
Weekno	Week number
YearMonth	4-digit year slash 2-digit month
YearWeekno	4-digit year slash 2-digit week number
YearQuarter	4-digit year slash single-digit quarter number

Methods

AddItem(ArchiveColumnData)

Accept one item, and return its replacement (output in the detail row)

Declaration

public override ArchiveColumnData AddItem(ArchiveColumnData item)

Parameters

Type	Name	Description
ArchiveColumnData	item

Returns

Type	Description
ArchiveColumnData	This value will be output in the current detail row. It can be the incoming item unchaged, a transformation of it, or the current (running) value of the aggregate - it all depends on the precise function the aggregator

Overrides

AggregationPluginBase.AddItem(ArchiveColumnData)

Remarks

This aggregator produces no aggregated value; instead it returns modified detail rows. The return value is an integer, the specified part of the date that is the incoming item.

Modifier	What you get
Year	4-digit year
Quarter	Single-digit quarter, starting at 1
Month	2-digit month
Day	2-digit day of month
DayOfYear	Day of year, 1-366
DayOfWeek	Day of week, 0=Sunday, 6=Saturday
Hour	2-digit 24h-hour
Weekno	Week number
YearMonth	4-digit year slash 2-digit month
YearWeekno	4-digit year slash 2-digit week number
YearQuarter	4-digit year slash single-digit quarter number

GetAggregatedValue()

Return the aggregate value (output in the footer)

Declaration

public override ArchiveColumnData GetAggregatedValue()

Returns

Type	Description
ArchiveColumnData

Overrides

AggregationPluginBase.GetAggregatedValue()

Remarks

This aggregator produces no aggregated value; instead it returns modified detail rows. The return value is an integer, the specified part of the date that is the incoming item.

Modifier	What you get
Year	4-digit year
Quarter	Single-digit quarter, starting at 1
Month	2-digit month
Day	2-digit day of month
DayOfYear	Day of year, 1-366
DayOfWeek	Day of week, 0=Sunday, 6=Saturday
Hour	2-digit 24h-hour
Weekno	Week number
YearMonth	4-digit year slash 2-digit month
YearWeekno	4-digit year slash 2-digit week number
YearQuarter	4-digit year slash single-digit quarter number

ToString()

Aggregation plugin: Extract a date part, specified as a modifier

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Remarks

This aggregator produces no aggregated value; instead it returns modified detail rows. The return value is an integer, the specified part of the date that is the incoming item.

Modifier	What you get
Year	4-digit year
Quarter	Single-digit quarter, starting at 1
Month	2-digit month
Day	2-digit day of month
DayOfYear	Day of year, 1-366
DayOfWeek	Day of week, 0=Sunday, 6=Saturday
Hour	2-digit 24h-hour
Weekno	Week number
YearMonth	4-digit year slash 2-digit month
YearWeekno	4-digit year slash 2-digit week number
YearQuarter	4-digit year slash single-digit quarter number

Implements

IAggregationScalarPlugin

IAggregationPlugin

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)

ObjectExtensions.AssignByReflection<T>(T, T)

ObjectExtensions.GraphCopy<T>(T)