Describes data that can be filtered, either a column reference or a literal value. Used this way, the type of a value can be specified so that values which are ambiguous or not well supported in JS will not be confused with Strings or imprecise numbers (e.g., nanosecond-precision date values). Additionally, once wrapped in this way, methods can be called on these value literal instances. These instances are immutable - any method called on them returns a new instance.

Hierarchy

  • FilterValue

Constructors

Methods

  • a filter condition invoking the given method on the current value, with the given parameters. Currently supported functions that can be invoked on a String:

    • startsWith: Returns true if the current string value starts with the supplied string argument
    • endsWith: Returns true if the current string value ends with the supplied string argument
    • matches: Returns true if the current string value matches the supplied string argument used as a Java regular expression
    • contains: Returns true if the current string value contains the supplied string argument

      When invoking against a constant, this should be avoided in favor of FilterValue.contains

    Parameters

    Returns FilterCondition

  • a filter condition checking if the given value matches the provided regular expressions string, ignoring differences of upper vs lower case. Regex patterns use Java regex syntax

    Parameters

    Returns FilterCondition

    FilterCondition

  • Returns string

  • Constructs a boolean for the filter API from the given parameter.

    Parameters

    • b: boolean

    Returns FilterValue

  • Constructs a number for the filter API from the given parameter. Can also be used on the values returned from get for DateTime values. To create a filter with a date, use dh.DateWrapper.ofJsDate or parse. To create a filter with a 64-bit long integer, use ofString.

    Parameters

    • input: number | LongWrapper

      the number to wrap as a FilterValue

    Returns FilterValue

    an immutable FilterValue that can be built into a filter

  • Constructs a string for the filter API from the given parameter.

    Parameters

    • input: any

    Returns FilterValue