Class EntitySchemaQueryFilter
Represents the filter of the entity schema query.
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
public class EntitySchemaQueryFilter : MetaItem, IMetaItem, IEntitySchemaQueryFilterItem, ICloneable, IMetaDataSerializable
Constructors
EntitySchemaQueryFilter()
Initializes the EntitySchemaQueryFilter instance.
Declaration
public EntitySchemaQueryFilter()
EntitySchemaQueryFilter(EntitySchemaQueryFilter)
Initializes the EntitySchemaQueryFilter instance that is a clone of the passed-in filter.
Declaration
public EntitySchemaQueryFilter(EntitySchemaQueryFilter source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryFilter | source | The EntitySchemaQueryFilter filter instance whose clone is being created. |
EntitySchemaQueryFilter(FilterComparisonType)
Initializes the EntitySchemaQueryFilter instance with the specified comparison type.
Declaration
public EntitySchemaQueryFilter(FilterComparisonType comparisonType)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | The comparison type in the filter. |
Properties
AggregationType
The aggregate function type in the filter.
Declaration
public FilterAggregationType AggregationType { get; set; }
Property Value
Type | Description |
---|---|
FilterAggregationType |
ComparisonType
The comparison type in the filter.
Declaration
public FilterComparisonType ComparisonType { get; set; }
Property Value
Type | Description |
---|---|
FilterComparisonType |
IsEnabled
Determines whether to use the filter in the resulting sql query.
Declaration
public bool IsEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
LeftExpression
Expression of the left side of the filter condition.
Declaration
public EntitySchemaQueryExpression LeftExpression { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpression |
OptimizeFilterMode
Describes optimize filter mode.
Declaration
public OptimizeFilterMode OptimizeFilterMode { get; }
Property Value
Type | Description |
---|---|
OptimizeFilterMode |
ParentQuery
Query against the schema of the entity that contains the filter.
Declaration
public EntitySchemaQuery ParentQuery { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQuery |
RightExpressions
Expression of the right side of the filter condition.
Declaration
public EntitySchemaQueryExpressionCollection RightExpressions { get; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryExpressionCollection |
TrimDateTimeParameterToDate
Indicates whether to convert filter expressions of the Date/Time type to the Date type.
Declaration
public bool TrimDateTimeParameterToDate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
ApplyMetaDataValue(DataReader)
Declaration
protected override void ApplyMetaDataValue(DataReader reader)
Parameters
Type | Name | Description |
---|---|---|
DataReader | reader |
Overrides
Clone()
Creates the clone of the current EntitySchemaQueryFilter instance.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | The System.Object instance that is a clone of the current filter instance. |
Overrides
CreateQueryCondition(DBSecurityEngine)
Creates query condition for the filter with the defined access rights.
Declaration
public QueryCondition CreateQueryCondition(DBSecurityEngine dbSecurityEngine)
Parameters
Type | Name | Description |
---|---|---|
DBSecurityEngine | dbSecurityEngine | The instance of the DBSecurityEngine class that defines database access rights to schemas object for current expression. |
Returns
Type | Description |
---|---|
QueryCondition |
SetEnabled(Boolean)
Sets the IsEnabled property to the passed-in value.
Declaration
public EntitySchemaQueryFilter SetEnabled(bool isEnabled)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isEnabled | The value set for the IsEnabled property. |
Returns
Type | Description |
---|---|
EntitySchemaQueryFilter | The current filter instance. |
WriteMetaData(DataWriter)
Serializes the filter, using the passed-in DataWriter instance.
Declaration
public override void WriteMetaData(DataWriter writer)
Parameters
Type | Name | Description |
---|---|---|
DataWriter | writer | The DataWriter instance used for serialization. |
Overrides
Explicit Interface Implementations
IEntitySchemaQueryFilterItem.AddUsingJoinedExpressions(Collection<EntitySchemaQueryExpression>)
Fills the passed-in collection with expressions of filter columns, which are selected from the linked tables.
Declaration
void IEntitySchemaQueryFilterItem.AddUsingJoinedExpressions(Collection<EntitySchemaQueryExpression> expressions)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.ObjectModel.Collection<EntitySchemaQueryExpression> | expressions | Collection of column expressions. |
IEntitySchemaQueryFilterItem.GetFilterInstances()
Gets an enumeration of the filter instances.
Declaration
IEnumerable<EntitySchemaQueryFilter> IEntitySchemaQueryFilterItem.GetFilterInstances()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntitySchemaQueryFilter> | Enumerator of filter instances. |