Package org.apache.tiles.definition.pattern

Class AbstractPatternDefinitionResolver<T>

java.lang.Object

org.apache.tiles.definition.pattern.AbstractPatternDefinitionResolver<T>

Type Parameters:

T - The type of the customization key.

All Implemented Interfaces:

PatternDefinitionResolver<T>

Direct Known Subclasses:

BasicPatternDefinitionResolver, PrefixedPatternDefinitionResolver

public abstract class AbstractPatternDefinitionResolver<T>
extends java.lang.Object
implements PatternDefinitionResolver<T>

A pattern definition resolver that stores DefinitionPatternMatcher separated by customization key.
Implementations should provide a way to translate a definition to a DefinitionPatternMatcher.

Since:

2.2.0

Version:

$Rev: 1539385 $ $Date: 2013-11-07 03:24:13 +1100 (Thu, 07 Nov 2013) $

Constructor Summary

Constructors

Constructor	Description
AbstractPatternDefinitionResolver()

Method Summary

Modifier and Type	Method	Description
protected abstract java.util.Map<java.lang.String,Definition>	addDefinitionsAsPatternMatchers(java.util.List<DefinitionPatternMatcher> matchers, java.util.Map<java.lang.String,Definition> defsMap)	Adds definitions, filtering and adding them to the list of definition pattern matchers.
void	clearPatternPaths(T customizationKey)	Used to clear all entries in the localePatternPaths for a specific locale.
Definition	resolveDefinition(java.lang.String name, T customizationKey)	Resolves a definition searching in all patterns for the requested customization key.
java.util.Map<java.lang.String,Definition>	storeDefinitionPatterns(java.util.Map<java.lang.String,Definition> localeDefsMap, T customizationKey)	Stores definition patterns.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPatternDefinitionResolver

public AbstractPatternDefinitionResolver()

Method Detail

resolveDefinition

public Definition resolveDefinition(java.lang.String name,
                                    T customizationKey)

Resolves a definition searching in all patterns for the requested customization key.

Specified by:

resolveDefinition in interface PatternDefinitionResolver<T>

Parameters:

name - The name of the definition.

customizationKey - The customization key.

Returns:

The resolved definition.

storeDefinitionPatterns

public java.util.Map<java.lang.String,Definition> storeDefinitionPatterns(java.util.Map<java.lang.String,Definition> localeDefsMap,
                                                                          T customizationKey)

Stores definition patterns.

Specified by:

storeDefinitionPatterns in interface PatternDefinitionResolver<T>

Parameters:

localeDefsMap - The map of definitions that may contain also patterns.

customizationKey - The customization key.

Returns:

The map of the definitions not recognized as containing definition patterns.

addDefinitionsAsPatternMatchers

protected abstract java.util.Map<java.lang.String,Definition> addDefinitionsAsPatternMatchers(java.util.List<DefinitionPatternMatcher> matchers,
                                                                                              java.util.Map<java.lang.String,Definition> defsMap)

Adds definitions, filtering and adding them to the list of definition pattern matchers. Only a subset of definitions will be transformed into definition pattern matchers.

Parameters:

matchers - The list containing the currently stored definition pattern matchers.

defsMap - The definition map to parse.

Returns:

The map of the definitions not recognized as containing definition patterns.

Since:

2.2.1

clearPatternPaths

public void clearPatternPaths(T customizationKey)

Used to clear all entries in the localePatternPaths for a specific locale. Necessary when reloading definition files to ensure that the list is cleared first

Specified by:

clearPatternPaths in interface PatternDefinitionResolver<T>

Parameters:

customizationKey -