Constructs a new GroupBy, which will request
aggregation of records into groups based on the Endeca
property or dimension named groupingKey.
Namespace: Endeca.Navigation.AnalyticsAssembly: Endeca.Navigation (in Endeca.Navigation.dll) Version: 6.3.0.0 (6.3.0.853)
Syntax
C# |
---|
public GroupBy( string groupingKey, int depth ) |
Visual Basic |
---|
Public Sub New ( _ groupingKey As String, _ depth As Integer _ ) |
Visual C++ |
---|
public: GroupBy( String^ groupingKey, int depth ) |
Parameters
- groupingKey
- Type: System..::..String
The name of the Endeca property or dimension by which the records will be aggregated.
- depth
- Type: System..::..Int32
The level of a dimension hierarchy at which the grouping will be performed.
Remarks
This two-parameter constructor will request
aggregation of records into groups based on the Endeca
property or dimension named groupingKey.
For dimensions, the grouping will depend on the value's ancestor
at depth from the root
of the dimension's hierarchy.
Note that a depth of zero does not indicate grouping at the root of the hierarchy, but rather it denotes that depth will not be taken into account at all, so grouping will be performed based on the values encountered.
Examples
If a dimension named Region contains a hierarchy of
Country, State, and City, and the grouping
was desired at the State level (one level below the root
of the dimension hierarchy), the constructor code would be:
CopyC#
GroupByList g = new GroupByList(); GroupBy grByReg = new GroupBy("Region",1); g.add(grByReg);