Package io.jmix.flowui.facet.urlqueryparameters

Class GenericFilterUrlQueryParametersBinder

java.lang.Object

io.jmix.flowui.facet.urlqueryparameters.AbstractUrlQueryParametersBinder

io.jmix.flowui.facet.urlqueryparameters.GenericFilterUrlQueryParametersBinder

All Implemented Interfaces:

HasInitialState, UrlQueryParametersFacet.Binder

public class GenericFilterUrlQueryParametersBinder
extends AbstractUrlQueryParametersBinder
implements HasInitialState

A binder class for managing URL query parameters related to a GenericFilter component. This class facilitates the serialization and deserialization of query parameters, manages component state, and ensures updates based on the URL query parameters or filter configuration changes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	GenericFilterUrlQueryParametersBinder.ComponentNode	A node of the captured configuration structure: a filter component, its initial modified flag, and, for a nested LogicalFilterComponent, its own ordered child nodes.
protected static final record	GenericFilterUrlQueryParametersBinder.InitialState	A POJO class for storing the GenericFilter's initial state.

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessManager	accessManager
protected org.springframework.context.ApplicationContext	applicationContext
protected String	conditionParam
protected String	configurationParam
static final String	DEFAULT_CONDITION_PARAM
static final String	DEFAULT_CONFIGURATION_PARAM
protected Configuration	entryConfiguration
protected GenericFilter	filter
protected com.vaadin.flow.shared.Registration	filterComponentsChangeRegistration
protected FilterUrlQueryParametersSupport	filterUrlQueryParametersSupport
protected final List<GenericFilterUrlQueryParametersBinder.InitialState>	initialStates
protected MetadataTools	metadataTools
static final String	NAME
static final String	PROPERTY_CONDITION_PREFIX
protected SingleFilterComponentStateSupport	singleFilterComponentStateSupport
protected SingleFilterSupport	singleFilterSupport
protected UiComponents	uiComponents
protected UrlParamSerializer	urlParamSerializer

Fields inherited from class io.jmix.flowui.facet.urlqueryparameters.AbstractUrlQueryParametersBinder

id

Constructor Summary

Constructors

Constructor	Description
GenericFilterUrlQueryParametersBinder(GenericFilter filter, UrlParamSerializer urlParamSerializer, org.springframework.context.ApplicationContext applicationContext)

Method Summary

Modifier and Type	Method	Description
void	applyInitialState()	Restores the component to its initial state.
protected void	autowireDependencies()
protected void	bindDataLoaderListener(GenericFilter filter)
protected void	bindFilterComponentsChangeListener(GenericFilter filter)
protected Map<String,Object>	captureInitialDefaultValues(Configuration configuration, LogicalFilterComponent<?> rootLogicalFilterComponent)
protected Map<SingleFilterComponentBase<?>,SingleFilterComponentStateSupport.State>	captureInitialStates(LogicalFilterComponent<?> rootLogicalFilterComponent)
protected List<GenericFilterUrlQueryParametersBinder.ComponentNode>	captureStructure(Configuration configuration, LogicalFilterComponent<?> logicalFilterComponent)
protected List<Configuration>	collectConfigurations()
protected void	collectInitialStates(Collection<FilterComponent> components, Map<SingleFilterComponentBase<?>,SingleFilterComponentStateSupport.State> states)
protected List<FilterComponent>	deserializeConditions(List<String> conditionParams, DataLoader dataLoader)
protected String	deserializeConfigurationId(String configurationParam)
protected com.vaadin.flow.component.HasValueAndElement<?,?>	generatePropertyFilterValueComponent(PropertyFilter<?> propertyFilter)
@Nullable com.vaadin.flow.component.Component	getComponent()	Returns the component associated with this binder.
String	getConditionParam()	Returns the current condition parameter name for the URL.
String	getConfigurationParam()	Returns the current configuration parameter name for the URL.
protected MetadataTools	getMetadataTools()
protected SingleFilterSupport	getSingleFilterSupport()
protected void	initComponent(GenericFilter filter)
protected boolean	isOperationMatched(PropertyFilter<?> propertyFilter, PropertyFilter<?> anotherPropertyFilter)
protected boolean	isPermitted(DataLoader dataLoader, FilterComponent filterComponent)
protected boolean	isPropertyMatched(PropertyFilter<?> propertyFilter, PropertyFilter<?> anotherPropertyFilter)
protected void	onConfigurationChanged(GenericFilter.ConfigurationChangeEvent event)
protected void	onFilterComponentsChanged(LogicalFilterComponent.FilterComponentsChangeEvent<?> event)
protected void	onPostLoad(EventObject event)
protected @Nullable FilterComponent	parseCondition(String conditionString, DataLoader dataLoader)
protected @Nullable PropertyFilter<?>	parsePropertyCondition(String conditionString, DataLoader dataLoader)
protected void	restoreInitialDefaultValues(RunTimeConfiguration configuration, GenericFilterUrlQueryParametersBinder.InitialState state)
protected void	restoreInitialStates(GenericFilterUrlQueryParametersBinder.InitialState state)
protected void	restoreStructure(Configuration configuration, LogicalFilterComponent<?> logicalFilterComponent, List<GenericFilterUrlQueryParametersBinder.ComponentNode> structure)
void	saveInitialState()	Saves component's initial state.
protected String	serializeConfigurationId(Configuration configuration)
protected String	serializePropertyCondition(PropertyCondition condition)
com.google.common.collect.ImmutableMap<String,List<String>>	serializeQueryParameters()	Serializes query parameters into an immutable map.
void	setConditionParam(@Nullable String conditionParam)	Sets the condition parameter name for the URL.
void	setConfigurationParam(@Nullable String conditionParam)	Sets the condition parameter name for the URL.
protected void	unbindFilterComponentsChange()
protected void	updateConfigurationConditions(Configuration currentConfiguration, List<String> conditionParams)
protected @Nullable FilterComponent	updateFilterComponent(FilterComponent configurationComponent, FilterComponent filterComponent)
protected @Nullable FilterComponent	updatePropertyCondition(PropertyFilter configurationComponent, PropertyFilter filterComponent)
protected void	updateQueryParameters()
void	updateState(com.vaadin.flow.router.QueryParameters queryParameters)	Informs query parameters binder that view query parameters has been changed.

Methods inherited from class io.jmix.flowui.facet.urlqueryparameters.AbstractUrlQueryParametersBinder

addUrlQueryParametersChangeListener, fireQueryParametersChanged, getEventBus, getId, getOwnerId, setId

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

PROPERTY_CONDITION_PREFIX

public static final String PROPERTY_CONDITION_PREFIX

See Also:

• Constant Field Values

DEFAULT_CONFIGURATION_PARAM

public static final String DEFAULT_CONFIGURATION_PARAM

See Also:

• Constant Field Values

DEFAULT_CONDITION_PARAM

public static final String DEFAULT_CONDITION_PARAM

See Also:

• Constant Field Values

filter

protected GenericFilter filter

configurationParam

protected String configurationParam

conditionParam

protected String conditionParam

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

urlParamSerializer

protected UrlParamSerializer urlParamSerializer

uiComponents

protected UiComponents uiComponents

singleFilterComponentStateSupport

protected SingleFilterComponentStateSupport singleFilterComponentStateSupport

singleFilterSupport

protected SingleFilterSupport singleFilterSupport

metadataTools

protected MetadataTools metadataTools

filterUrlQueryParametersSupport

protected FilterUrlQueryParametersSupport filterUrlQueryParametersSupport

accessManager

protected AccessManager accessManager

filterComponentsChangeRegistration

protected com.vaadin.flow.shared.Registration filterComponentsChangeRegistration

initialStates

protected final List<GenericFilterUrlQueryParametersBinder.InitialState> initialStates

entryConfiguration

protected Configuration entryConfiguration

Constructor Details

GenericFilterUrlQueryParametersBinder

public GenericFilterUrlQueryParametersBinder(GenericFilter filter,
 UrlParamSerializer urlParamSerializer,
 org.springframework.context.ApplicationContext applicationContext)

Method Details

autowireDependencies

protected void autowireDependencies()

initComponent

protected void initComponent(GenericFilter filter)

saveInitialState

public void saveInitialState()

Description copied from interface: HasInitialState

Saves component's initial state.

Specified by:

saveInitialState in interface HasInitialState

collectConfigurations

protected List<Configuration> collectConfigurations()

captureStructure

protected List<GenericFilterUrlQueryParametersBinder.ComponentNode> captureStructure(Configuration configuration,
 LogicalFilterComponent<?> logicalFilterComponent)

captureInitialDefaultValues

protected Map<String,Object> captureInitialDefaultValues(Configuration configuration,
 LogicalFilterComponent<?> rootLogicalFilterComponent)

captureInitialStates

protected Map<SingleFilterComponentBase<?>,SingleFilterComponentStateSupport.State> captureInitialStates(LogicalFilterComponent<?> rootLogicalFilterComponent)

collectInitialStates

protected void collectInitialStates(Collection<FilterComponent> components,
 Map<SingleFilterComponentBase<?>,SingleFilterComponentStateSupport.State> states)

bindDataLoaderListener

protected void bindDataLoaderListener(GenericFilter filter)

onPostLoad

protected void onPostLoad(EventObject event)

onConfigurationChanged

protected void onConfigurationChanged(GenericFilter.ConfigurationChangeEvent event)

onFilterComponentsChanged

protected void onFilterComponentsChanged(LogicalFilterComponent.FilterComponentsChangeEvent<?> event)

updateQueryParameters

protected void updateQueryParameters()

serializeQueryParameters

public com.google.common.collect.ImmutableMap<String,List<String>> serializeQueryParameters()

Serializes query parameters into an immutable map. The method processes the current configuration and its associated conditions to generate query parameters.

Returns:

an immutable map containing serialized query parameters. The keys represent parameter types (e.g., configuration and condition parameters), while the values are lists of their respective serialized representations.

serializeConfigurationId

protected String serializeConfigurationId(Configuration configuration)

serializePropertyCondition

protected String serializePropertyCondition(PropertyCondition condition)

applyInitialState

public void applyInitialState()

Description copied from interface: HasInitialState

Restores the component to its initial state.

Specified by:

applyInitialState in interface HasInitialState

restoreStructure

protected void restoreStructure(Configuration configuration,
 LogicalFilterComponent<?> logicalFilterComponent,
 List<GenericFilterUrlQueryParametersBinder.ComponentNode> structure)

restoreInitialDefaultValues

protected void restoreInitialDefaultValues(RunTimeConfiguration configuration,
 GenericFilterUrlQueryParametersBinder.InitialState state)

restoreInitialStates

protected void restoreInitialStates(GenericFilterUrlQueryParametersBinder.InitialState state)

updateState

public void updateState(com.vaadin.flow.router.QueryParameters queryParameters)

Description copied from interface: UrlQueryParametersFacet.Binder

Informs query parameters binder that view query parameters has been changed.

Specified by:

updateState in interface UrlQueryParametersFacet.Binder

Parameters:

queryParameters - a view query parameters

deserializeConfigurationId

protected String deserializeConfigurationId(String configurationParam)

deserializeConditions

protected List<FilterComponent> deserializeConditions(List<String> conditionParams,
 DataLoader dataLoader)

isPermitted

protected boolean isPermitted(DataLoader dataLoader,
 FilterComponent filterComponent)

updateConfigurationConditions

protected void updateConfigurationConditions(Configuration currentConfiguration,
 List<String> conditionParams)

updateFilterComponent

protected @Nullable FilterComponent updateFilterComponent(FilterComponent configurationComponent,
 FilterComponent filterComponent)

updatePropertyCondition

protected @Nullable FilterComponent updatePropertyCondition(PropertyFilter configurationComponent,
 PropertyFilter filterComponent)

parseCondition

protected @Nullable FilterComponent parseCondition(String conditionString,
 DataLoader dataLoader)

parsePropertyCondition

protected @Nullable PropertyFilter<?> parsePropertyCondition(String conditionString,
 DataLoader dataLoader)

generatePropertyFilterValueComponent

protected com.vaadin.flow.component.HasValueAndElement<?,?> generatePropertyFilterValueComponent(PropertyFilter<?> propertyFilter)

bindFilterComponentsChangeListener

protected void bindFilterComponentsChangeListener(GenericFilter filter)

unbindFilterComponentsChange

protected void unbindFilterComponentsChange()

getConfigurationParam

public String getConfigurationParam()

Returns the current configuration parameter name for the URL. If the parameter is null or empty, a default name is returned.

Returns:

the configuration parameter name if set, otherwise the default configuration parameter name

setConfigurationParam

public void setConfigurationParam(@Nullable String conditionParam)

Sets the condition parameter name for the URL.

Parameters:

conditionParam - the condition parameter name to set

getConditionParam

public String getConditionParam()

Returns the current condition parameter name for the URL. If the condition parameter is null or empty, a default name is returned.

Returns:

the condition parameter name if set, otherwise the default condition parameter name

setConditionParam

public void setConditionParam(@Nullable String conditionParam)

Sets the condition parameter name for the URL.

Parameters:

conditionParam - the condition parameter name to set

isPropertyMatched

protected boolean isPropertyMatched(PropertyFilter<?> propertyFilter,
 PropertyFilter<?> anotherPropertyFilter)

isOperationMatched

protected boolean isOperationMatched(PropertyFilter<?> propertyFilter,
 PropertyFilter<?> anotherPropertyFilter)

getMetadataTools

protected MetadataTools getMetadataTools()

getSingleFilterSupport

protected SingleFilterSupport getSingleFilterSupport()

getComponent

public @Nullable com.vaadin.flow.component.Component getComponent()

Description copied from class: AbstractUrlQueryParametersBinder

Returns the component associated with this binder.

Specified by:

getComponent in class AbstractUrlQueryParametersBinder

Returns:

the component instance if available, or null if no component is associated