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

Class DefaultEntityViewContext

java.lang.Object

com.foreach.across.modules.entity.views.context.DefaultEntityViewContext

All Implemented Interfaces:

ConfigurableEntityViewContext, EntityViewContext

@Component
@Exposed
@Scope(scopeName="request",
       proxyMode=INTERFACES)
public class DefaultEntityViewContext
extends Object
implements ConfigurableEntityViewContext

Default implementation of ConfigurableEntityViewContext. Data bean that is also registered as a request-scoped proxy.

Since:

2.0.0

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor	Description
DefaultEntityViewContext()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
com.foreach.across.modules.spring.security.actions.AllowableActions	getAllowableActions()
Object	getEntity()	Get the current entity being viewed as raw object.
<T> T	getEntity(Class<T> entityType)	Get the current entity being viewed.
EntityAssociation	getEntityAssociation()
EntityConfiguration	getEntityConfiguration()
String	getEntityLabel()
EntityMessages	getEntityMessages()
EntityModel	getEntityModel()
EntityViewLinkBuilder	getLinkBuilder()
EntityMessageCodeResolver	getMessageCodeResolver()
EntityViewContext	getParentContext()	If set the parent context will hold the parent entity this entity is associated to.
EntityPropertyRegistry	getPropertyRegistry()
int	hashCode()
boolean	holdsEntity()
boolean	isForAssociation()
void	setAllowableActions(com.foreach.across.modules.spring.security.actions.AllowableActions allowableActions)
void	setEntity(Object entity)
void	setEntityAssociation(EntityAssociation entityAssociation)
void	setEntityConfiguration(EntityConfiguration entityConfiguration)
void	setEntityMessages(EntityMessages entityMessages)
void	setEntityModel(EntityModel entityModel)
void	setLinkBuilder(EntityViewLinkBuilder linkBuilder)
void	setMessageCodeResolver(EntityMessageCodeResolver messageCodeResolver)
void	setParentContext(EntityViewContext parentContext)
void	setPropertyRegistry(EntityPropertyRegistry propertyRegistry)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DefaultEntityViewContext

public DefaultEntityViewContext()

Method Details

setEntityConfiguration

public void setEntityConfiguration(EntityConfiguration entityConfiguration)

Specified by:

setEntityConfiguration in interface ConfigurableEntityViewContext

setEntity

public void setEntity(Object entity)

Specified by:

setEntity in interface ConfigurableEntityViewContext

getEntityLabel

public String getEntityLabel()

Specified by:

getEntityLabel in interface EntityViewContext

Returns:

the label for the current entity being viewed

getEntity

public <T> T getEntity(Class<T> entityType)

Description copied from interface: EntityViewContext

Get the current entity being viewed.

Specified by:

getEntity in interface EntityViewContext

Type Parameters:

T - type the entity should have

Returns:

entity or null if none present

holdsEntity

public boolean holdsEntity()

Specified by:

holdsEntity in interface EntityViewContext

Returns:

true if an existing entity is present

isForAssociation

public boolean isForAssociation()

Specified by:

isForAssociation in interface EntityViewContext

Returns:

true if an association is being viewed, if so both EntityViewContext.getParentContext() and EntityViewContext.getEntityAssociation() should return values

setAllowableActions

public void setAllowableActions(com.foreach.across.modules.spring.security.actions.AllowableActions allowableActions)

Specified by:

setAllowableActions in interface ConfigurableEntityViewContext

getAllowableActions

public com.foreach.across.modules.spring.security.actions.AllowableActions getAllowableActions()

Specified by:

getAllowableActions in interface EntityViewContext

Returns:

the allowable actions for this entity view, will either return the allowable actions for the specific entity, or for the general entity configuration if no entity is set

toString

public String toString()

Overrides:

toString in class Object

getEntity

public Object getEntity()

Description copied from interface: EntityViewContext

Get the current entity being viewed as raw object.

Specified by:

getEntity in interface EntityViewContext

Returns:

entity or null if none present

getEntityConfiguration

public EntityConfiguration getEntityConfiguration()

Specified by:

getEntityConfiguration in interface EntityViewContext

Returns:

the current entity configuration being viewed

getLinkBuilder

public EntityViewLinkBuilder getLinkBuilder()

Specified by:

getLinkBuilder in interface EntityViewContext

Returns:

link builder for the entity

getMessageCodeResolver

public EntityMessageCodeResolver getMessageCodeResolver()

Specified by:

getMessageCodeResolver in interface EntityViewContext

Returns:

message code resolver for the current entity

getEntityMessages

public EntityMessages getEntityMessages()

Specified by:

getEntityMessages in interface EntityViewContext

Returns:

generic EntityMessages for common views

getEntityAssociation

public EntityAssociation getEntityAssociation()

Specified by:

getEntityAssociation in interface EntityViewContext

Returns:

association that is being viewed

getParentContext

public EntityViewContext getParentContext()

Description copied from interface: EntityViewContext

If set the parent context will hold the parent entity this entity is associated to.

Specified by:

getParentContext in interface EntityViewContext

Returns:

parent context, can be null if EntityViewContext.isForAssociation() returns false

getEntityModel

public EntityModel getEntityModel()

Specified by:

getEntityModel in interface EntityViewContext

Returns:

the model to use for the current entity

getPropertyRegistry

public EntityPropertyRegistry getPropertyRegistry()

Specified by:

getPropertyRegistry in interface EntityViewContext

Returns:

the EntityPropertyRegistry that should be used for this view

setLinkBuilder

public void setLinkBuilder(EntityViewLinkBuilder linkBuilder)

Specified by:

setLinkBuilder in interface ConfigurableEntityViewContext

setMessageCodeResolver

public void setMessageCodeResolver(EntityMessageCodeResolver messageCodeResolver)

Specified by:

setMessageCodeResolver in interface ConfigurableEntityViewContext

setEntityMessages

public void setEntityMessages(EntityMessages entityMessages)

Specified by:

setEntityMessages in interface ConfigurableEntityViewContext

setEntityAssociation

public void setEntityAssociation(EntityAssociation entityAssociation)

Specified by:

setEntityAssociation in interface ConfigurableEntityViewContext

setParentContext

public void setParentContext(EntityViewContext parentContext)

Specified by:

setParentContext in interface ConfigurableEntityViewContext

setEntityModel

public void setEntityModel(EntityModel entityModel)

Specified by:

setEntityModel in interface ConfigurableEntityViewContext

setPropertyRegistry

public void setPropertyRegistry(EntityPropertyRegistry propertyRegistry)

Specified by:

setPropertyRegistry in interface ConfigurableEntityViewContext

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object