IGroupByCollection Interface |
Interface for the GroupByCollection class which is used to collect EntityField(2) instances which are used for the
GROUP BY clause in a retrieval query. When a group by collection is specified in a retrieval query, all
fields in the resultset have to be in this collection.
Generic
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.8.0.0 (5.8.21.0111)
SyntaxThe IGroupByCollection type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Count |
The amount of items currently stored in the IGroupByCollection
|
| DatabaseSpecificCreator |
Object which will be used to create valid parameter objects, field names, including prefix/postfix characters,
and conversion routines, and field names, including prefix/postfix characters.
Uses the strategy pattern so the generic code can work with more than one target database.
|
| HavingClause |
Gets/sets the predicate expression which forms the having clause for this group by collection.
|
| Item |
Indexer in the collection.
|
| Parameters |
The list of parameters created when the groupby collection was translated to text usable in a query. Only valid after a succesful call to ToQueryText
|
Methods| Name | Description | |
|---|---|---|
 | AddTEntityField |
Adds the passed in entity field instance to the list. Field objects can be added just once.
|
| AddRange |
Adds the range of IEntityFieldCore fields to the groupbycollection.
|
| ContainsTEntityField |
Checks if the field is in the list. Does a value compare, not an object reference compare.
|
| GetEntityFieldCore |
Returns the IEntityFieldCore part of the field at position index
|
| GetEnumerator | Returns an enumerator that iterates through a collection. (Inherited from IEnumerable.) |
| GetFieldPersistenceInfo |
Returns the IFieldPersistenceInfo part of the field at position index
|
| IndexOfTEntityField |
Returns the index of the field specified.
|
| InsertTEntityField |
Inserts the field passed in on index specified.
|
| ReadXml |
Deserializes the object data on the xml reader into this instance
|
| RemoveTEntityField |
Removes the passed in entity field instance. Finds the object to remove using value compare.
|
| RemoveAt |
Removes the entity field instance at index specified from the collection.
|
| ReplaceFieldAtIndex |
Replaces the field at the index specified with the field passed in
|
| SetFieldPersistenceInfo |
Sets the IFieldPersistenceInfo part of the field at position index.
Adapter specific.
|
| ToQueryText |
Retrieves a ready to use text representation for the groupby collection
|
| ToQueryText(Boolean) |
Retrieves a ready to use text representation for the groupby collection.
|
| WriteXml |
Serializes the object as xml to the writer specified.
|
Extension Methods| Name | Description | |
|---|---|---|
 | IsEmpty |
Determines whether the specified groupbycollection is empty. A null passed in is also considered empty.
(Defined by ORMClassExtensions.) |
See Also