Interface NumericEqualityFilter.Builder

    • Method Detail

      • filterId

        NumericEqualityFilter.Builder filterId​(String filterId)

        An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

        Parameters:
        filterId - An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • column

        NumericEqualityFilter.Builder column​(ColumnIdentifier column)

        The column that the filter is applied to.

        Parameters:
        column - The column that the filter is applied to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • value

        NumericEqualityFilter.Builder value​(Double value)

        The input value.

        Parameters:
        value - The input value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • selectAllOptions

        NumericEqualityFilter.Builder selectAllOptions​(String selectAllOptions)

        Select all of the values. Null is not the assigned value of select all.

        • FILTER_ALL_VALUES

        Parameters:
        selectAllOptions - Select all of the values. Null is not the assigned value of select all.

        • FILTER_ALL_VALUES

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NumericFilterSelectAllOptions, NumericFilterSelectAllOptions
      • aggregationFunction

        NumericEqualityFilter.Builder aggregationFunction​(AggregationFunction aggregationFunction)

        The aggregation function of the filter.

        Parameters:
        aggregationFunction - The aggregation function of the filter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • parameterName

        NumericEqualityFilter.Builder parameterName​(String parameterName)

        The parameter whose value should be used for the filter value.

        Parameters:
        parameterName - The parameter whose value should be used for the filter value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • nullOption

        NumericEqualityFilter.Builder nullOption​(String nullOption)

        This option determines how null values should be treated when filtering data.

        • ALL_VALUES: Include null values in filtered results.

        • NULLS_ONLY: Only include null values in filtered results.

        • NON_NULLS_ONLY: Exclude null values from filtered results.

        Parameters:
        nullOption - This option determines how null values should be treated when filtering data.

        • ALL_VALUES: Include null values in filtered results.

        • NULLS_ONLY: Only include null values in filtered results.

        • NON_NULLS_ONLY: Exclude null values from filtered results.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FilterNullOption, FilterNullOption
      • nullOption

        NumericEqualityFilter.Builder nullOption​(FilterNullOption nullOption)

        This option determines how null values should be treated when filtering data.

        • ALL_VALUES: Include null values in filtered results.

        • NULLS_ONLY: Only include null values in filtered results.

        • NON_NULLS_ONLY: Exclude null values from filtered results.

        Parameters:
        nullOption - This option determines how null values should be treated when filtering data.

        • ALL_VALUES: Include null values in filtered results.

        • NULLS_ONLY: Only include null values in filtered results.

        • NON_NULLS_ONLY: Exclude null values from filtered results.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FilterNullOption, FilterNullOption