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.3.0.0 (5.3.0)

Syntax

Copy

[SerializableAttribute]
public class GroupByCollection : IGroupByCollection, 
	IEnumerable, IEnumerable<IEntityFieldCore>, IXmlSerializable

<SerializableAttribute>
Public Class GroupByCollection
	Implements IGroupByCollection, IEnumerable, IEnumerable(Of IEntityFieldCore), 
	IXmlSerializable

The GroupByCollection type exposes the following members.

Constructors

	Name	Description
	GroupByCollection	CTor
	GroupByCollection(IEntityFieldCore)	Initializes a new instance of the GroupByCollection class.

Top

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 Predicate was translated to text usable in a query. Only valid after a succesful call to ToQueryText

Top

Methods

	Name	Description
	AddTEntityField	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.
	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.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEntityFieldCore	Returns the IEntityFieldCore part of the field at position index
	GetEnumerator	Gets the enumerator.
	GetFieldPersistenceInfo	Returns the IFieldPersistenceInfo part of the field at position index
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOfTEntityField	Gets the index of the specified field in the list.
	InsertTEntityField	Inserts the field passed in on index specified.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveTEntityField	Removes the passed in entity field instance. Finds the object to remove using value compare.
	RemoveAt	Removes the IEntityField(2) 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.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	InT	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.)
	IsEmpty	Determines whether the specified groupbycollection is empty. A null passed in is also considered empty. (Defined by ORMClassExtensions.)
	NotInT	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

	Name	Description
	IEnumerableIEntityFieldCoreGetEnumerator	Returns an enumerator that iterates through the collection.
	IXmlSerializableGetSchema	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.
	IXmlSerializableReadXml	Generates an object from its XML representation.
	IXmlSerializableWriteXml	Converts an object into its XML representation.
	IGroupByCollectionReadXml	Deserializes the object data on the xml reader into this instance
	IGroupByCollectionWriteXml	Serializes the object as xml to the writer specified.

Top

Reference

SD.LLBLGen.Pro.ORMSupportClasses Namespace