com.foreach.across.modules.webcms.domain.component.model

Class WebCmsComponentModelHierarchy

java.lang.Object

com.foreach.across.modules.webcms.domain.component.model.WebCmsComponentModelHierarchy

@Component
 @Exposed
 @Scope(value="request",
       proxyMode=TARGET_CLASS)
public class WebCmsComponentModelHierarchy
extends Object

Represents an ordered hierarchy of WebCmsComponentModelSets that have a scope name. Components can be looked up by name in the hierarchy in which case (depending on the parameter) all registered sets will be queried in reverse order until a result is returned.

The hierarchy will always contain an initial scope name GLOBAL and DOMAIN. Both scopes will fetch a component from the repository only when it is requested. If no current domain is active, the DOMAIN scope will be an alias to GLOBAL. Otherwise the DOMAIN scope will contain all components shared across that domain.

Since:

0.0.2

Author:

Arne Vandamme

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSET
static String	CONTAINER
static String	DEFAULT
static String	DOMAIN
static String	GLOBAL
static String	REQUEST_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
WebCmsComponentModelHierarchy()

Method Summary

Modifier and Type	Method and Description
boolean	containsScope(String scopeName)
WebCmsComponentModel	get(String componentName) Get the component by name by traversing the entire hierarchy bottom up.
WebCmsComponentModel	get(String componentName, boolean searchParentScopes) Get the component by name and optionally traverse the hierarchy.
WebCmsComponentModelSet	getComponentsForScope(String scopeName)
String	getDefaultScope() Get the first scope that will be checked when requesting a component.
WebCmsComponentModel	getFromScope(String componentName, String scopeName) Get the component by name from the specific scope.
WebCmsComponentModel	getFromScope(String componentName, String scopeName, boolean searchParentScopes) Get the component by name from a specific scope.
Collection<String>	getScopeNames()
void	registerAliasForScope(String alias, String targetScopeName) Add an alias for another scope.
void	registerComponentsForScope(WebCmsComponentModelSet componentModelSet, String scopeName) Add a set of components to the very end of the hierarchy.
boolean	removeComponents(String scopeName) Removes the components for that scope.
boolean	removeComponents(WebCmsComponentModelSet componentModelSet)
void	setScopeOrder(String... scopeNames) Re-order all scopes.

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_ATTRIBUTE

public static final String REQUEST_ATTRIBUTE

See Also:

Constant Field Values

GLOBAL

public static final String GLOBAL

See Also:

Constant Field Values

DEFAULT

public static final String DEFAULT

See Also:

Constant Field Values

DOMAIN

public static final String DOMAIN

See Also:

Constant Field Values

ASSET

public static final String ASSET

See Also:

Constant Field Values

CONTAINER

public static final String CONTAINER

See Also:

Constant Field Values

Constructor Detail

WebCmsComponentModelHierarchy

public WebCmsComponentModelHierarchy()

Method Detail

registerComponentsForScope

public void registerComponentsForScope(WebCmsComponentModelSet componentModelSet,
                                       String scopeName)

Add a set of components to the very end of the hierarchy. If a new scope name is specified, this scope will be registered as the first scope to look in. If an existing scope name is specified, the components will be replaced but the query order of that scope will not change.

If an alias is being replaced by a separate set, it will be inserted right before the scope it was originally an alias for (so it will be queried earlier).

Parameters:

componentModelSet - to add

scopeName - for which to register components

removeComponents

public boolean removeComponents(String scopeName)

Removes the components for that scope. If the scope is an alias for another scope, only the alias will be removed but the actual components will still be available under the original scope name.

If the scope name is not an alias, the entire scope - including itse aliases - will be removed.

Returns:

true if the component set for that scope has been removed

removeComponents

public boolean removeComponents(WebCmsComponentModelSet componentModelSet)

Returns:

true if component set has been removed

getComponentsForScope

public WebCmsComponentModelSet getComponentsForScope(String scopeName)

Parameters:

scopeName - name

Returns:

components registered to that scope

setScopeOrder

public void setScopeOrder(String... scopeNames)

Re-order all scopes. All registered scope names must be mentioned or an exception will be thrown. Any unknown scope name will be ignored.

Scope names are defined left-to-right but scopes will be traversed right-to-left when looking for components.

If the names contains one or more aliases, the earliest occurrence of the entire set will be used.

Parameters:

scopeNames - in order

getScopeNames

public Collection<String> getScopeNames()

Returns:

all registered scope names in their order - this will not show aliases

getDefaultScope

public String getDefaultScope()

Get the first scope that will be checked when requesting a component.

Returns:

scope name or null if the hierarchy is empty

get

public WebCmsComponentModel get(String componentName)

Get the component by name by traversing the entire hierarchy bottom up.

Parameters:

componentName - name of the component

Returns:

component or null if not found

get

public WebCmsComponentModel get(String componentName,
                                boolean searchParentScopes)

Get the component by name and optionally traverse the hierarchy.

Parameters:

componentName - name of the component

searchParentScopes - true if parent scopes should be searched as well

Returns:

component or null if not found

getFromScope

public WebCmsComponentModel getFromScope(String componentName,
                                         String scopeName)

Get the component by name from the specific scope. Will not search any other (parent) scopes.

Parameters:

componentName - name of the component

scopeName - name of the scope to start with

Returns:

component or null if not found

getFromScope

public WebCmsComponentModel getFromScope(String componentName,
                                         String scopeName,
                                         boolean searchParentScopes)

Get the component by name from a specific scope. Optionally traverse parent scopes looking for the component.

Parameters:

componentName - name of the component

scopeName - name of the scope to start with

searchParentScopes - true if parent scopes should be searched as well

Returns:

component or null if not found

registerAliasForScope

public void registerAliasForScope(String alias,
                                  String targetScopeName)

Add an alias for another scope. The target scope must exist. Any other set already registered under that alias will be removed.

Parameters:

alias - to add

targetScopeName - the alias is for

containsScope

public boolean containsScope(String scopeName)

Returns:

true if components scope is registered