Class EntitySchemaAggregationQueryFunction
The aggregate function of the expression.
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
public class EntitySchemaAggregationQueryFunction : EntitySchemaQueryFunction, IMetaItem, IMetaDataSerializable, ICloneable
Constructors
EntitySchemaAggregationQueryFunction(AggregationTypeStrict, EntitySchemaQuery)
Initializes the EntitySchemaAggregationQueryFunction instance of the specified aggregate function type for the specified query to the object schema.
Declaration
public EntitySchemaAggregationQueryFunction(AggregationTypeStrict aggregationType, EntitySchemaQuery parentQuery)
Parameters
Type | Name | Description |
---|---|---|
AggregationTypeStrict | aggregationType | Type of aggregating function. |
EntitySchemaQuery | parentQuery | Query against the schema of the entity that contains the function. |
EntitySchemaAggregationQueryFunction(AggregationTypeStrict, EntitySchemaQueryExpression, EntitySchemaQuery)
Initializes the EntitySchemaAggregationQueryFunction instance for the specified type of aggregate function, expression, and query to the object schema.
Declaration
public EntitySchemaAggregationQueryFunction(AggregationTypeStrict aggregationType, EntitySchemaQueryExpression expression, EntitySchemaQuery parentQuery)
Parameters
Type | Name | Description |
---|---|---|
AggregationTypeStrict | aggregationType | Type of aggregating function. |
EntitySchemaQueryExpression | expression | The query expression. |
EntitySchemaQuery | parentQuery | Query against the schema of the entity that contains the function. |
EntitySchemaAggregationQueryFunction(EntitySchemaAggregationQueryFunction)
Initializes the EntitySchemaAggregationQueryFunction instance that is a clone of the passed-in instance of the expression aggregate function.
Declaration
public EntitySchemaAggregationQueryFunction(EntitySchemaAggregationQueryFunction source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaAggregationQueryFunction | source | Instance of the expression aggregate function whose clone is being created. |
EntitySchemaAggregationQueryFunction(EntitySchemaQuery)
Initializes the EntitySchemaAggregationQueryFunction instance for the specified entity schema query.
Declaration
public EntitySchemaAggregationQueryFunction(EntitySchemaQuery parentQuery)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQuery | parentQuery | Query against the schema of the entity that contains the function. |
Properties
AggregationEvalType
The scope of the aggregate function.
Declaration
public AggregationEvalType AggregationEvalType { get; set; }
Property Value
Type | Description |
---|---|
AggregationEvalType |
AggregationType
Type of aggregating function.
Declaration
public AggregationTypeStrict AggregationType { get; set; }
Property Value
Type | Description |
---|---|
AggregationTypeStrict |
Expression
The expression of the aggregate function argument.
Declaration
public EntitySchemaQueryExpression Expression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
QueryAlias
The alias of the function in the SQL query.
Declaration
public override string QueryAlias { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Methods
All()
Sets the [To All Values] scope for the current aggregate function.
Declaration
public EntitySchemaAggregationQueryFunction All()
Returns
Type | Description |
---|---|
EntitySchemaAggregationQueryFunction | The current EntitySchemaAggregationQueryFunction instance. |
ApplyMetaDataValue(DataReader)
Declaration
protected override void ApplyMetaDataValue(DataReader reader)
Parameters
Type | Name | Description |
---|---|---|
DataReader | reader |
Overrides
Clone()
Creates the clone of the current EntitySchemaAggregationQueryFunction instance.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | The System.Object instance that is a clone of the current function instance. |
Overrides
CreateQueryColumnExpression(DBSecurityEngine)
For the aggregate function, gets the query column expression that is generated taking into account the specified access rights.
Declaration
public override QueryColumnExpression CreateQueryColumnExpression(DBSecurityEngine dbSecurityEngine)
Parameters
Type | Name | Description |
---|---|---|
DBSecurityEngine | dbSecurityEngine | The DBSecurityEngine entity that determines the access rights. |
Returns
Type | Description |
---|---|
QueryColumnExpression | The QueryColumnExpression instance for the expression aggregate function, which is generated taking into account the |
Overrides
Exceptions
Type | Condition |
---|---|
InvalidObjectStateException | If the expression of the function argument is |
Distinct()
Sets the [To Unique Values] scope for the current aggregate function.
Declaration
public EntitySchemaAggregationQueryFunction Distinct()
Returns
Type | Description |
---|---|
EntitySchemaAggregationQueryFunction | The current EntitySchemaAggregationQueryFunction instance. |
GetArguments()
Gets the collection of expressions of the aggregate function arguments.
Declaration
public override EntitySchemaQueryExpressionCollection GetArguments()
Returns
Type | Description |
---|---|
EntitySchemaQueryExpressionCollection | Collection of expressions of the aggregate function arguments. |
Overrides
GetCaption()
Gets the caption of the expression function.
Declaration
public override string GetCaption()
Returns
Type | Description |
---|---|
System.String | String of the aggregate function caption. |
Overrides
GetIsSupportedDataValueType(DataValueType)
Indicates whether the output of the aggregate function has the specified data type.
Declaration
public override bool GetIsSupportedDataValueType(DataValueType dataValueType)
Parameters
Type | Name | Description |
---|---|---|
DataValueType | dataValueType | Data type. |
Returns
Type | Description |
---|---|
System.Boolean |
|
Overrides
Exceptions
Type | Condition |
---|---|
UnsupportedTypeException | If the output of the aggregate function has an unsupported data type. |
GetResultDataValueType(DataValueTypeManager)
Gets the data type of the output returned by the aggregate function, using the specified data type manager.
Declaration
public override DataValueType GetResultDataValueType(DataValueTypeManager dataValueTypeManager)
Parameters
Type | Name | Description |
---|---|---|
DataValueTypeManager | dataValueTypeManager | Data type manager. |
Returns
Type | Description |
---|---|
DataValueType | Data type of the output returned by the aggregate function. |
Overrides
WriteMetaData(DataWriter)
Serializes the aggregate function, using the specified DataWriter instance.
Declaration
public override void WriteMetaData(DataWriter writer)
Parameters
Type | Name | Description |
---|---|---|
DataWriter | writer | The DataWriter instance used for serialization. |