Package com.foreach.across.modules.entity.registry

Class EntityConfigurationImpl<T>

java.lang.Object

com.foreach.across.core.support.AttributeSupport

com.foreach.across.modules.entity.registry.EntityConfigurationImpl<T>

All Implemented Interfaces:

com.foreach.across.core.support.ReadableAttributes, com.foreach.across.core.support.WritableAttributes, ConfigurableEntityViewRegistry, EntityConfiguration<T>, EntityViewRegistry, MutableEntityConfiguration<T>, org.springframework.core.AttributeAccessor

public class EntityConfigurationImpl<T>
extends com.foreach.across.core.support.AttributeSupport
implements MutableEntityConfiguration<T>

The base configuration for an Entity type. Provides access to the EntityModel, EntityPropertyRegistry along with the registered views and attributes.

Since:

1.0.0

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor	Description
EntityConfigurationImpl(@NonNull String name, @NonNull Class<? extends T> entityType)
EntityConfigurationImpl(Class<T> entityType)

Method Summary

Modifier and Type	Method	Description
MutableEntityAssociation	association(String name)	Retrieve a named association as a MutableEntityAssociation.
MutableEntityAssociation	createAssociation(String name)	Register a new association with a specific name.
com.foreach.across.modules.spring.security.actions.AllowableActions	getAllowableActions()
com.foreach.across.modules.spring.security.actions.AllowableActions	getAllowableActions(T entity)
EntityConfigurationAllowableActionsBuilder	getAllowableActionsBuilder()
Collection<EntityAssociation>	getAssociations()
String	getDisplayName()
EntityMessageCodeResolver	getEntityMessageCodeResolver()
EntityModel<T,Serializable>	getEntityModel()
Class<? extends T>	getEntityType()
Serializable	getId(T entity)	Shortcut to EntityInformation.getId(Object).
Class<?>	getIdType()	Shortcut to EntityInformation.getIdType()}.
String	getLabel(T entity)	Shortcut to EntityModel.getLabel(Object).
String	getName()
MutableEntityPropertyRegistry	getPropertyRegistry()	Get the property registry as a MutableEntityPropertyRegistry.
<Y extends EntityViewFactory> Y	getViewFactory(String viewName)
String[]	getViewNames()
boolean	hasEntityModel()
boolean	hasView(String viewName)
boolean	isHidden()
boolean	isNew(T entity)	Shortcut to EntityInformation.isNew(Object).
void	registerView(@NonNull String viewName, @NonNull EntityViewFactory viewFactory)
void	removeView(String viewName)	Remove a view from the registry.
void	setAllowableActionsBuilder(@NonNull EntityConfigurationAllowableActionsBuilder allowableActionsBuilder)	Set the builder for the AllowableActions of this entity configuration.
void	setDisplayName(String displayName)	Set the default display name for this entity type.
void	setEntityMessageCodeResolver(@NonNull EntityMessageCodeResolver entityMessageCodeResolver)	Set the message code resolver.
void	setEntityModel(EntityModel<T,Serializable> entityModel)	Set the EntityModel for interacting with the entity repository.
void	setHidden(boolean hidden)	Should this configuration be shown in UI implementations?
void	setPropertyRegistry(@NonNull MutableEntityPropertyRegistry propertyRegistry)	Set the property registry for this configuration.
String	toString()

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, wait, wait, wait

Methods inherited from interface org.springframework.core.AttributeAccessor

attributeNames, computeAttribute, getAttribute, hasAttribute, removeAttribute, setAttribute

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

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

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

removeAttribute, setAttribute, setAttributes

Constructor Details

EntityConfigurationImpl

public EntityConfigurationImpl(Class<T> entityType)

EntityConfigurationImpl

public EntityConfigurationImpl(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull Class<? extends T> entityType)

Method Details

getEntityModel

public EntityModel<T,Serializable> getEntityModel()

Specified by:

getEntityModel in interface EntityConfiguration<T>

Returns:

basic model for performing entity operations

hasEntityModel

public boolean hasEntityModel()

Specified by:

hasEntityModel in interface EntityConfiguration<T>

Returns:

true if this configuration actually has an entity model configured

setEntityModel

public void setEntityModel(EntityModel<T,Serializable> entityModel)

Description copied from interface: MutableEntityConfiguration

Set the EntityModel for interacting with the entity repository. Required for auto-generated administration UI.

Specified by:

setEntityModel in interface MutableEntityConfiguration<T>

Parameters:

entityModel - instance

getEntityType

public Class<? extends T> getEntityType()

Specified by:

getEntityType in interface EntityConfiguration<T>

Returns:

simple class that instances of this entity are.

getName

public String getName()

Specified by:

getName in interface EntityConfiguration<T>

Returns:

unique name for this configuration

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface EntityConfiguration<T>

Returns:

default display name to use in the UI

See Also:

• EntityMessageCodeResolver

setDisplayName

public void setDisplayName(String displayName)

Description copied from interface: MutableEntityConfiguration

Set the default display name for this entity type.

Specified by:

setDisplayName in interface MutableEntityConfiguration<T>

Parameters:

displayName - value

isHidden

public boolean isHidden()

Specified by:

isHidden in interface EntityConfiguration<T>

Returns:

true if this configuration should not be displayed in UI implementations

setHidden

public void setHidden(boolean hidden)

Description copied from interface: MutableEntityConfiguration

Should this configuration be shown in UI implementations?

Specified by:

setHidden in interface MutableEntityConfiguration<T>

Parameters:

hidden - true if this configuration should not be shown in UI implementations

hasView

public boolean hasView(String viewName)

Specified by:

hasView in interface EntityViewRegistry

registerView

public void registerView(@NonNull
 @NonNull String viewName,
 @NonNull
 @NonNull EntityViewFactory viewFactory)

Specified by:

registerView in interface ConfigurableEntityViewRegistry

removeView

public void removeView(String viewName)

Description copied from interface: ConfigurableEntityViewRegistry

Remove a view from the registry.

Specified by:

removeView in interface ConfigurableEntityViewRegistry

Parameters:

viewName - name of the view

getViewFactory

public <Y extends EntityViewFactory> Y getViewFactory(String viewName)

Specified by:

getViewFactory in interface EntityViewRegistry

getViewNames

public String[] getViewNames()

Specified by:

getViewNames in interface EntityViewRegistry

getPropertyRegistry

public MutableEntityPropertyRegistry getPropertyRegistry()

Description copied from interface: MutableEntityConfiguration

Get the property registry as a MutableEntityPropertyRegistry.

Specified by:

getPropertyRegistry in interface EntityConfiguration<T>

Specified by:

getPropertyRegistry in interface MutableEntityConfiguration<T>

Returns:

mutable instance of the property registry

setPropertyRegistry

public void setPropertyRegistry(@NonNull
 @NonNull MutableEntityPropertyRegistry propertyRegistry)

Description copied from interface: MutableEntityConfiguration

Set the property registry for this configuration.

Specified by:

setPropertyRegistry in interface MutableEntityConfiguration<T>

Parameters:

propertyRegistry - instancce

getEntityMessageCodeResolver

public EntityMessageCodeResolver getEntityMessageCodeResolver()

Specified by:

getEntityMessageCodeResolver in interface EntityConfiguration<T>

Returns:

message code resolver to use for resolving messages in the context of this entity type

setEntityMessageCodeResolver

public void setEntityMessageCodeResolver(@NonNull
 @NonNull EntityMessageCodeResolver entityMessageCodeResolver)

Description copied from interface: MutableEntityConfiguration

Set the message code resolver.

Specified by:

setEntityMessageCodeResolver in interface MutableEntityConfiguration<T>

Parameters:

entityMessageCodeResolver - instance

isNew

public boolean isNew(T entity)

Description copied from interface: EntityConfiguration

Shortcut to EntityInformation.isNew(Object).

Specified by:

isNew in interface EntityConfiguration<T>

Parameters:

entity - instance

Returns:

true if new (unsaved) entity instance

getIdType

public Class<?> getIdType()

Description copied from interface: EntityConfiguration

Shortcut to EntityInformation.getIdType()}.

Specified by:

getIdType in interface EntityConfiguration<T>

Returns:

type of the id parameter of this entity (can be null)

getId

public Serializable getId(T entity)

Description copied from interface: EntityConfiguration

Shortcut to EntityInformation.getId(Object).

Specified by:

getId in interface EntityConfiguration<T>

Parameters:

entity - instance

Returns:

id value of the entity

getLabel

public String getLabel(T entity)

Description copied from interface: EntityConfiguration

Shortcut to EntityModel.getLabel(Object).

Specified by:

getLabel in interface EntityConfiguration<T>

Parameters:

entity - instance

Returns:

label valud of the entity

getAssociations

public Collection<EntityAssociation> getAssociations()

Specified by:

getAssociations in interface EntityConfiguration<T>

Returns:

list of associations this entity has to others

createAssociation

public MutableEntityAssociation createAssociation(String name)

Description copied from interface: MutableEntityConfiguration

Register a new association with a specific name. Should return any already existing association with that name.

Specified by:

createAssociation in interface MutableEntityConfiguration<T>

Parameters:

name - of the association

Returns:

mutable instance of the association

association

public MutableEntityAssociation association(String name)

Description copied from interface: MutableEntityConfiguration

Retrieve a named association as a MutableEntityAssociation.

Specified by:

association in interface EntityConfiguration<T>

Specified by:

association in interface MutableEntityConfiguration<T>

Parameters:

name - of the association

Returns:

mutable instance of the association (or null if non existing)

getAllowableActionsBuilder

public EntityConfigurationAllowableActionsBuilder getAllowableActionsBuilder()

Specified by:

getAllowableActionsBuilder in interface MutableEntityConfiguration<T>

Returns:

the allowable actions builder instance

setAllowableActionsBuilder

public void setAllowableActionsBuilder(@NonNull
 @NonNull EntityConfigurationAllowableActionsBuilder allowableActionsBuilder)

Description copied from interface: MutableEntityConfiguration

Set the builder for the AllowableActions of this entity configuration.

Specified by:

setAllowableActionsBuilder in interface MutableEntityConfiguration<T>

Parameters:

allowableActionsBuilder - instance

getAllowableActions

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

Specified by:

getAllowableActions in interface EntityConfiguration<T>

Returns:

the set of actions allowed on all entities of this EntityConfiguration

getAllowableActions

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

Specified by:

getAllowableActions in interface EntityConfiguration<T>

Parameters:

entity - for which to fetch the allowed actions

Returns:

the set of actions allowed on the specific entity

toString

public String toString()

Overrides:

toString in class Object