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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	GenericFilterUrlQueryParametersBinder.InitialState	A POJO class for storing configuration of 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 GenericFilter	filter
protected com.vaadin.flow.shared.Registration	filterComponentsChangeRegistration
protected FilterUrlQueryParametersSupport	filterUrlQueryParametersSupport
protected GenericFilterUrlQueryParametersBinder.InitialState	initialState
protected MetadataTools	metadataTools
static final String	NAME
static final String	PROPERTY_CONDITION_PREFIX
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 List<FilterComponent>	deserializeConditions(List<String> conditionParams, DataLoader dataLoader)
protected String	deserializeConfigurationId(String configurationParam)
protected com.vaadin.flow.component.HasValueAndElement<?,?>	generatePropertyFilterValueComponent(PropertyFilter<?> propertyFilter)
com.vaadin.flow.component.Component	getComponent()
String	getConditionParam()
String	getConfigurationParam()
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 FilterComponent	parseCondition(String conditionString, DataLoader dataLoader)
protected PropertyFilter<?>	parsePropertyCondition(String conditionString, DataLoader dataLoader)
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()
void	setConditionParam(String conditionParam)
void	setConfigurationParam(String conditionParam)
protected void	unbindFilterComponentsChange()
protected void	updateConfigurationConditions(Configuration currentConfiguration, List<String> conditionParams)
protected FilterComponent	updateFilterComponent(FilterComponent configurationComponent, FilterComponent filterComponent)
protected 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, 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

singleFilterSupport

protected SingleFilterSupport singleFilterSupport

metadataTools

protected MetadataTools metadataTools

filterUrlQueryParametersSupport

protected FilterUrlQueryParametersSupport filterUrlQueryParametersSupport

accessManager

protected AccessManager accessManager

filterComponentsChangeRegistration

protected com.vaadin.flow.shared.Registration filterComponentsChangeRegistration

initialState

protected GenericFilterUrlQueryParametersBinder.InitialState initialState

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

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()

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

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

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

updatePropertyCondition

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

parseCondition

protected FilterComponent parseCondition(String conditionString,
 DataLoader dataLoader)

parsePropertyCondition

protected 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()

getConditionParam

public String getConditionParam()

setConfigurationParam

public void setConfigurationParam(@Nullable
 String conditionParam)

setConditionParam

public void setConditionParam(@Nullable
 String conditionParam)

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

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

Specified by:

getComponent in class AbstractUrlQueryParametersBinder