Package com.foreach.across.modules.entity.config.builders

Class EntityAssociationBuilder

java.lang.Object

com.foreach.across.modules.entity.config.builders.AbstractWritableAttributesBuilder<T>

com.foreach.across.modules.entity.config.builders.AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

com.foreach.across.modules.entity.config.builders.EntityAssociationBuilder

@Component
@Scope("prototype")
public class EntityAssociationBuilder
extends AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Builder for managing a specific EntityAssociation on a EntityConfiguration.

Since:

1.1.1

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor	Description
EntityAssociationBuilder(org.springframework.beans.factory.config.AutowireCapableBeanFactory beanFactory)

Method Summary

Modifier and Type	Method	Description
EntityAssociationBuilder	all()	Target all associations for the current entity.
EntityAssociationBuilder	and(@NonNull Consumer<EntityAssociationBuilder> consumer)	Apply an additional consumer to this builder.
EntityAssociationBuilder	assignableTo(@NonNull Class<?> assignableType)	Target all associations for this type.
EntityAssociationBuilder	associationType(EntityAssociation.Type associationType)	Specify the type of association.
EntityAssociationBuilder	attribute(AttributeRegistrar<EntityAssociation> attributeRegistrar)	Add an attribute registrar for one or more attributes that should be added.
<S> EntityAssociationBuilder	attribute(Class<S> type, S value)	Add a custom attribute this builder should add to the entity.
EntityAssociationBuilder	attribute(String name, Object value)	Add a custom attribute this builder should add to the entity.
EntityAssociationBuilder	autoHide()	Ensures the configuration will be labeled as hidden for UI implementations if any of its participating configurations is hidden.
EntityAssociationBuilder	createFormView()	Configure a default create form view builder for the entity being configured.
EntityAssociationBuilder	createFormView(Consumer<EntityViewFactoryBuilder> consumer)	Configure the create form view builder for the entity being configured.
EntityAssociationBuilder	createOrUpdateFormView(Consumer<EntityViewFactoryBuilder> consumer)	Configure the form view builder for the default create and update forms of the entity being configured.
protected <U extends EntityViewFactoryBuilder> U	createViewFactoryBuilder(Class<U> builderType)
EntityAssociationBuilder	deleteFormView()	Configure a default delete view builder for the entity being configured.
EntityAssociationBuilder	deleteFormView(Consumer<EntityViewFactoryBuilder> consumer)	Configure the default delete form view builder for the entity being configured.
EntityAssociationBuilder	detailView()	Configure a default detail view builder for the entity being configured.
EntityAssociationBuilder	detailView(Consumer<EntityViewFactoryBuilder> consumer)	Configure the default detail view builder for the entity being configured.
EntityAssociationBuilder	formView(String viewName, Consumer<EntityViewFactoryBuilder> consumer)	Configure the named form view builder for the entity being configured.
EntityAssociationBuilder	hidden(Boolean hidden)	Should the EntityAssociation be hidden from UI implementations.
EntityAssociationBuilder	hide()	Ensures the association will be labeled as hidden for UI implementations.
protected <U extends EntityViewFactoryBuilder> void	initializeViewFactoryBuilder(String viewName, String templateName, U builder)
EntityAssociationBuilder	listView()	Configure a default list view builder for the entity being configured.
EntityAssociationBuilder	listView(String viewName, Consumer<EntityListViewFactoryBuilder> consumer)	Returns the named list view builder for the entity being configured.
EntityAssociationBuilder	listView(Consumer<EntityListViewFactoryBuilder> consumer)	Configure the default list view builder for the entity being configured.
EntityAssociationBuilder	name(@NonNull String name)	Specify the name of the association that this builder is responsible for.
EntityAssociationBuilder	parentDeleteMode(EntityAssociation.ParentDeleteMode parentDeleteMode)	Set the UI behaviour in case the parent entity is being deleted but there are associations.
static void	registerAssociationMessageCodeResolver(MutableEntityAssociation association)
EntityAssociationBuilder	removeSourceProperty()	Remove the property on the source end.
EntityAssociationBuilder	removeTargetProperty()	Remove the property on the target end.
EntityAssociationBuilder	show()	Ensures the association will not be labeled as hidden for UI implementations.
EntityAssociationBuilder	sourceProperty(@NonNull String sourceProperty)	Set the name of the property on the source end.
EntityAssociationBuilder	targetEntity(@NonNull String entityName)	Set the name of the target entity for this association.
EntityAssociationBuilder	targetEntityType(@NonNull Class<?> targetEntityType)	Set the target entity type for this association.
EntityAssociationBuilder	targetProperty(@NonNull String targetProperty)	Set the name of the property on the target end.
EntityAssociationBuilder	updateFormView()	Configure a default update form view builder for the entity being configured.
EntityAssociationBuilder	updateFormView(Consumer<EntityViewFactoryBuilder> consumer)	Configure the default update form view builder for the entity being configured.
EntityAssociationBuilder	view(String viewName, Consumer<EntityViewFactoryBuilder> consumer)	Configure the named simple view builder for the entity being configured.
EntityAssociationBuilder	withType(@NonNull Class<?> associationType)	Target all associations for this type.

Methods inherited from class com.foreach.across.modules.entity.config.builders.AbstractWritableAttributesAndViewsBuilder

applyViews

Methods inherited from class com.foreach.across.modules.entity.config.builders.AbstractWritableAttributesBuilder

applyAttributes, getAttributes

Methods inherited from class java.lang.Object

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

Constructor Details

EntityAssociationBuilder

@Autowired
public EntityAssociationBuilder(org.springframework.beans.factory.config.AutowireCapableBeanFactory beanFactory)

Method Details

name

public EntityAssociationBuilder name(@NonNull
 @NonNull String name)

Specify the name of the association that this builder is responsible for.

Parameters:

name - of the association

Returns:

current builder

all

public EntityAssociationBuilder all()

Target all associations for the current entity.

This is equivalent to using name("*").

withType

public EntityAssociationBuilder withType(@NonNull
 @NonNull Class<?> associationType)

Target all associations for this type.

This is equivalent to using name("*").

assignableTo

public EntityAssociationBuilder assignableTo(@NonNull
 @NonNull Class<?> assignableType)

Target all associations for this type.

This is equivalent to using name("*").

associationType

public EntityAssociationBuilder associationType(@NonNull
 EntityAssociation.Type associationType)

Specify the type of association. This will determine how the associated entities can be managed.

Parameters:

associationType - of the association

Returns:

current builder

targetEntityType

public EntityAssociationBuilder targetEntityType(@NonNull
 @NonNull Class<?> targetEntityType)

Set the target entity type for this association. This type must be registered in the EntityRegistry.

Parameters:

targetEntityType - type of the target entity

Returns:

current builder

targetEntity

public EntityAssociationBuilder targetEntity(@NonNull
 @NonNull String entityName)

Set the name of the target entity for this association. The entity must be registered in the EntityRegistry present in the BeanFactory provided. This property takes precedence over targetEntityType(Class).

Parameters:

entityName - name of the target entity

Returns:

current builder

sourceProperty

public EntityAssociationBuilder sourceProperty(@NonNull
 @NonNull String sourceProperty)

Set the name of the property on the source end. The property should be found in the corresponding EntityPropertyRegistry of the source EntityConfiguration.

Should not be null. If you want to remove the source property explicitly, use removeSourceProperty().

Parameters:

sourceProperty - name, not null

Returns:

current builder

removeSourceProperty

public EntityAssociationBuilder removeSourceProperty()

Remove the property on the source end. This implies that the association is entirely determined by the target entity linking back to the source entity.

Returns:

current builder

targetProperty

public EntityAssociationBuilder targetProperty(@NonNull
 @NonNull String targetProperty)

Set the name of the property on the target end. The property should be found in the corresponding EntityPropertyRegistry of the target EntityConfiguration.

Should not be null. If you want to remove the target property explicitly, use removeTargetProperty().

Parameters:

targetProperty - name, not null

Returns:

current builder

removeTargetProperty

public EntityAssociationBuilder removeTargetProperty()

Remove the property on the target end. This implies that the association is entirely determined by the source entity linking to the target entity, without a back link.

Returns:

current builder

show

public EntityAssociationBuilder show()

Ensures the association will not be labeled as hidden for UI implementations.

Returns:

current builder

hide

public EntityAssociationBuilder hide()

Ensures the association will be labeled as hidden for UI implementations.

Returns:

current builder

autoHide

public EntityAssociationBuilder autoHide()

Ensures the configuration will be labeled as hidden for UI implementations if any of its participating configurations is hidden. This is the default behavior if the property is not specified explicitly on the association.

Returns:

current builder

hidden

public EntityAssociationBuilder hidden(Boolean hidden)

Should the EntityAssociation be hidden from UI implementations. This property can be considered a hint for automatically generated user interfaces.

Parameters:

hidden - True if the association should be hidden from UI.

Returns:

current builder

parentDeleteMode

public EntityAssociationBuilder parentDeleteMode(EntityAssociation.ParentDeleteMode parentDeleteMode)

Set the UI behaviour in case the parent entity is being deleted but there are associations.

Parameters:

parentDeleteMode - to use

Returns:

current builder

See Also:

• EntityAssociation.ParentDeleteMode

listView

public EntityAssociationBuilder listView(Consumer<EntityListViewFactoryBuilder> consumer)

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure the default list view builder for the entity being configured. A default list view is usually available.

Overrides:

listView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

listView

public EntityAssociationBuilder listView(String viewName,
 Consumer<EntityListViewFactoryBuilder> consumer)

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Returns the named list view builder for the entity being configured. If the view is not available, it will be created.

Overrides:

listView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Parameters:

viewName - name of the view

consumer - for configuring the view builder

Returns:

builder instance

createOrUpdateFormView

public EntityAssociationBuilder createOrUpdateFormView(Consumer<EntityViewFactoryBuilder> consumer)

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure the form view builder for the default create and update forms of the entity being configured. Create and update forms are usually available.

Overrides:

createOrUpdateFormView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

createFormView

public EntityAssociationBuilder createFormView(Consumer<EntityViewFactoryBuilder> consumer)

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure the create form view builder for the entity being configured. A default create form view is usually available.

Overrides:

createFormView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

updateFormView

public EntityAssociationBuilder updateFormView(Consumer<EntityViewFactoryBuilder> consumer)

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure the default update form view builder for the entity being configured. A default update form view is usually available.

Overrides:

updateFormView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

deleteFormView

public EntityAssociationBuilder deleteFormView(Consumer<EntityViewFactoryBuilder> consumer)

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure the default delete form view builder for the entity being configured. A default delete form view is usually available.

Overrides:

deleteFormView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

detailView

public EntityAssociationBuilder detailView(Consumer<EntityViewFactoryBuilder> consumer)

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure the default detail view builder for the entity being configured. A default detail view is usually available.

Overrides:

detailView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

formView

public EntityAssociationBuilder formView(String viewName,
 Consumer<EntityViewFactoryBuilder> consumer)

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure the named form view builder for the entity being configured. If the view is not available, it will be created.

Overrides:

formView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Parameters:

viewName - name of the view

consumer - for configuring the view builder

Returns:

current builder

view

public EntityAssociationBuilder view(String viewName,
 Consumer<EntityViewFactoryBuilder> consumer)

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure the named simple view builder for the entity being configured. If the view is not available, it will be created.

Overrides:

view in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Parameters:

viewName - name of the view

consumer - for configuring the view builder

Returns:

current builder

listView

public EntityAssociationBuilder listView()

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure a default list view builder for the entity being configured. Does not customize the builder but ensures the view gets created using the default builder.

Overrides:

listView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Returns:

current builder

createFormView

public EntityAssociationBuilder createFormView()

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure a default create form view builder for the entity being configured. Does not customize the builder but ensures the view gets created using the default builder.

Overrides:

createFormView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Returns:

current builder

updateFormView

public EntityAssociationBuilder updateFormView()

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure a default update form view builder for the entity being configured. Does not customize the builder but ensures the view gets created using the default builder.

Overrides:

updateFormView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Returns:

current builder

deleteFormView

public EntityAssociationBuilder deleteFormView()

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure a default delete view builder for the entity being configured. Does not customize the builder but ensures the view gets created using the default builder.

Overrides:

deleteFormView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Returns:

current builder

detailView

public EntityAssociationBuilder detailView()

Description copied from class: AbstractWritableAttributesAndViewsBuilder

Configure a default detail view builder for the entity being configured. Does not customize the builder but ensures the view gets created using the default builder.

Overrides:

detailView in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

Returns:

current builder

attribute

public EntityAssociationBuilder attribute(String name,
 Object value)

Description copied from class: AbstractWritableAttributesBuilder

Add a custom attribute this builder should add to the entity.

Overrides:

attribute in class AbstractWritableAttributesBuilder<EntityAssociation>

Parameters:

name - Name of the attribute.

value - Value of the attribute.

Returns:

current builder

attribute

public <S> EntityAssociationBuilder attribute(Class<S> type,
 S value)

Description copied from class: AbstractWritableAttributesBuilder

Add a custom attribute this builder should add to the entity.

Overrides:

attribute in class AbstractWritableAttributesBuilder<EntityAssociation>

Type Parameters:

S - Class that is both key and value type of the attribute

Parameters:

type - Type of the attribute.

value - Value of the attribute.

Returns:

current builder

attribute

public EntityAssociationBuilder attribute(AttributeRegistrar<EntityAssociation> attributeRegistrar)

Description copied from class: AbstractWritableAttributesBuilder

Add an attribute registrar for one or more attributes that should be added. Provides a mechanism to get the owner (eg. EntityConfiguration...) to be made accessible to the attribute values.

Overrides:

attribute in class AbstractWritableAttributesBuilder<EntityAssociation>

Parameters:

attributeRegistrar - registrar

Returns:

current builder

and

public EntityAssociationBuilder and(@NonNull
 @NonNull Consumer<EntityAssociationBuilder> consumer)

Apply an additional consumer to this builder.

Parameters:

consumer - to apply

Returns:

current builder

createViewFactoryBuilder

protected <U extends EntityViewFactoryBuilder> U createViewFactoryBuilder(Class<U> builderType)

Specified by:

createViewFactoryBuilder in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

initializeViewFactoryBuilder

protected <U extends EntityViewFactoryBuilder> void initializeViewFactoryBuilder(String viewName,
 String templateName,
 U builder)

Specified by:

initializeViewFactoryBuilder in class AbstractWritableAttributesAndViewsBuilder<EntityAssociation>

registerAssociationMessageCodeResolver

public static void registerAssociationMessageCodeResolver(MutableEntityAssociation association)