A GroupBy defines a single dimension of
record grouping for a containing Statement
operation.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class GroupBy : IQueryNode
Public Class GroupBy _ Implements IQueryNode
public ref class GroupBy : IQueryNode
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | GroupByGroupByNew(String) |
Constructs a new GroupBy.
|
| GroupByGroupByNew(String, Int32) |
Constructs a new GroupBy, which will request
aggregation of records into groups based on the Endeca
property or dimension named groupingKey.
|
 | Depth |
Gets and sets the dimension depth for the aggregates
defined by this GroupBy.
|
| Equals(Object) |
Indicates whether this GroupBy has an equivalence
to a reference GroupBy specified by obj.
(Overrides Object.Equals(Object).) |
| FieldName |
Gets and sets the name of the grouping property or dimension
for this GroupBy.
|
 | Finalize()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode()() |
Returns the hashcode of the object.
(Overrides Object.GetHashCode()().) |
| GetType()() | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString()() |
Returns the string form of this GroupBy.
(Overrides Object.ToString()().) |
| ToWire()() |
Returns the wire form of this GroupBy.
|
| ValidateSyntax()() |
Validates the syntax of this GroupBy.
|
Remarks
Basically, a GroupBy represents an
Endeca property or dimension by which records will
be grouped. Input records for the containing
Statement operation are grouped together
by common assignment from the GroupBy
property or dimension. GroupBy
instances are encapsulated in a GroupByList,
which in turn is set in the Statement object.
Inheritance Hierarchy| Object | |
 | GroupBy |