AggregatedColumn Class

Aggregated query column e.g. "AVG(XYZ) AS Average"

Inheritance Hierarchy

System.Object
  CMS.Base.DisposableObject
    CMS.DataEngine.AbstractQueryObject
      CMS.DataEngine.QueryParametersBase<AggregatedColumn>
        CMS.DataEngine.QueryColumnBase<AggregatedColumn>
          CMS.DataEngine.SelectQueryColumnBase<AggregatedColumn>
            CMS.DataEngine.AggregatedColumn
              CMS.DataEngine.CountColumn

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0

Syntax

public class AggregatedColumn : SelectQueryColumnBase<AggregatedColumn>

The AggregatedColumn type exposes the following members.

Constructors

	Name	Description
Public method	AggregatedColumn()	Constructor
Public method	AggregatedColumn(AggregationType, String)	Constructor

Fields

	Name	Description
Protected field	mParameters	Query data parameters (Inherited from QueryParametersBase<TParent>.)

Properties

	Name	Description
Public property	AggregationType	Aggregation type
Public property	ColumnAlias	Column alias (Inherited from SelectQueryColumnBase<TColumn>.)
Protected property	EnsureBracketsForAlias	If true, brackets for the column alias are ensured (Inherited from SelectQueryColumnBase<TColumn>.)
Public property	Expression	Expression (column name) (Inherited from QueryColumnBase<TColumn>.)
Protected property	IsImmutable	If true, this object instance is immutable, and next subsequent modification starts with a clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public property	IsSingleColumn	Returns true if this column represents a single column (Overrides QueryColumnBase<TColumn>.IsSingleColumn.)
Public property	Name	Gets the column name (Inherited from SelectQueryColumnBase<TColumn>.)
Public property	Over	Over clause for the aggregation. When null, over clause is not generated at all, otherwise it is generated even when value is an empty string, in such case " OVER ()" is generated
Public property	Parameters	Query data parameters (Inherited from QueryParametersBase<TParent>.)
Protected property	TypedThis	Returns specifically typed current instance (Inherited from QueryColumnBase<TColumn>.)

Methods

	Name	Description
Protected method	ApplyAggregation	Applies the aggregation to the given expression
Protected method	ApplyOver	Applies the over clause to the given expression
Public method	ApplyParametersTo	Applies this where condition to the target object (Inherited from QueryParametersBase<TParent>.)
Public method	As	Sets the alias to the column (Inherited from SelectQueryColumnBase<TColumn>.)
Public method	AsAlias	Returns the new column created from this column alias (Inherited from QueryColumnBase<TColumn>.)
Public method	AsValue	Gets a query expression representing this object as a value (Inherited from QueryColumnBase<TColumn>.)
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from DisposableObject.)
Public method	Changed	Marks the object as changed (Inherited from AbstractQueryObject.)
Public method	Clone	Creates the clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	CloneObject	Creates the clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	CopyPropertiesTo	Copies all the object properties to the given target class (Inherited from QueryParametersBase<TParent>.)
Public method	Dispose	Make sure the objects get disposed (Inherited from DisposableObject.)
Public method	EnsureParameters	Ensures data parameters for the given query (Inherited from QueryParametersBase<TParent>.)
Public method	Expand	Expands the expression by replacing parameters with their values (Inherited from QueryParametersBase<TParent>.)
Public method	GetExpression	Gets the expression for the column data (Inherited from SelectQueryColumnBase<TColumn>.)
Public method	GetTypedQuery	Returns specifically typed instance of current Query object to allow user to compose Query in fluent syntax. If current Query is immutable then its clone is returned. (Inherited from QueryParametersBase<TParent>.)
Protected method	GetValueExpression	Gets the column expression (Overrides SelectQueryColumnBase<TColumn>.GetValueExpression().)
Public method	Immutable	Makes this object instance is immutable, and next subsequent modification starts with a clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from QueryParametersBase<TParent>.)
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from DisposableObject.)
Public method	Reset	Flushes the results but leaves the generated query text unchanged. After the reset, query can be executed again to obtain new data. (Inherited from AbstractQueryObject.)
Public method	Snapshot	Creates an immutable snapshot of the current query as a base for further evaluation. Doesn't modify the original query in any way. (Inherited from QueryParametersBase<TParent>.)
Public method	ToString()	Returns the string representation of the expression (Inherited from QueryParametersBase<TParent>.)
Public method	ToString(Boolean)	Returns the string representation of the expression, with possibility of expanding parameters (Inherited from QueryColumnBase<TColumn>.)
Public method	Using	Adds the given object to the list of the allocated objects to dispose (Inherited from DisposableObject.)
Public method	WithExpression	Sets the expression (Inherited from QueryColumnBase<TColumn>.)