Class ResolvingLocaleUrlDefinitionDAO
java.lang.Object
org.apache.tiles.core.definition.dao.BaseLocaleUrlDefinitionDAO
org.apache.tiles.core.definition.dao.CachingLocaleUrlDefinitionDAO
org.apache.tiles.core.definition.dao.ResolvingLocaleUrlDefinitionDAO
- All Implemented Interfaces:
DefinitionDAO<Locale>
,PatternDefinitionResolverAware<Locale>
,RefreshMonitor
A definitions DAO (loading URLs and using Locale as a customization key) that caches definitions that have been loaded and resolves inheritances.
It can check if the URLs change, but by default this feature is turned off.
- Since:
- 2.1.0
-
Field Summary
Fields inherited from class org.apache.tiles.core.definition.dao.CachingLocaleUrlDefinitionDAO
CHECK_REFRESH_INIT_PARAMETER, checkRefresh, definitionResolver, locale2definitionMap
Fields inherited from class org.apache.tiles.core.definition.dao.BaseLocaleUrlDefinitionDAO
applicationContext, lastModifiedDates, reader, sources
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected Map<String,
Definition> copyDefinitionMap
(Map<String, Definition> localeDefsMap) Copies the definition map to be passed to a higher level of customization key.protected Definition
getDefinitionFromResolver
(String name, Locale customizationKey) Returns a definition from the definition resolver.protected Map<String,
Definition> loadDefinitions
(Locale customizationKey) Tries to load definitions if necessary.protected Map<String,
Definition> loadParentDefinitions
(Locale parentLocale) Loads parent definitions, i.e.protected void
resolveInheritance
(Definition definition, Map<String, Definition> definitions, Locale locale, Set<String> alreadyResolvedDefinitions) Resolve locale-specific inheritance.protected void
resolveInheritances
(Map<String, Definition> map, Locale locale) Resolve locale-specific extended instances.Methods inherited from class org.apache.tiles.core.definition.dao.CachingLocaleUrlDefinitionDAO
checkAndloadDefinitions, getDefinition, getDefinitions, loadDefinitionsFromResources, loadRawDefinitionsFromResources, setCheckRefresh, setPatternDefinitionResolver
Methods inherited from class org.apache.tiles.core.definition.dao.BaseLocaleUrlDefinitionDAO
loadDefinitionsFromResource, refreshRequired, setReader, setSources
-
Constructor Details
-
ResolvingLocaleUrlDefinitionDAO
-
-
Method Details
-
loadParentDefinitions
Loads parent definitions, i.e. definitions mapped to a parent locale.- Overrides:
loadParentDefinitions
in classCachingLocaleUrlDefinitionDAO
- Parameters:
parentLocale
- The locale to use when loading URLs.- Returns:
- The loaded parent definitions.
-
loadDefinitions
Description copied from class:CachingLocaleUrlDefinitionDAO
Tries to load definitions if necessary.- Overrides:
loadDefinitions
in classCachingLocaleUrlDefinitionDAO
- Parameters:
customizationKey
- The locale to use when loading sources.- Returns:
- The loaded definitions.
-
getDefinitionFromResolver
Returns a definition from the definition resolver.- Overrides:
getDefinitionFromResolver
in classCachingLocaleUrlDefinitionDAO
- Parameters:
name
- The name of the definition.customizationKey
- The customization key to use.- Returns:
- The resolved definition.
-
resolveInheritances
Resolve locale-specific extended instances.- Parameters:
map
- The definition map containing the definitions to resolve.locale
- The locale to use.- Throws:
NoSuchDefinitionException
- If a parent definition is not found.- Since:
- 2.1.0
-
resolveInheritance
protected void resolveInheritance(Definition definition, Map<String, Definition> definitions, Locale locale, Set<String> alreadyResolvedDefinitions) Resolve locale-specific inheritance. First, resolve parent's inheritance, then set template to the parent's template. Also copy attributes setted in parent, and not set in child If instance doesn't extend anything, do nothing.- Parameters:
definition
- The definition to resolvedefinitions
- The definitions to take when obtaining a parent definition.locale
- The locale to use.alreadyResolvedDefinitions
- The set of the definitions that have been already resolved.- Throws:
NoSuchDefinitionException
- If an inheritance can not be solved.- Since:
- 2.1.0
-
copyDefinitionMap
Copies the definition map to be passed to a higher level of customization key.- Overrides:
copyDefinitionMap
in classCachingLocaleUrlDefinitionDAO
- Parameters:
localeDefsMap
- The map of definition to be copied.- Returns:
- The copy of the definition map. This particular implementation
deep-copies the
localeDefsMap
into aLinkedHashMap
. - Since:
- 2.1.4
-