Click or drag to resize

GroupByCollection Class

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
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ORMSupportClassesGroupByCollection

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.5.0.0 (5.5.18.1019)
Syntax
[SerializableAttribute]
public class GroupByCollection : IGroupByCollection, 
	IEnumerable, IEnumerable<IEntityFieldCore>, IXmlSerializable

The GroupByCollection type exposes the following members.

Constructors
Properties
  NameDescription
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 Predicate was translated to text usable in a query. Only valid after a succesful call to ToQueryText
Top
Methods
  NameDescription
Public methodAddTEntityField
Adds the passed in entity field instance to the list. entity fields can be added just once. If the field is already in the collection, the index of the field in the list is returned.
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 methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEntityFieldCore
Returns the IEntityFieldCore part of the field at position index
Public methodGetEnumerator
Gets the enumerator.
Public methodGetFieldPersistenceInfo
Returns the IFieldPersistenceInfo part of the field at position index
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOfTEntityField
Gets the index of the specified field in the list.
Public methodInsertTEntityField
Inserts the field passed in on index specified.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveTEntityField
Removes the passed in entity field instance. Finds the object to remove using value compare.
Public methodRemoveAt
Removes the IEntityField(2) 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 methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodInT
Creates a predicate which is true if there's an object of type T in values, which has for each property P a field in fields with the same name / alias and the value for property P is equal to the value of the field equivalent in the main query.
(Defined by InPredicateProducers.)
Public Extension MethodIsEmpty
Determines whether the specified groupbycollection is empty. A null passed in is also considered empty.
(Defined by ORMClassExtensions.)
Public Extension MethodNotInT
Creates a predicate which is true if there's no object of type T in values, which has for each property P a field in fields with the same name / alias and the value for property P is equal to the value of the field equivalent in the main query.
(Defined by InPredicateProducers.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIEnumerableIEntityFieldCoreGetEnumerator
Returns an enumerator that iterates through the collection.
Explicit interface implementationPrivate methodIXmlSerializableGetSchema
This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.
Explicit interface implementationPrivate methodIXmlSerializableReadXml
Generates an object from its XML representation.
Explicit interface implementationPrivate methodIXmlSerializableWriteXml
Converts an object into its XML representation.
Explicit interface implementationPrivate methodIGroupByCollectionReadXml
Deserializes the object data on the xml reader into this instance
Explicit interface implementationPrivate methodIGroupByCollectionWriteXml
Serializes the object as xml to the writer specified.
Top
See Also