Class FilterDescriptor

Inheritance
object
BaseEntity
FilterDescriptor
Implements
Inherited Members
Namespace: LemonEdge.API.Entities.Reporting
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class FilterDescriptor : BaseEntity, IFilterDescriptor, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IFilterDescriptor>, ISetItemUpdater

Constructors

FilterDescriptor()

Declaration
public FilterDescriptor()

Properties

BindedAggregate

Declaration
[EnumDataType(typeof(AggregateFunction))]
public AggregateFunction BindedAggregate { get; set; }
Property Value
Type Description
AggregateFunction

BindedAggregate_Tooltip

Declaration
[NotMapped]
public string BindedAggregate_Tooltip { get; set; }
Property Value
Type Description
string

BindedValue

The parameter/property to bind the propertyname to using the operator.

Declaration
[StringLength(500)]
public string BindedValue { get; set; }
Property Value
Type Description
string

CompositeLogicalOperator

Indicates if this is an actual comparison filter, or a logical composite operator that has children filters. Can be:

  • None: Indicates this is an actual where filter.It is logically applied to other filters according to its direct parent composite operator. If it does not have one then all top level filters use And to compare to each other.
  • And: Indicates all child where filters should have And as a logical operator applied to them.

    No other properties need be set for this where filter if it has a composite operator value.

  • Or: Indicates all child where filters should have Or as a logical operator applied to them.

    No other properties need be set for this where filter if it has a composite operator value.

Declaration
[EnumDataType(typeof(FilterLogicalCompositeOperator))]
public FilterLogicalCompositeOperator CompositeLogicalOperator { get; set; }
Property Value
Type Description
FilterLogicalCompositeOperator

CompositeLogicalOperator_Tooltip

Declaration
[NotMapped]
public string CompositeLogicalOperator_Tooltip { get; set; }
Property Value
Type Description
string

DataSetQueryableItemID

[Key] Links to IDataSetQueryableItem. The parent dataset queryable item this filter belongs to.

Declaration
public Guid? DataSetQueryableItemID { get; set; }
Property Value
Type Description
Guid?

DataSetQueryableItemID_Label

Declaration
public string DataSetQueryableItemID_Label { get; set; }
Property Value
Type Description
string

DataSetQueryableItemID_Label_Silent

Declaration
[NotMapped]
public string DataSetQueryableItemID_Label_Silent { get; set; }
Property Value
Type Description
string

DatasetID

[Key] Links to IDataset. The parent dataset this filter belongs to.

Declaration
public Guid? DatasetID { get; set; }
Property Value
Type Description
Guid?

DatasetID_Label

Declaration
public string DatasetID_Label { get; set; }
Property Value
Type Description
string

DatasetID_Label_Silent

Declaration
[NotMapped]
public string DatasetID_Label_Silent { get; set; }
Property Value
Type Description
string

FilterFromJoin

Indicates this where filter should be applied in the actual Join of the Queryable Item instead of on the where clause for performance

Declaration
public bool FilterFromJoin { get; set; }
Property Value
Type Description
bool

HardcodedValue

A hardcoded value to compare the Queryable Item Property to using the comparison Operator.

Declaration
[StringLength(500)]
public string HardcodedValue { get; set; }
Property Value
Type Description
string

HardcodedValue_Label

A hardcoded value label for user evaluation of this filter.

Declaration
[StringLength(500)]
public string HardcodedValue_Label { get; set; }
Property Value
Type Description
string

Label

The system generated label of this filter

Declaration
[Required]
[StringLength(500)]
public string Label { get; set; }
Property Value
Type Description
string

Operator

The operator of this filter action.

Declaration
[EnumDataType(typeof(SQLOperator))]
public SQLOperator Operator { get; set; }
Property Value
Type Description
SQLOperator

Operator_Tooltip

Declaration
[NotMapped]
public string Operator_Tooltip { get; set; }
Property Value
Type Description
string

ParentID

Lins to IFilterDescriptor. Holds the parent filter this is a child of if part of a heirarchical filter

Declaration
public Guid? ParentID { get; set; }
Property Value
Type Description
Guid?

ParentID_Label

Declaration
public string ParentID_Label { get; set; }
Property Value
Type Description
string

ParentID_Label_Silent

Declaration
[NotMapped]
public string ParentID_Label_Silent { get; set; }
Property Value
Type Description
string

PropertyAggregate

Declaration
[EnumDataType(typeof(AggregateFunction))]
public AggregateFunction PropertyAggregate { get; set; }
Property Value
Type Description
AggregateFunction

PropertyAggregate_Tooltip

Declaration
[NotMapped]
public string PropertyAggregate_Tooltip { get; set; }
Property Value
Type Description
string

PropertyName

The property name being filtered.

Declaration
[StringLength(500)]
public string PropertyName { get; set; }
Property Value
Type Description
string

Sequence

Holds the order of this descriptor item in the set

Declaration
public short Sequence { get; set; }
Property Value
Type Description
short

VennSetID

[Key] Links to IVennSet. The parent dataset this filter belongs to.

Declaration
public Guid? VennSetID { get; set; }
Property Value
Type Description
Guid?

VennSetID_Label

Declaration
public string VennSetID_Label { get; set; }
Property Value
Type Description
string

VennSetID_Label_Silent

Declaration
[NotMapped]
public string VennSetID_Label_Silent { get; set; }
Property Value
Type Description
string

VennSetQueryableItemID

[Key] Links to IVennSetQueryableItem. The parent vennset queryable item this filter belongs to.

Declaration
public Guid? VennSetQueryableItemID { get; set; }
Property Value
Type Description
Guid?

VennSetQueryableItemID_Label

Declaration
public string VennSetQueryableItemID_Label { get; set; }
Property Value
Type Description
string

VennSetQueryableItemID_Label_Silent

Declaration
[NotMapped]
public string VennSetQueryableItemID_Label_Silent { get; set; }
Property Value
Type Description
string

WrapBindingValueInIsNull

Indicates the Source Property of this filter should be wrapped in an IsNull clause to match the specified value if null.

Declaration
public bool WrapBindingValueInIsNull { get; set; }
Property Value
Type Description
bool

Methods

CopyFromEntity(IBaseEntity)

Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Type Name Description
IBaseEntity src
Overrides

CopyFromSource(IFilterDescriptor)

Updates all properties in this item to have the same properties as the source object.

Declaration
public void CopyFromSource(IFilterDescriptor source)
Parameters
Type Name Description
IFilterDescriptor source

The source object to copy all values from.

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

UpdateAllIDs(Func<Type, Guid, Guid>)

Allows this item to update its ids through calling a function that given an original ID will return the new id of that item created while importing all items. If the original id is still the same that will be returned.

Declaration
public void UpdateAllIDs(Func<Type, Guid, Guid> findNewID)
Parameters
Type Name Description
Func<Type, Guid, Guid> findNewID

Implements

Extension Methods