Package io.jmix.flowui.component.genericfilter

Class RunTimeConfigurationBuilder

java.lang.Object

io.jmix.flowui.component.genericfilter.RunTimeConfigurationBuilder

public class RunTimeConfigurationBuilder
extends Object

Fluent builder for RunTimeConfiguration.

Use this builder when you need a dynamic configuration whose filter components can be added or removed at runtime (e.g. via the per-condition remove button).

Encapsulates all required steps:

• Creating and configuring the root GroupFilter
• Adding filter components and recording their default values in the configuration
• Marking all added components as modified so remove buttons appear immediately
• Registering the configuration via GenericFilter.addConfiguration(Configuration)
• Optionally activating the configuration via GenericFilter.setCurrentConfiguration(Configuration)

Obtain an instance via GenericFilter.runtimeConfigurationBuilder():

 filter.runtimeConfigurationBuilder()
       .id("dynamicSearch")
       .name("Dynamic Search")
       .add(nameFilter)
       .add(statusFilter, "NEW")
       .makeCurrent()
       .buildAndRegister();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	RunTimeConfigurationBuilder.ComponentEntry

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowDeletion
protected boolean	built
protected final List<RunTimeConfigurationBuilder.ComponentEntry>	entries
protected final GenericFilter	filter
protected String	id
protected boolean	makeCurrent
protected String	name
protected LogicalFilterComponent.Operation	operation
protected final UiComponents	uiComponents

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RunTimeConfigurationBuilder(GenericFilter filter, UiComponents uiComponents)

Method Summary

Modifier and Type	Method	Description
RunTimeConfigurationBuilder	add(FilterComponent filterComponent)	Adds a filter component using the component's current value (if any) as the default.
<V> RunTimeConfigurationBuilder	add(SingleFilterComponentBase<V> filterComponent, @Nullable V defaultValue)	Adds a filter component, overriding its default value.
RunTimeConfigurationBuilder	addAll(FilterComponent... filterComponents)	Adds several filter components at once, each using its current value (if any) as the default.
RunTimeConfigurationBuilder	allowDeletion()	Allows the user to delete this configuration through the UI.
RunTimeConfigurationBuilder	allowDeletion(boolean allowDeletion)	Controls whether the user can delete this configuration through the UI.
RunTimeConfiguration	buildAndRegister()	Builds the RunTimeConfiguration, registers it with the filter, and optionally activates it.
RunTimeConfigurationBuilder	id(String id)	Sets the configuration id.
RunTimeConfigurationBuilder	makeCurrent()	Makes this configuration the current (active) one immediately after it is registered.
RunTimeConfigurationBuilder	name(@Nullable String name)	Sets the configuration display name.
RunTimeConfigurationBuilder	operation(LogicalFilterComponent.Operation operation)	Sets the logical operation of the root filter component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

filter

protected final GenericFilter filter

uiComponents

protected final UiComponents uiComponents

id

protected String id

name

protected String name

operation

protected LogicalFilterComponent.Operation operation

makeCurrent

protected boolean makeCurrent

allowDeletion

protected boolean allowDeletion

built

protected boolean built

entries

protected final List<RunTimeConfigurationBuilder.ComponentEntry> entries

Constructor Details

RunTimeConfigurationBuilder

protected RunTimeConfigurationBuilder(GenericFilter filter,
 UiComponents uiComponents)

Method Details

id

public RunTimeConfigurationBuilder id(String id)

Sets the configuration id. Required.

Parameters:

id - unique configuration identifier within this filter

name

public RunTimeConfigurationBuilder name(@Nullable String name)

Sets the configuration display name.

Parameters:

name - display name shown in the configuration selector

operation

public RunTimeConfigurationBuilder operation(LogicalFilterComponent.Operation operation)

Sets the logical operation of the root filter component. Defaults to AND.

Parameters:

operation - logical operation

add

public RunTimeConfigurationBuilder add(FilterComponent filterComponent)

Adds a filter component using the component's current value (if any) as the default.

Parameters:

filterComponent - filter component to add

addAll

public RunTimeConfigurationBuilder addAll(FilterComponent... filterComponents)

Adds several filter components at once, each using its current value (if any) as the default.

Parameters:

filterComponents - filter components to add

add

public <V> RunTimeConfigurationBuilder add(SingleFilterComponentBase<V> filterComponent,
 @Nullable V defaultValue)

Adds a filter component, overriding its default value.

The type parameter V ensures the defaultValue matches the component's own value type at compile time.

Type Parameters:

V - the value type of the filter component

Parameters:

filterComponent - filter component to add

defaultValue - value to apply and record as the configuration default

makeCurrent

public RunTimeConfigurationBuilder makeCurrent()

Makes this configuration the current (active) one immediately after it is registered.

This is not the persistent default configuration marker (set via the genericFilter_makeDefault action and stored per user): it simply activates this configuration now, equivalent to GenericFilter.setCurrentConfiguration(Configuration).

allowDeletion

public RunTimeConfigurationBuilder allowDeletion(boolean allowDeletion)

Controls whether the user can delete this configuration through the UI.

By default, configurations created via this builder are protected from user deletion (RunTimeConfiguration.setProtectedFromUserDeletion(boolean)).

Parameters:

allowDeletion - true to allow the user to remove the configuration, false (default) to protect it

allowDeletion

public RunTimeConfigurationBuilder allowDeletion()

Allows the user to delete this configuration through the UI. Convenience alias for allowDeletion(true).

buildAndRegister

public RunTimeConfiguration buildAndRegister()

Builds the RunTimeConfiguration, registers it with the filter, and optionally activates it.

Automatically:

• Creates the root GroupFilter with setConditionModificationDelegated(true) and setDataLoader(filter.getDataLoader())
• Adds each filter component to the root
• Calls setFilterComponentDefaultValue for every component with a value
• Registers the configuration via GenericFilter.addConfiguration(Configuration), and activates it via GenericFilter.setCurrentConfiguration(Configuration) if makeCurrent() was requested

Returns:

the newly created and registered RunTimeConfiguration

Throws:

IllegalStateException - if this builder instance has already been used, if id was not set, if a configuration with the same id is already registered in the filter, or if the filter has no DataLoader