Package io.jmix.flowui.component.factory

Class LookupFieldSupport

java.lang.Object

io.jmix.flowui.component.factory.LookupFieldSupport

@Component("flowui_LookupFieldSupport")
public class LookupFieldSupport
extends Object

Resolves the effective @LookupField configuration for an entity reference: annotation precedence (field annotation, then the entity-field-actions property, then class annotation) and the validations that do not depend on runtime context. The single source of truth shared by EntityFieldCreationSupport and ComponentXmlFactory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	LookupFieldSupport.ItemsQuerySettings
protected static class	LookupFieldSupport.LookupFieldSettings

Field Summary

Fields

Modifier and Type	Field	Description
protected final UiComponentProperties	componentProperties
protected final MetadataTools	metadataTools
protected static final String	SEARCH_STRING_PARAMETER_REF

Constructor Summary

Constructors

Constructor	Description
LookupFieldSupport(MetadataTools metadataTools, UiComponentProperties componentProperties)

Method Summary

Modifier and Type	Method	Description
protected EffectiveLookupConfig	dropdown(boolean fieldLevel, List<String> actions, EffectiveLookupConfig.ItemsMode mode, @Nullable String query, @Nullable String searchStringFormat, boolean escapeValueForLike, @Nullable String fetchPlanName)
protected boolean	isItemsQueryConfigured(@Nullable LookupFieldSupport.ItemsQuerySettings itemsQuery)
protected @Nullable LookupFieldSupport.ItemsQuerySettings	readItemsQuery(@Nullable Object raw)
protected @Nullable LookupFieldSupport.LookupFieldSettings	readSettings(Map<String,Object> annotations)
EffectiveLookupConfig	resolve(MetaProperty referencingProperty, MetaClass referencedEntityClass)	Resolves the effective configuration for a reference attribute.
protected List<String>	resolveActions(@Nullable LookupFieldSupport.LookupFieldSettings fieldSettings, @Nullable LookupFieldSupport.LookupFieldSettings classSettings, MetaClass referencedEntityClass)
protected EffectiveLookupConfig	resolveDropdown(@Nullable LookupFieldSupport.ItemsQuerySettings itemsQuery, MetaClass metaClass, boolean fieldLevel, List<String> actions)

Methods inherited from class java.lang.Object

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

Field Details

SEARCH_STRING_PARAMETER_REF

protected static final String SEARCH_STRING_PARAMETER_REF

See Also:

• Constant Field Values

metadataTools

protected final MetadataTools metadataTools

componentProperties

protected final UiComponentProperties componentProperties

Constructor Details

LookupFieldSupport

public LookupFieldSupport(MetadataTools metadataTools,
 UiComponentProperties componentProperties)

Method Details

resolve

public EffectiveLookupConfig resolve(MetaProperty referencingProperty,
 MetaClass referencedEntityClass)

Resolves the effective configuration for a reference attribute.

Parameters:

referencingProperty - the attribute that references an entity

referencedEntityClass - the referenced entity's metaClass

resolveDropdown

protected EffectiveLookupConfig resolveDropdown(@Nullable LookupFieldSupport.ItemsQuerySettings itemsQuery,
 MetaClass metaClass,
 boolean fieldLevel,
 List<String> actions)

dropdown

protected EffectiveLookupConfig dropdown(boolean fieldLevel,
 List<String> actions,
 EffectiveLookupConfig.ItemsMode mode,
 @Nullable String query,
 @Nullable String searchStringFormat,
 boolean escapeValueForLike,
 @Nullable String fetchPlanName)

resolveActions

protected List<String> resolveActions(@Nullable LookupFieldSupport.LookupFieldSettings fieldSettings,
 @Nullable LookupFieldSupport.LookupFieldSettings classSettings,
 MetaClass referencedEntityClass)

isItemsQueryConfigured

protected boolean isItemsQueryConfigured(@Nullable LookupFieldSupport.ItemsQuerySettings itemsQuery)

readSettings

protected @Nullable LookupFieldSupport.LookupFieldSettings readSettings(Map<String,Object> annotations)

readItemsQuery

protected @Nullable LookupFieldSupport.ItemsQuerySettings readItemsQuery(@Nullable Object raw)