Click or drag to resize
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.3.0)
public interface IGroupByCollection : IEnumerable

The IGroupByCollection type exposes the following members.

Public propertyCount
The amount of items currently stored in the IGroupByCollection
Public propertyDatabaseSpecificCreator
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.
Public propertyHavingClause
Gets/sets the predicate expression which forms the having clause for this group by collection.
Public propertyItem
Indexer in the collection.
Public propertyParameters
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
Public methodAddTEntityField
Adds the passed in entity field instance to the list. Field objects can be added just once.
Public methodAddRange
Adds the range of IEntityFieldCore fields to the groupbycollection.
Public methodContainsTEntityField
Checks if the field is in the list. Does a value compare, not an object reference compare.
Public methodGetEntityFieldCore
Returns the IEntityFieldCore part of the field at position index
Public methodGetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from IEnumerable.)
Public methodGetFieldPersistenceInfo
Returns the IFieldPersistenceInfo part of the field at position index
Public methodIndexOfTEntityField
Returns the index of the field specified.
Public methodInsertTEntityField
Inserts the field passed in on index specified.
Public methodReadXml
Deserializes the object data on the xml reader into this instance
Public methodRemoveTEntityField
Removes the passed in entity field instance. Finds the object to remove using value compare.
Public methodRemoveAt
Removes the entity field instance at index specified from the collection.
Public methodReplaceFieldAtIndex
Replaces the field at the index specified with the field passed in
Public methodSetFieldPersistenceInfo
Sets the IFieldPersistenceInfo part of the field at position index. Adapter specific.
Public methodToQueryText
Retrieves a ready to use text representation for the groupby collection
Public methodToQueryText(Boolean)
Retrieves a ready to use text representation for the groupby collection.
Public methodWriteXml
Serializes the object as xml to the writer specified.
Extension Methods
Public Extension MethodIsEmpty
Determines whether the specified groupbycollection is empty. A null passed in is also considered empty.
(Defined by ORMClassExtensions.)
See Also