Class DataProviderFilter

Namespace

BiExcellence.OpenBi.Api.DataProviders

Assembly

BiExcellence.OpenBi.Api.Client.dll

One condition on a dimension value or a key figure: a single value, an interval or a text match.

public sealed class DataProviderFilter

Inheritance

object

DataProviderFilter

Constructors

DataProviderFilter()

Creates an empty filter.

public DataProviderFilter()

DataProviderFilter(DataProviderFilter)

Creates a copy.

public DataProviderFilter(DataProviderFilter filter)

Parameters

filter DataProviderFilter

DataProviderFilter(string?, DataProviderFilterOperator, DataProviderFilterSign)

Creates a filter on a single value.

public DataProviderFilter(string? low, DataProviderFilterOperator filterOperator = DataProviderFilterOperator.Equal, DataProviderFilterSign sign = DataProviderFilterSign.Include)

Parameters

low string

filterOperator DataProviderFilterOperator

sign DataProviderFilterSign

DataProviderFilter(string?, string?, DataProviderFilterOperator, DataProviderFilterSign)

Creates a filter on an interval.

public DataProviderFilter(string? low, string? high, DataProviderFilterOperator filterOperator = DataProviderFilterOperator.Between, DataProviderFilterSign sign = DataProviderFilterSign.Include)

Parameters

low string

high string

filterOperator DataProviderFilterOperator

sign DataProviderFilterSign

Properties

High

The upper bound of an interval.

[JsonPropertyName("high")]
public string? High { get; set; }

Property Value

string

HighText

The display text of High, where the source delivered one.

[JsonPropertyName("highText")]
public string? HighText { get; set; }

Property Value

string

Low

The value, or the lower bound of an interval.

[JsonPropertyName("low")]
public string? Low { get; set; }

Property Value

string

LowText

The display text of Low, where the source delivered one.

[JsonPropertyName("lowText")]
public string? LowText { get; set; }

Property Value

string

Operator

The comparison. Defaults to Equal where it is not stated.

[JsonPropertyName("operator")]
public DataProviderFilterOperator? Operator { get; set; }

Property Value

DataProviderFilterOperator?

Sign

Whether what is matched is kept or dropped.

[JsonPropertyName("sign")]
public DataProviderFilterSign Sign { get; set; }

Property Value

DataProviderFilterSign