Package de.espirit.firstspirit.client.plugin.dataaccess.aspects

Interface Filterable

public interface Filterable
Aspect providing means to filter a data stream via parameterization.
Since:
5.2.19

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final StreamBuilderAspectType<Filterable>
    TYPE
    Aspect providing means to filter a data stream via parameterization.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull List<Parameter<?>>
    getDefinedParameters()
    Returns a list of parameter definitions supported by the data stream, used to enable interactive filter configuration.
    void
    setFilter(@NotNull ParameterMap filter)
    Sets the filter to be used for the resulting stream.

  • Field Details

  • Method Details

    • getDefinedParameters

      @NotNull @NotNull List<Parameter<?>> getDefinedParameters()
      Returns a list of parameter definitions supported by the data stream, used to enable interactive filter configuration.
      Returns:
      A Parameter list.
      Since:
      5.2.19
      See Also:

    • setFilter

      void setFilter(@NotNull @NotNull ParameterMap filter)
      Sets the filter to be used for the resulting stream. The filter is defined by mapping the defined parameters to specific values.
      Parameters:
      filter - The filter.
      Since:
      5.2.19