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

Class EntityConfigurationBuilder<T>

java.lang.Object

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

com.foreach.across.modules.entity.config.builders.AbstractWritableAttributesAndViewsBuilder<EntityConfiguration<T>>

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

@Component
@Scope("prototype")
public class EntityConfigurationBuilder<T>
extends AbstractWritableAttributesAndViewsBuilder<EntityConfiguration<T>>

Author:

Arne Vandamme

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EntityConfigurationBuilder<T>	allowableActionsBuilder(@NonNull EntityConfigurationAllowableActionsBuilder allowableActionsBuilder)	Configure the EntityConfigurationAllowableActionsBuilder to be used.
EntityConfigurationBuilder<T>	and(@NonNull Consumer<EntityConfigurationBuilder<T>> consumer)	Apply an additional consumer to this builder.
void	apply(MutableEntityConfiguration<T> configuration)	Apply the builder to the given entity configuration.
protected void	applyAttributes(EntityConfiguration<T> owner, com.foreach.across.core.support.WritableAttributes attributes)
<U extends T> EntityConfigurationBuilder<U>	as(@NonNull Class<U> subType)	Downcast the current builder as managing an EntityConfiguration of a specific type.
EntityConfigurationBuilder<T>	association(Consumer<EntityAssociationBuilder> consumer)	Configure an association builder.
EntityConfigurationBuilder<T>	attribute(AttributeRegistrar<EntityConfiguration<T>> attributeRegistrar)	Add an attribute registrar for one or more attributes that should be added.
<S> EntityConfigurationBuilder<T>	attribute(Class<S> type, S value)	Add a custom attribute this builder should add to the entity.
EntityConfigurationBuilder<T>	attribute(String name, Object value)	Add a custom attribute this builder should add to the entity.
MutableEntityConfiguration<T>	build()	Build a new EntityConfigurationImpl with the settings specified.
EntityConfigurationBuilder<T>	createFormView()	Configure a default create form view builder for the entity being configured.
EntityConfigurationBuilder<T>	createFormView(Consumer<EntityViewFactoryBuilder> consumer)	Configure the create form view builder for the entity being configured.
EntityConfigurationBuilder<T>	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)
EntityConfigurationBuilder<T>	deleteFormView()	Configure a default delete view builder for the entity being configured.
EntityConfigurationBuilder<T>	deleteFormView(Consumer<EntityViewFactoryBuilder> consumer)	Configure the default delete form view builder for the entity being configured.
EntityConfigurationBuilder<T>	detailView()	Configure a default detail view builder for the entity being configured.
EntityConfigurationBuilder<T>	detailView(Consumer<EntityViewFactoryBuilder> consumer)	Configure the default detail view builder for the entity being configured.
EntityConfigurationBuilder<T>	displayName(String displayName)	Set the default display name of the entity configuration in UI implementations.
EntityConfigurationBuilder<T>	entityModel(EntityModel<T,Serializable> entityModel)	Sets a custom EntityModel for this configuration.
EntityConfigurationBuilder<T>	entityModel(Consumer<EntityModelBuilder<T>> entityModelConsumer)	Add a consumer to customize the EntityModel.
<U extends T> EntityConfigurationBuilder<U>	entityType(Class<U> entityType, boolean registerForClass)	Set the entity type of the entity configuration.
EntityConfigurationBuilder<T>	formView(String viewName, Consumer<EntityViewFactoryBuilder> consumer)	Configure the named form view builder for the entity being configured.
EntityConfigurationBuilder<T>	hidden(boolean hidden)	Should the EntityConfiguration be hidden from UI implementations.
EntityConfigurationBuilder<T>	hide()	Ensures the configuration will be labeled as hidden for UI implementations.
protected <U extends EntityViewFactoryBuilder> void	initializeViewFactoryBuilder(String viewName, String templateName, U builder)
EntityConfigurationBuilder<T>	label(String propertyName)	Configure the label property based on another registered property.
EntityConfigurationBuilder<T>	listView()	Configure a default list view builder for the entity being configured.
EntityConfigurationBuilder<T>	listView(String viewName, Consumer<EntityListViewFactoryBuilder> consumer)	Returns the named list view builder for the entity being configured.
EntityConfigurationBuilder<T>	listView(Consumer<EntityListViewFactoryBuilder> consumer)	Configure the default list view builder for the entity being configured.
EntityConfigurationBuilder<T>	name(String name)	Set the internal name of the entity configuration.
EntityConfigurationBuilder<T>	postProcessor(@NonNull Consumer<MutableEntityConfiguration<T>> postProcessor)	Add a post processor instance.
EntityConfigurationBuilder<T>	properties(@NonNull Consumer<EntityPropertyRegistryBuilder> registryConsumer)	Customize the property registry builder.
EntityConfigurationBuilder<T>	show()	Ensures the configuration will not be labeled as hidden for UI implementations.
EntityConfigurationBuilder<T>	updateFormView()	Configure a default update form view builder for the entity being configured.
EntityConfigurationBuilder<T>	updateFormView(Consumer<EntityViewFactoryBuilder> consumer)	Configure the default update form view builder for the entity being configured.
EntityConfigurationBuilder<T>	view(String viewName, Consumer<EntityViewFactoryBuilder> consumer)	Configure the named simple view builder for the entity being configured.
EntityConfigurationBuilder<T>	viewElementBuilder(ViewElementMode mode, com.foreach.across.modules.web.ui.ViewElementBuilder viewElementBuilder)	Set the default ViewElementBuilder properties with this entity as type should use for a particular ViewElementMode.
<U extends com.foreach.across.modules.web.ui.ViewElement> EntityConfigurationBuilder<T>	viewElementPostProcessor(ViewElementMode mode, com.foreach.across.modules.web.ui.ViewElementPostProcessor<U> viewElementPostProcessor)	Add a ViewElementPostProcessor to apply to the default ViewElementBuilder.
EntityConfigurationBuilder<T>	viewElementType(ViewElementMode mode, String viewElementType)	Set the ViewElement type of a particular ViewElementMode.

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

getAttributes

Methods inherited from class java.lang.Object

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

Constructor Details

EntityConfigurationBuilder

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

Method Details

as

public <U extends T> EntityConfigurationBuilder<U> as(@NonNull
 @NonNull Class<U> subType)

Downcast the current builder as managing an EntityConfiguration of a specific type. Note this can throw class cast exceptions if the types doe not match.

Type Parameters:

U - subType of the original generic type

Parameters:

subType - of the original generic type

Returns:

downcast version of the current builder

name

public EntityConfigurationBuilder<T> name(String name)

Set the internal name of the entity configuration. Must be unique within a registry. Can only be used along with build(), cannot be modified on an existing configuration.

Parameters:

name - of the configuration

Returns:

current builder

displayName

public EntityConfigurationBuilder<T> displayName(String displayName)

Set the default display name of the entity configuration in UI implementations.

Parameters:

displayName - of the configuration

Returns:

current builder

entityType

public <U extends T> EntityConfigurationBuilder<U> entityType(Class<U> entityType,
 boolean registerForClass)

Set the entity type of the entity configuration. Can only be used along with build(). Cannot be modified on an existing configuration.

The registerForClass parameter determines if the property registry of the class should be the main registry in the EntityPropertyRegistryProvider. If that is the case, nested properties on this type will be resolved against this configuration. If you're expecting to have only one entity configuration using this entity type, then you most likely want to register this configuration for that type it.

Parameters:

entityType - for the configuration

registerForClass - true if the property registry should be the main registry for that class

Returns:

current builder

properties

public EntityConfigurationBuilder<T> properties(@NonNull
 @NonNull Consumer<EntityPropertyRegistryBuilder> registryConsumer)

Customize the property registry builder.

Parameters:

registryConsumer - to customize the registry builder

Returns:

current builder

show

public EntityConfigurationBuilder<T> show()

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

Returns:

current builder

hide

public EntityConfigurationBuilder<T> hide()

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

Returns:

current builder

hidden

public EntityConfigurationBuilder<T> hidden(boolean hidden)

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

Parameters:

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

Returns:

current builder

allowableActionsBuilder

public EntityConfigurationBuilder<T> allowableActionsBuilder(@NonNull
 @NonNull EntityConfigurationAllowableActionsBuilder allowableActionsBuilder)

Configure the EntityConfigurationAllowableActionsBuilder to be used.

Parameters:

allowableActionsBuilder - instance

Returns:

current builder

label

public EntityConfigurationBuilder<T> label(String propertyName)

Configure the label property based on another registered property. This is a shortcut for configuring a properties builder setting the label.

Parameters:

propertyName - of the registered property to use as a base of the label

Returns:

current builder

entityModel

public EntityConfigurationBuilder<T> entityModel(EntityModel<T,Serializable> entityModel)

Sets a custom EntityModel for this configuration.

Parameters:

entityModel - implementation

Returns:

current builder

entityModel

public EntityConfigurationBuilder<T> entityModel(Consumer<EntityModelBuilder<T>> entityModelConsumer)

Add a consumer to customize the EntityModel.

Returns:

current builder

postProcessor

public EntityConfigurationBuilder<T> postProcessor(@NonNull
 @NonNull Consumer<MutableEntityConfiguration<T>> postProcessor)

Add a post processor instance. The post processor will only be executed after the rest of the builder has been applied. It can be used to modify the configuration directly.

Parameters:

postProcessor - instance

Returns:

current builder

association

public EntityConfigurationBuilder<T> association(Consumer<EntityAssociationBuilder> consumer)

Configure an association builder.

Parameters:

consumer - to configure the association builder

Returns:

current builder

viewElementType

public EntityConfigurationBuilder<T> viewElementType(ViewElementMode mode,
 String viewElementType)

Set the ViewElement type of a particular ViewElementMode.

Parameters:

mode - to set the type for

viewElementType - to use

Returns:

current builder

viewElementBuilder

public EntityConfigurationBuilder<T> viewElementBuilder(ViewElementMode mode,
 com.foreach.across.modules.web.ui.ViewElementBuilder viewElementBuilder)

Set the default ViewElementBuilder properties with this entity as type should use for a particular ViewElementMode.

Parameters:

mode - to set the builder for

viewElementBuilder - to use

Returns:

current builder

viewElementPostProcessor

public <U extends com.foreach.across.modules.web.ui.ViewElement>
EntityConfigurationBuilder<T> viewElementPostProcessor(ViewElementMode mode,
 com.foreach.across.modules.web.ui.ViewElementPostProcessor<U> viewElementPostProcessor)

Add a ViewElementPostProcessor to apply to the default ViewElementBuilder. Note that postprocessor will be ignored if a custom ViewElementBuilder was set using viewElementBuilder(ViewElementMode, ViewElementBuilder).

Parameters:

mode - to add the postprocessor for

viewElementPostProcessor - to add

Returns:

current builder

attribute

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

name - Name of the attribute.

value - Value of the attribute.

Returns:

current builder

attribute

public <S> EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

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 EntityConfigurationBuilder<T> attribute(AttributeRegistrar<EntityConfiguration<T>> 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<EntityConfiguration<T>>

Parameters:

attributeRegistrar - registrar

Returns:

current builder

listView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

listView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

viewName - name of the view

consumer - for configuring the view builder

Returns:

builder instance

createOrUpdateFormView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

createFormView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

updateFormView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

deleteFormView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

detailView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

consumer - for configuring the view builder

Returns:

current builder

formView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

viewName - name of the view

consumer - for configuring the view builder

Returns:

current builder

view

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Parameters:

viewName - name of the view

consumer - for configuring the view builder

Returns:

current builder

listView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Returns:

current builder

createFormView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Returns:

current builder

updateFormView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Returns:

current builder

deleteFormView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Returns:

current builder

detailView

public EntityConfigurationBuilder<T> 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<EntityConfiguration<T>>

Returns:

current builder

and

public EntityConfigurationBuilder<T> and(@NonNull
 @NonNull Consumer<EntityConfigurationBuilder<T>> consumer)

Apply an additional consumer to this builder.

Parameters:

consumer - to apply

Returns:

current builder

build

public MutableEntityConfiguration<T> build()

Build a new EntityConfigurationImpl with the settings specified. Allows setting both name and entity type. Will apply the post processors after initial creation.

Returns:

built configuration

apply

public void apply(MutableEntityConfiguration<T> configuration)

Apply the builder to the given entity configuration.

Parameters:

configuration - to apply the builder to

applyAttributes

protected void applyAttributes(EntityConfiguration<T> owner,
 com.foreach.across.core.support.WritableAttributes attributes)

Overrides:

applyAttributes in class AbstractWritableAttributesBuilder<EntityConfiguration<T>>

createViewFactoryBuilder

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

Specified by:

createViewFactoryBuilder in class AbstractWritableAttributesAndViewsBuilder<EntityConfiguration<T>>

initializeViewFactoryBuilder

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

Specified by:

initializeViewFactoryBuilder in class AbstractWritableAttributesAndViewsBuilder<EntityConfiguration<T>>