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

Class AutoSuggestDataAttributeRegistrar

java.lang.Object

com.foreach.across.modules.entity.autosuggest.AutoSuggestDataAttributeRegistrar

@Service
@Lazy
public class AutoSuggestDataAttributeRegistrar
extends Object

Helper that allows registering simple entity (query) based auto-suggest datasets and attaching them immediately to the scope of an entity configuration or property.

This will register the dataset in the AutoSuggestDataEndpoint (which must be available) and attach the id of the dataset as attribute on the descriptor or configuration.

Since:

3.4.0

Author:

Arne Vandamme

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	AutoSuggestDataAttributeRegistrar.DataSetRegistrar<T extends com.foreach.across.core.support.ReadableAttributes>	Alias to allow direct control specification after dataset attribute.
static class	AutoSuggestDataAttributeRegistrar.EntityDataSetConfiguration<T>	Holds the configuration for an InitializingAutoSuggestDataSet based on an entity configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATASET_ID	The id of the auto-suggest dataset that should be used when building a AutoSuggestFormElement.

Method Summary

Modifier and Type	Method	Description
<U extends com.foreach.across.core.support.ReadableAttributes> AttributeRegistrar<U>	control(@NonNull Consumer<AutoSuggestFormElementConfiguration> controlConsumer)	Registers or customizes only the AutoSuggestFormElementConfiguration which determines the default settings for the auto-suggest control (for example the minimum length before fetching results).
<U extends com.foreach.across.core.support.ReadableAttributes> AutoSuggestDataAttributeRegistrar.DataSetRegistrar<U>	dataSetId(@NonNull String dataSetId)	Registers the dataset with the given id as auto-suggest datasource.
<U extends com.foreach.across.core.support.ReadableAttributes> AutoSuggestDataAttributeRegistrar.DataSetRegistrar<U>	entityQuery(@NonNull String suggestionsEql)	Register a simple dataset that uses an EQL statement to fetch the results.
<U extends com.foreach.across.core.support.ReadableAttributes> AutoSuggestDataAttributeRegistrar.DataSetRegistrar<U>	entityQuery(@NonNull Consumer<AutoSuggestDataAttributeRegistrar.EntityDataSetConfiguration<? super Object>> dataSetConsumer)	Register an entity configuration based InitializingAutoSuggestDataSet dataset that will be initialized upon first use.

Methods inherited from class java.lang.Object

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

Field Details

DATASET_ID

public static final String DATASET_ID

The id of the auto-suggest dataset that should be used when building a AutoSuggestFormElement.

See Also:

• AutoSuggestFormElementBuilderFactory
• Constant Field Values

Method Details

dataSetId

public <U extends com.foreach.across.core.support.ReadableAttributes>
AutoSuggestDataAttributeRegistrar.DataSetRegistrar<U> dataSetId(@NonNull
 @NonNull String dataSetId)

Registers the dataset with the given id as auto-suggest datasource. This is the equivalent of directly setting the DATASET_ID attribute.

Parameters:

dataSetId - id of the dataset

Returns:

attribute registrar

entityQuery

public <U extends com.foreach.across.core.support.ReadableAttributes>
AutoSuggestDataAttributeRegistrar.DataSetRegistrar<U> entityQuery(@NonNull
 @NonNull String suggestionsEql)

Register a simple dataset that uses an EQL statement to fetch the results. The entity configuration of the target type wil be used for query execution and result transformation (using the available entity model). The target entity configuration will be derived from the context on which the attribute is being registered (either EntityConfiguration or EntityPropertyDescriptor.

The EQL statement can hold a \{0\} token where the actual search string will be inserted.

The default number of results will be limited to 50.

Parameters:

suggestionsEql - eql to fetch the suggestions

Returns:

attribute registrar

See Also:

• AutoSuggestDataAttributeRegistrar.EntityDataSetConfiguration

entityQuery

public <U extends com.foreach.across.core.support.ReadableAttributes>
AutoSuggestDataAttributeRegistrar.DataSetRegistrar<U> entityQuery(@NonNull
 @NonNull Consumer<AutoSuggestDataAttributeRegistrar.EntityDataSetConfiguration<? super Object>> dataSetConsumer)

Register an entity configuration based InitializingAutoSuggestDataSet dataset that will be initialized upon first use. The default number of results will be limited to 50. If no AutoSuggestDataAttributeRegistrar.EntityDataSetConfiguration.entityType(Class) is specified manually, it will be derived from the context on which the attribute is being registered.

Parameters:

dataSetConsumer - to customize the dataset properties

Returns:

attribute registrar

See Also:

• AutoSuggestDataAttributeRegistrar.EntityDataSetConfiguration

control

public <U extends com.foreach.across.core.support.ReadableAttributes>
AttributeRegistrar<U> control(@NonNull
 @NonNull Consumer<AutoSuggestFormElementConfiguration> controlConsumer)

Registers or customizes only the AutoSuggestFormElementConfiguration which determines the default settings for the auto-suggest control (for example the minimum length before fetching results).

Parameters:

controlConsumer - consumer to customize the configuration

Returns:

attribute registrar