Package com.foreach.across.modules.entity.autosuggest

Class InitializingAutoSuggestDataSet

java.lang.Object

com.foreach.across.modules.entity.autosuggest.InitializingAutoSuggestDataSet

All Implemented Interfaces:

AutoSuggestDataSet, AutoSuggestDataSet.ResultTransformer

public class InitializingAutoSuggestDataSet
extends Object
implements AutoSuggestDataSet, AutoSuggestDataSet.ResultTransformer

Implementation of AutoSuggestDataSet that also implements a AutoSuggestDataSet.ResultTransformer and allows for lazy initialization upon first use by specifying a setInitializer(Consumer). Mainly used internally when registering auto-suggest dataset attributes.

Since:

3.4.0

Author:

Arne Vandamme

See Also:

• AutoSuggestDataAttributeRegistrar

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InitializingAutoSuggestDataSet.InitializingAutoSuggestDataSetBuilder

Nested classes/interfaces inherited from interface com.foreach.across.modules.entity.autosuggest.AutoSuggestDataSet

AutoSuggestDataSet.Result, AutoSuggestDataSet.ResultTransformer

Constructor Summary

Constructors

Constructor	Description
InitializingAutoSuggestDataSet()
InitializingAutoSuggestDataSet(Consumer<InitializingAutoSuggestDataSet> initializer, @NonNull BiFunction<String,String,Object> suggestionsLoader, Function<String,Object> prefetchLoader, AutoSuggestDataSet.ResultTransformer resultTransformer, boolean initialized)

Method Summary

Modifier and Type	Method	Description
static InitializingAutoSuggestDataSet.InitializingAutoSuggestDataSetBuilder	builder()	Create a builder for a simple dataset.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Consumer<InitializingAutoSuggestDataSet>	getInitializer()
Function<String,Object>	getPrefetchLoader()
AutoSuggestDataSet.ResultTransformer	getResultTransformer()
@NonNull BiFunction<String,String,Object>	getSuggestionsLoader()
int	hashCode()
boolean	isPrefetchSupported()
Object	prefetch(String controlName)	Retrieve the prefetch data for this set.
void	setInitializer(Consumer<InitializingAutoSuggestDataSet> initializer)
void	setPrefetchLoader(Function<String,Object> prefetchLoader)
void	setResultTransformer(AutoSuggestDataSet.ResultTransformer resultTransformer)
void	setSuggestionsLoader(@NonNull BiFunction<String,String,Object> suggestionsLoader)
Object	suggestions(String query, String controlName)	Retrieve the suggestions for a particular query.
String	toString()
AutoSuggestDataSet.Result	transformToResult(Object candidate)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

InitializingAutoSuggestDataSet

public InitializingAutoSuggestDataSet()

InitializingAutoSuggestDataSet

public InitializingAutoSuggestDataSet(Consumer<InitializingAutoSuggestDataSet> initializer,
 @NonNull
 @NonNull BiFunction<String,String,Object> suggestionsLoader,
 Function<String,Object> prefetchLoader,
 @NonNull
 AutoSuggestDataSet.ResultTransformer resultTransformer,
 boolean initialized)

Method Details

suggestions

public Object suggestions(String query,
 String controlName)

Description copied from interface: AutoSuggestDataSet

Retrieve the suggestions for a particular query. The second parameter is an optional control name for which the suggestions are requested.

Specified by:

suggestions in interface AutoSuggestDataSet

Parameters:

query - usually the input of the user

controlName - name of the control for which the suggestions are requested

Returns:

suggestions result

prefetch

public Object prefetch(String controlName)

Description copied from interface: AutoSuggestDataSet

Retrieve the prefetch data for this set. Prefetch data is the initial data that should be loaded and possibly shown as suggestions, without the user having entered a particular query string.

Specified by:

prefetch in interface AutoSuggestDataSet

Parameters:

controlName - name of the control for which the suggestions are requested

Returns:

suggestions result

isPrefetchSupported

public boolean isPrefetchSupported()

Specified by:

isPrefetchSupported in interface AutoSuggestDataSet

Returns:

true if data from this set can be pre-fetched

transformToResult

public AutoSuggestDataSet.Result transformToResult(Object candidate)

Specified by:

transformToResult in interface AutoSuggestDataSet.ResultTransformer

builder

public static InitializingAutoSuggestDataSet.InitializingAutoSuggestDataSetBuilder builder()

Description copied from interface: AutoSuggestDataSet

Create a builder for a simple dataset. Using a

Returns:

builder for a simple auto-suggest dataset

getInitializer

public Consumer<InitializingAutoSuggestDataSet> getInitializer()

getSuggestionsLoader

@NonNull
public @NonNull BiFunction<String,String,Object> getSuggestionsLoader()

getPrefetchLoader

public Function<String,Object> getPrefetchLoader()

getResultTransformer

@NonNull
public AutoSuggestDataSet.ResultTransformer getResultTransformer()

setInitializer

public void setInitializer(Consumer<InitializingAutoSuggestDataSet> initializer)

setSuggestionsLoader

public void setSuggestionsLoader(@NonNull
 @NonNull BiFunction<String,String,Object> suggestionsLoader)

setPrefetchLoader

public void setPrefetchLoader(Function<String,Object> prefetchLoader)

setResultTransformer

public void setResultTransformer(@NonNull
 AutoSuggestDataSet.ResultTransformer resultTransformer)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object