io.jmix.ui.builder

Class LookupBuilderProcessor

java.lang.Object

io.jmix.ui.builder.LookupBuilderProcessor

@Component(value="ui_LookupBuilderProcessor")
public class LookupBuilderProcessor
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.DataManager	dataManager
protected io.jmix.core.EntityStates	entityStates
protected io.jmix.core.ExtendedEntities	extendedEntities
protected io.jmix.core.FetchPlans	fetchPlans
protected io.jmix.core.Metadata	metadata
protected io.jmix.core.MetadataTools	metadataTools
protected UiScreenProperties	screenProperties
protected WindowConfig	windowConfig

Constructor Summary

Constructors

Constructor and Description
LookupBuilderProcessor()

Method Summary

Modifier and Type	Method and Description
<E,S extends Screen> S	buildLookup(LookupBuilder<E> builder)
protected <E> Screen	createScreen(LookupBuilder<E> builder, Screens screens)
protected <E> java.lang.Object	fromCollection(java.util.Collection<E> value, boolean isCollectionValue)
protected <E> io.jmix.core.FetchPlan	getFetchPlanForCollectionContainer(CollectionContainer<E> collectionDc, boolean initializeMasterReference, io.jmix.core.metamodel.model.MetaProperty inverseMetaProperty) See getFetchPlanForField(HasValue) javadoc.
protected io.jmix.core.FetchPlan	getFetchPlanForField(HasValue field) The method evaluates the fetch plan that is used for the entity in the given field
protected <E> void	handleSelectionWithContainer(LookupBuilder<E> builder, CollectionContainer<E> collectionDc, java.util.Collection<E> itemsFromLookup)
protected <E> void	handleSelectionWithField(LookupBuilder<E> builder, HasValue field, java.util.Collection<E> itemsFromLookup, boolean isCollectionValue)
protected <E> java.util.Collection<E>	reloadItemsByFetchPlan(io.jmix.core.FetchPlan fetchPlan, java.util.Collection<E> itemsFromLookup)
protected <E> java.util.Collection<E>	toCollection(java.lang.Object value, boolean isCollectionValue)
protected <E> java.util.Collection<E>	transform(java.util.Collection<E> selectedItems, LookupBuilder<E> builder)
<E> void	updateFieldOptions(OptionsField field, java.util.Collection<E> items) Updates entities in options if they contain selected item from lookup screen.

Methods inherited from class java.lang.Object

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

Field Detail

windowConfig

@Autowired
protected WindowConfig windowConfig

screenProperties

@Autowired
protected UiScreenProperties screenProperties

extendedEntities

@Autowired
protected io.jmix.core.ExtendedEntities extendedEntities

metadata

@Autowired
protected io.jmix.core.Metadata metadata

entityStates

@Autowired
protected io.jmix.core.EntityStates entityStates

dataManager

@Autowired
protected io.jmix.core.DataManager dataManager

metadataTools

@Autowired
protected io.jmix.core.MetadataTools metadataTools

fetchPlans

@Autowired
protected io.jmix.core.FetchPlans fetchPlans

Constructor Detail

LookupBuilderProcessor

public LookupBuilderProcessor()

Method Detail

buildLookup

public <E,S extends Screen> S buildLookup(LookupBuilder<E> builder)

createScreen

protected <E> Screen createScreen(LookupBuilder<E> builder,
                                  Screens screens)

handleSelectionWithField

protected <E> void handleSelectionWithField(LookupBuilder<E> builder,
                                            HasValue field,
                                            java.util.Collection<E> itemsFromLookup,
                                            boolean isCollectionValue)

toCollection

protected <E> java.util.Collection<E> toCollection(java.lang.Object value,
                                                   boolean isCollectionValue)

fromCollection

protected <E> java.lang.Object fromCollection(java.util.Collection<E> value,
                                              boolean isCollectionValue)

handleSelectionWithContainer

protected <E> void handleSelectionWithContainer(LookupBuilder<E> builder,
                                                CollectionContainer<E> collectionDc,
                                                java.util.Collection<E> itemsFromLookup)

transform

protected <E> java.util.Collection<E> transform(java.util.Collection<E> selectedItems,
                                                LookupBuilder<E> builder)

getFetchPlanForField

@Nullable
protected io.jmix.core.FetchPlan getFetchPlanForField(HasValue field)

The method evaluates the fetch plan that is used for the entity in the given field

If the value for a component (e.g. EntityPicker) is selected from lookup screen then there may be cases when in entities in lookup screen some attributes required in the editor are not loaded.

Returns:

a view or null if the fetch plan cannot be evaluated

getFetchPlanForCollectionContainer

@Nullable
protected <E> io.jmix.core.FetchPlan getFetchPlanForCollectionContainer(CollectionContainer<E> collectionDc,
                                                                                  boolean initializeMasterReference,
                                                                                  @Nullable
                                                                                  io.jmix.core.metamodel.model.MetaProperty inverseMetaProperty)

See getFetchPlanForField(HasValue) javadoc.

Returns:

a fetch plan or null if the fetch plan cannot be evaluated

reloadItemsByFetchPlan

protected <E> java.util.Collection<E> reloadItemsByFetchPlan(io.jmix.core.FetchPlan fetchPlan,
                                                             java.util.Collection<E> itemsFromLookup)

updateFieldOptions

public <E> void updateFieldOptions(OptionsField field,
                                   java.util.Collection<E> items)

Updates entities in options if they contain selected item from lookup screen.

Type Parameters:

E - entity type

Parameters:

field - options field to update

items - selected entities from lookup screen to update options in field