Filter Filter Class

Describes a filter expression that is evaluated against a BrokeredMessage.

Syntax

Declaration

[DataContract(Name = "Filter", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
[KnownType(typeof (SqlFilter))]
[KnownType(typeof (TrueFilter))]
[KnownType(typeof (FalseFilter))]
[KnownType(typeof (CorrelationFilter))]
[KnownType(typeof (DateTimeOffset))]
public abstract class Filter : IExtensibleDataObject<DataContract(Name:="Filter", Namespace:="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>
<KnownType(GetType(SqlFilter))>
<KnownType(GetType(TrueFilter))>
<KnownType(GetType(FalseFilter))>
<KnownType(GetType(CorrelationFilter))>
<KnownType(GetType(DateTimeOffset))>
Public MustInherit Class Filter
    Implements IExtensibleDataObject

Inheritance Hierarchy

Properties summary

Gets a value indicating whether the filter expression requires preprocessing.

Methods summary

Matches the BrokeredMessage against the FilterExpression.

Preprocesses the filter expression and returns a preprocessed FilterExpression.

Validates the FilterExpression and make sure it complies with the valid grammar rules.

Explicit Interface Implementations summary

Properties

  • RequiresPreprocessing
    RequiresPreprocessing

    Gets a value indicating whether the filter expression requires preprocessing.

    public abstract bool RequiresPreprocessing { get; }Public MustOverride ReadOnly Property RequiresPreprocessing As Boolean

    Property Value

    • true if the filter expression requires preprocessing; otherwise, false.

Methods

  • Match(BrokeredMessage)
    Match(BrokeredMessage)

    Matches the BrokeredMessage against the FilterExpression.

    public abstract bool Match(BrokeredMessage message)Public MustOverride Function Match(message As BrokeredMessage) As Boolean

    Parameters

    Returns

    • true if the BrokeredMessage matches the filtering expression; otherwise, false.

    Exceptions

  • Preprocess()
    Preprocess()

    Preprocesses the filter expression and returns a preprocessed FilterExpression.

    public abstract Filter Preprocess()Public MustOverride Function Preprocess As Filter

    Returns

    Exceptions

  • Validate()
    Validate()

    Validates the FilterExpression and make sure it complies with the valid grammar rules.

    public abstract void Validate()Public MustOverride Sub Validate

    Exceptions

    • The filter statement is invalid or is potentially complex enough to consume too much computing power when evaluating the statement.

Explicit Interface Implementations

  • IExtensibleDataObject.ExtensionData
    System.Runtime.Serialization.IExtensibleDataObject.ExtensionData
    ExtensionDataObject IExtensibleDataObject.ExtensionData { get; set; }ReadOnly WriteOnly Property System.Runtime.Serialization.IExtensibleDataObject.ExtensionData As ExtensionDataObject Implements IExtensibleDataObject.ExtensionData

    Returns

Details

Assembly

Microsoft.ServiceBus.dll