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

Class ViewElementLookupRegistryImpl

java.lang.Object

com.foreach.across.modules.entity.views.ViewElementLookupRegistryImpl

All Implemented Interfaces:

ViewElementLookupRegistry, Cloneable

public class ViewElementLookupRegistryImpl
extends Object
implements ViewElementLookupRegistry

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor	Description
ViewElementLookupRegistryImpl()

Method Summary

Modifier and Type	Method	Description
void	addViewElementPostProcessor(ViewElementMode mode, com.foreach.across.modules.web.ui.ViewElementPostProcessor<?> postProcessor)	Add a ViewElementPostProcessor that should be applied to the element builder.
boolean	cacheViewElementBuilder(ViewElementMode mode, com.foreach.across.modules.web.ui.ViewElementBuilder builder)	If ViewElementLookupRegistry.isCacheable(ViewElementMode) returns false this call will have no effect and return value should also be false.
void	clearCache()	Removes all cached builders.
ViewElementLookupRegistryImpl	clone()
com.foreach.across.modules.web.ui.ViewElementBuilder	getCachedViewElementBuilder(ViewElementMode mode)	Retrieve the (optionally) cached builder.
com.foreach.across.modules.web.ui.ViewElementBuilder	getViewElementBuilder(ViewElementMode mode)
Collection<com.foreach.across.modules.web.ui.ViewElementPostProcessor<?>>	getViewElementPostProcessors(ViewElementMode mode)
String	getViewElementType(ViewElementMode mode)
boolean	isCacheable(ViewElementMode mode)	If the result of a certain mode is cacheable, this means that an external EntityViewElementBuilderService can store back the results of a type lookup or builder creation.
boolean	isDefaultCacheable()
boolean	isEmpty()	Checks whether any lookup values have been applied to the registry.
void	mergeInto(ViewElementLookupRegistry existing)	Merge the current values into an already existing registry.
void	reset(ViewElementMode mode)	Removes the cached builder for the given mode.
void	setCacheable(ViewElementMode mode, boolean cacheable)	Sets the cacheable status for a given mode.
void	setDefaultCacheable(boolean defaultCacheable)
void	setViewElementBuilder(ViewElementMode mode, com.foreach.across.modules.web.ui.ViewElementBuilder builder)	Set the fixed ViewElementBuilder for lookups.
void	setViewElementType(ViewElementMode mode, String viewElementType)	Set the view element type for subsequent lookup.

Methods inherited from class java.lang.Object

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

Constructor Details

ViewElementLookupRegistryImpl

public ViewElementLookupRegistryImpl()

Method Details

isDefaultCacheable

public boolean isDefaultCacheable()

setDefaultCacheable

public void setDefaultCacheable(boolean defaultCacheable)

setViewElementBuilder

public void setViewElementBuilder(ViewElementMode mode,
 com.foreach.across.modules.web.ui.ViewElementBuilder builder)

Description copied from interface: ViewElementLookupRegistry

Set the fixed ViewElementBuilder for lookups. If set, this builder will always be returned.

Specified by:

setViewElementBuilder in interface ViewElementLookupRegistry

Parameters:

mode - to register the builder for

builder - instance to store

addViewElementPostProcessor

public void addViewElementPostProcessor(ViewElementMode mode,
 com.foreach.across.modules.web.ui.ViewElementPostProcessor<?> postProcessor)

Description copied from interface: ViewElementLookupRegistry

Add a ViewElementPostProcessor that should be applied to the element builder.

Specified by:

addViewElementPostProcessor in interface ViewElementLookupRegistry

Parameters:

mode - to register the postprocessor for

postProcessor - to add

cacheViewElementBuilder

public boolean cacheViewElementBuilder(ViewElementMode mode,
 com.foreach.across.modules.web.ui.ViewElementBuilder builder)

Description copied from interface: ViewElementLookupRegistry

If ViewElementLookupRegistry.isCacheable(ViewElementMode) returns false this call will have no effect and return value should also be false.

Specified by:

cacheViewElementBuilder in interface ViewElementLookupRegistry

Parameters:

mode - to register the builder for

builder - instance to store

Returns:

true if the builder was actually stored

getViewElementType

public String getViewElementType(ViewElementMode mode)

Specified by:

getViewElementType in interface ViewElementLookupRegistry

Parameters:

mode - to create the type for

Returns:

the registered view element type - null if none available

setViewElementType

public void setViewElementType(ViewElementMode mode,
 String viewElementType)

Description copied from interface: ViewElementLookupRegistry

Set the view element type for subsequent lookup.

Specified by:

setViewElementType in interface ViewElementLookupRegistry

Parameters:

mode - to register the type for

viewElementType - to store

setCacheable

public void setCacheable(ViewElementMode mode,
 boolean cacheable)

Description copied from interface: ViewElementLookupRegistry

Sets the cacheable status for a given mode.

Specified by:

setCacheable in interface ViewElementLookupRegistry

Parameters:

mode - to set the status for

cacheable - true if subsequent calls can be cached

reset

public void reset(ViewElementMode mode)

Description copied from interface: ViewElementLookupRegistry

Removes the cached builder for the given mode.

Specified by:

reset in interface ViewElementLookupRegistry

Parameters:

mode - to remove the cached builder for

getViewElementBuilder

public com.foreach.across.modules.web.ui.ViewElementBuilder getViewElementBuilder(ViewElementMode mode)

Specified by:

getViewElementBuilder in interface ViewElementLookupRegistry

Parameters:

mode - to create the builder for

Returns:

the registered builder - null if none available

getCachedViewElementBuilder

public com.foreach.across.modules.web.ui.ViewElementBuilder getCachedViewElementBuilder(ViewElementMode mode)

Description copied from interface: ViewElementLookupRegistry

Retrieve the (optionally) cached builder. Will return null if either not cached or not cacheable.

Specified by:

getCachedViewElementBuilder in interface ViewElementLookupRegistry

Parameters:

mode - to get the builder for

Returns:

the registered builder - null if none available

clearCache

public void clearCache()

Description copied from interface: ViewElementLookupRegistry

Removes all cached builders.

Specified by:

clearCache in interface ViewElementLookupRegistry

getViewElementPostProcessors

public Collection<com.foreach.across.modules.web.ui.ViewElementPostProcessor<?>> getViewElementPostProcessors(ViewElementMode mode)

Specified by:

getViewElementPostProcessors in interface ViewElementLookupRegistry

Parameters:

mode - to get the postprocessors for

Returns:

collection of postprocessors

isCacheable

public boolean isCacheable(ViewElementMode mode)

Description copied from interface: ViewElementLookupRegistry

If the result of a certain mode is cacheable, this means that an external EntityViewElementBuilderService can store back the results of a type lookup or builder creation. Usually a ViewElementBuilder can be cached.

Specified by:

isCacheable in interface ViewElementLookupRegistry

Parameters:

mode - to check for

Returns:

true if a builder can be cached

isEmpty

public boolean isEmpty()

Description copied from interface: ViewElementLookupRegistry

Checks whether any lookup values have been applied to the registry.

Specified by:

isEmpty in interface ViewElementLookupRegistry

mergeInto

public void mergeInto(ViewElementLookupRegistry existing)

Merge the current values into an already existing registry. This will clear the entire cache of the target registry.

Parameters:

existing - to merge the values in

clone

public ViewElementLookupRegistryImpl clone()

Specified by:

clone in interface ViewElementLookupRegistry

Overrides:

clone in class Object

Returns:

cloned instance