Package io.jmix.flowui.component.factory

Class ItemsFetchCallbackSupport

java.lang.Object

io.jmix.flowui.component.factory.ItemsFetchCallbackSupport

@Component("flowui_ItemsFetchCallbackSupport")
public class ItemsFetchCallbackSupport
extends Object

Creates items fetch callbacks that load entities or scalar values through DataManager with offset/limit paging, either from a JPQL query with a :searchString parameter or from a Condition built for each search string.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DataManager	dataManager
protected final MetadataTools	metadataTools
protected static final String	SEARCH_STRING_PARAMETER
protected final StringSubstitutor	stringSubstitutor
protected static final String	VALUE_PARAMETER

Constructor Summary

Constructors

Constructor	Description
ItemsFetchCallbackSupport(DataManager dataManager, StringSubstitutor stringSubstitutor, MetadataTools metadataTools)

Method Summary

Modifier and Type	Method	Description
Condition	buildInstanceNameCondition(List<String> searchProperties, String searchString)	Builds a case-insensitive substring-match condition over the given search properties, combined with "or" if there are several.
<E> SupportsItemsFetchCallback.FetchCallback<E,String>	createEntityFetchCallback(Class<E> entityClass, String queryString, @Nullable String searchStringFormat, boolean escapeValueForLike, @Nullable FetchPlan fetchPlan)
<E> SupportsItemsFetchCallback.FetchCallback<E,String>	createEntityFetchCallback(Class<E> entityClass, Function<String,Condition> conditionBuilder, @Nullable Sort sort, @Nullable FetchPlan fetchPlan)
SupportsItemsFetchCallback.FetchCallback<Object,String>	createValuesFetchCallback(String queryString, @Nullable String searchStringFormat, boolean escapeValueForLike)
List<Sort.Order>	getInstanceNameSortOrders(MetaClass metaClass)	Returns ascending sort orders over the non-class instance-name-related properties.
protected String	getSearchString(com.vaadin.flow.data.provider.Query<?,String> query, @Nullable String searchStringFormat, boolean escapeValue)
List<String>	resolveInstanceNameSearchProperties(MetaClass metaClass)	Returns names of string-typed instance-name-related properties of the given metaClass, used as the search properties for a byInstanceName condition.

Methods inherited from class java.lang.Object

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

Field Details

VALUE_PARAMETER

protected static final String VALUE_PARAMETER

See Also:

• Constant Field Values

SEARCH_STRING_PARAMETER

protected static final String SEARCH_STRING_PARAMETER

See Also:

• Constant Field Values

dataManager

protected final DataManager dataManager

stringSubstitutor

protected final StringSubstitutor stringSubstitutor

metadataTools

protected final MetadataTools metadataTools

Constructor Details

ItemsFetchCallbackSupport

public ItemsFetchCallbackSupport(DataManager dataManager,
 StringSubstitutor stringSubstitutor,
 MetadataTools metadataTools)

Method Details

createEntityFetchCallback

public <E>
SupportsItemsFetchCallback.FetchCallback<E,String> createEntityFetchCallback(Class<E> entityClass,
 String queryString,
 @Nullable String searchStringFormat,
 boolean escapeValueForLike,
 @Nullable FetchPlan fetchPlan)

createEntityFetchCallback

public <E>
SupportsItemsFetchCallback.FetchCallback<E,String> createEntityFetchCallback(Class<E> entityClass,
 Function<String,Condition> conditionBuilder,
 @Nullable Sort sort,
 @Nullable FetchPlan fetchPlan)

createValuesFetchCallback

public SupportsItemsFetchCallback.FetchCallback<Object,String> createValuesFetchCallback(String queryString,
 @Nullable String searchStringFormat,
 boolean escapeValueForLike)

getSearchString

protected String getSearchString(com.vaadin.flow.data.provider.Query<?,String> query,
 @Nullable String searchStringFormat,
 boolean escapeValue)

resolveInstanceNameSearchProperties

public List<String> resolveInstanceNameSearchProperties(MetaClass metaClass)

Returns names of string-typed instance-name-related properties of the given metaClass, used as the search properties for a byInstanceName condition.

buildInstanceNameCondition

public Condition buildInstanceNameCondition(List<String> searchProperties,
 String searchString)

Builds a case-insensitive substring-match condition over the given search properties, combined with "or" if there are several.

getInstanceNameSortOrders

public List<Sort.Order> getInstanceNameSortOrders(MetaClass metaClass)

Returns ascending sort orders over the non-class instance-name-related properties.