Package com.foreach.across.modules.entity.views

Class DefaultEntityViewFactory

java.lang.Object

com.foreach.across.core.support.AttributeSupport

com.foreach.across.modules.entity.views.DefaultEntityViewFactory

All Implemented Interfaces:

com.foreach.across.core.support.ReadableAttributes, com.foreach.across.core.support.WritableAttributes, DispatchingEntityViewFactory, EntityViewFactory, org.springframework.core.AttributeAccessor

public class DefaultEntityViewFactory
extends com.foreach.across.core.support.AttributeSupport
implements DispatchingEntityViewFactory

Base implementation for a EntityViewFactory that supports ViewElement rendering, and dispatches its logic to EntityViewProcessor instances that have more fine-grained hooks for interacting with the view rendering.

Supports a TransactionalEntityViewProcessorRegistry. All EntityViewProcessor.doControl(EntityViewRequest, EntityView, EntityViewCommand) calls will be dispatched in a single transaction if they occur with a state altering HttpMethod like HttpMethod.POST.

Since:

2.0.0

Author:

Arne Vandamme

See Also:

• TransactionalEntityViewProcessorRegistry

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_CONTAINER_BUILDER
static final String	ATTRIBUTE_CONTAINER_ELEMENT

Constructor Summary

Constructors

Constructor	Description
DefaultEntityViewFactory()

Method Summary

Modifier and Type	Method	Description
void	authorizeRequest(EntityViewRequest entityViewRequest)	Verify the EntityViewRequest is valid for this factory.
EntityView	createView(EntityViewRequest entityViewRequest)	Create the EntityView for the given request.
protected com.foreach.across.modules.web.ui.ViewElementBuilderContext	createViewElementBuilderContext(EntityViewRequest entityViewRequest)	Create a custom ViewElementBuilderContext for the view request.
TransactionalEntityViewProcessorRegistry	getProcessorRegistry()
void	initializeCommandObject(EntityViewRequest entityViewRequest, EntityViewCommand command, org.springframework.web.bind.WebDataBinder dataBinder)	Initialize the EntityViewCommand for the given request.
void	prepareEntityViewContext(ConfigurableEntityViewContext entityViewContext)	Apply possible factory modifications to the ConfigurableEntityViewContext.
void	setProcessorRegistry(TransactionalEntityViewProcessorRegistry processorRegistry)
protected boolean	shouldDispatchInTransaction(EntityViewRequest entityViewRequest)	Should the EntityViewProcessor.doControl(EntityViewRequest, EntityView, EntityViewCommand) be executed in a wrapping transaction?

Methods inherited from class com.foreach.across.core.support.AttributeSupport

attributeMap, attributeNames, getAttribute, getAttribute, getAttribute, hasAttribute, hasAttribute, removeAttribute, removeAttribute, setAttribute, setAttribute, setAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.AttributeAccessor

computeAttribute

Methods inherited from interface com.foreach.across.core.support.ReadableAttributes

attributeMap, attributeNames, getAttribute, getAttribute, getAttribute, hasAttribute, hasAttribute

Field Details

ATTRIBUTE_CONTAINER_BUILDER

public static final String ATTRIBUTE_CONTAINER_BUILDER

See Also:

• Constant Field Values

ATTRIBUTE_CONTAINER_ELEMENT

public static final String ATTRIBUTE_CONTAINER_ELEMENT

See Also:

• Constant Field Values

Constructor Details

DefaultEntityViewFactory

public DefaultEntityViewFactory()

Method Details

prepareEntityViewContext

public void prepareEntityViewContext(ConfigurableEntityViewContext entityViewContext)

Description copied from interface: EntityViewFactory

Apply possible factory modifications to the ConfigurableEntityViewContext. Call this method before creating an EntityViewRequest that uses the context.

This method is called first, before EntityViewFactory.authorizeRequest(EntityViewRequest) in the default view rendering.

Specified by:

prepareEntityViewContext in interface EntityViewFactory

Parameters:

entityViewContext - to modify

authorizeRequest

public void authorizeRequest(EntityViewRequest entityViewRequest)

Description copied from interface: EntityViewFactory

Verify the EntityViewRequest is valid for this factory. This usually means things like performing security checks and checking all individual properties are valid.

Any invalid requests are expected to throw the most relevant exceptions.

Called after EntityViewFactory.prepareEntityViewContext(ConfigurableEntityViewContext) but before initializing the command object.

Specified by:

authorizeRequest in interface EntityViewFactory

Parameters:

entityViewRequest - request to validate

initializeCommandObject

public void initializeCommandObject(EntityViewRequest entityViewRequest,
 EntityViewCommand command,
 org.springframework.web.bind.WebDataBinder dataBinder)

Description copied from interface: EntityViewFactory

Initialize the EntityViewCommand for the given request. Optionally configure the WebDataBinder that will be used to bind the command object.

Called after EntityViewFactory.authorizeRequest(EntityViewRequest) but before data binding.

Specified by:

initializeCommandObject in interface EntityViewFactory

Parameters:

entityViewRequest - request

command - object

dataBinder - to bind the web request to the command

createView

public EntityView createView(EntityViewRequest entityViewRequest)

Description copied from interface: EntityViewFactory

Create the EntityView for the given request. This will execute the controller logic and will build all view elements required.

This method requires a valid request and a fully initialized/bound command object.

Specified by:

createView in interface EntityViewFactory

Parameters:

entityViewRequest - request

Returns:

view created

createViewElementBuilderContext

protected com.foreach.across.modules.web.ui.ViewElementBuilderContext createViewElementBuilderContext(EntityViewRequest entityViewRequest)

Create a custom ViewElementBuilderContext for the view request.

shouldDispatchInTransaction

protected boolean shouldDispatchInTransaction(EntityViewRequest entityViewRequest)

Should the EntityViewProcessor.doControl(EntityViewRequest, EntityView, EntityViewCommand) be executed in a wrapping transaction? By default this is the case for all state modifying HttpMethods.

Requires a transaction template to be set on the processorRegistry to be set as well before a transaction will be used.

Parameters:

entityViewRequest - to check

Returns:

true if transaction should be used

getProcessorRegistry

public TransactionalEntityViewProcessorRegistry getProcessorRegistry()

Specified by:

getProcessorRegistry in interface DispatchingEntityViewFactory

Returns:

the configurable registry of view processors

setProcessorRegistry

public void setProcessorRegistry(TransactionalEntityViewProcessorRegistry processorRegistry)