|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tiles.definition.dao.BaseLocaleUrlDefinitionDAO
org.apache.tiles.definition.dao.CachingLocaleUrlDefinitionDAO
public class CachingLocaleUrlDefinitionDAO
A definitions DAO (loading URLs and using Locale as a customization key) that caches definitions that have been loaded in a raw way (i.e. with inheritance that is not resolved).
It can check if the URLs change, but by default this feature is turned off.
Nested Class Summary | |
---|---|
protected class |
CachingLocaleUrlDefinitionDAO.WildcardMapping
Maps a pattern with a definition in cache. |
Field Summary | |
---|---|
static java.lang.String |
CHECK_REFRESH_INIT_PARAMETER
Initialization parameter to set whether we want to refresh URLs when they change. |
protected boolean |
checkRefresh
Flag that, when true , enables automatic checking of URLs
changing. |
protected java.util.Map<java.util.Locale,java.util.Map<java.lang.String,Definition>> |
locale2definitionMap
The locale-specific set of definitions objects. |
protected java.util.Map<java.util.Locale,java.util.List<CachingLocaleUrlDefinitionDAO.WildcardMapping>> |
localePatternPaths
Stores patterns depending on the locale they refer to. |
protected WildcardHelper |
wildcardHelper
An object that helps in resolving definitions with wildcards. |
Fields inherited from class org.apache.tiles.definition.dao.BaseLocaleUrlDefinitionDAO |
---|
applicationContext, lastModifiedDates, reader, sourceURLs |
Constructor Summary | |
---|---|
CachingLocaleUrlDefinitionDAO()
Constructor. |
Method Summary | |
---|---|
protected void |
addWildcardPaths(java.util.List<CachingLocaleUrlDefinitionDAO.WildcardMapping> paths,
java.util.Map<java.lang.String,Definition> defsMap)
Adds wildcard paths that are stored inside a normal definition map. |
protected java.util.Map<java.lang.String,Definition> |
checkAndloadDefinitions(java.util.Locale customizationKey)
Checks if URLs have changed. |
Definition |
getDefinition(java.lang.String name,
java.util.Locale customizationKey)
Returns a definition, given its name and the customization key. |
java.util.Map<java.lang.String,Definition> |
getDefinitions(java.util.Locale customizationKey)
Returns all the definitions used of a customization key. |
void |
init(java.util.Map<java.lang.String,java.lang.String> params)
Initializes the object. |
protected java.util.Map<java.lang.String,Definition> |
loadDefinitions(java.util.Locale customizationKey)
Tries to load definitions if necessary. |
protected java.util.Map<java.lang.String,Definition> |
loadDefinitionsFromURLs(java.util.Locale customizationKey)
Loads definitions from the URLs. |
protected java.util.Map<java.lang.String,Definition> |
loadParentDefinitions(java.util.Locale parentLocale)
Loads parent definitions, i.e. definitions mapped to a parent locale. |
protected void |
postDefinitionLoadOperations(java.util.Map<java.lang.String,Definition> localeDefsMap,
java.util.Locale customizationKey)
Tries to load definitions if necessary. |
void |
refresh()
Refreshes the stored definitions, reloading them. |
protected java.lang.String |
replace(java.lang.String st,
java.util.Map<java.lang.Integer,java.lang.String> vars)
Replaces a string with placeholders using values of a variable map. |
protected Definition |
replaceDefinition(Definition d,
java.lang.String name,
java.util.Map<java.lang.Integer,java.lang.String> vars)
Creates a definition given its representation with wildcards. |
protected Definition |
resolveWildcardDefinition(java.util.List<CachingLocaleUrlDefinitionDAO.WildcardMapping> paths,
java.lang.String name)
Try to resolve a wildcard definition. |
void |
setCheckRefresh(boolean checkRefresh)
Sets the flag to check URL refresh. |
Methods inherited from class org.apache.tiles.definition.dao.BaseLocaleUrlDefinitionDAO |
---|
addSourceURL, getResourceNames, getResourceString, identifySources, loadDefinitionsFromURL, refreshRequired, setApplicationContext, setReader, setSourceURLs |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.tiles.definition.RefreshMonitor |
---|
refreshRequired |
Field Detail |
---|
public static final java.lang.String CHECK_REFRESH_INIT_PARAMETER
protected java.util.Map<java.util.Locale,java.util.Map<java.lang.String,Definition>> locale2definitionMap
protected boolean checkRefresh
true
, enables automatic checking of URLs
changing.
protected WildcardHelper wildcardHelper
protected java.util.Map<java.util.Locale,java.util.List<CachingLocaleUrlDefinitionDAO.WildcardMapping>> localePatternPaths
Constructor Detail |
---|
public CachingLocaleUrlDefinitionDAO()
Method Detail |
---|
public void init(java.util.Map<java.lang.String,java.lang.String> params)
init
in interface Initializable
init
in class BaseLocaleUrlDefinitionDAO
params
- The map of parameters.public Definition getDefinition(java.lang.String name, java.util.Locale customizationKey)
getDefinition
in interface DefinitionDAO<java.util.Locale>
name
- The name of the definition.customizationKey
- The customization key.
null
.
The inheritance of the definition must not be resolved.public java.util.Map<java.lang.String,Definition> getDefinitions(java.util.Locale customizationKey)
getDefinitions
in interface DefinitionDAO<java.util.Locale>
customizationKey
- The customization key.
public void refresh()
refresh
in interface Refreshable
public void setCheckRefresh(boolean checkRefresh)
false
.
checkRefresh
- When true
, enables automatic checking
of URLs changing.protected java.util.Map<java.lang.String,Definition> checkAndloadDefinitions(java.util.Locale customizationKey)
customizationKey
- The locale to use when loading URLs.
protected java.util.Map<java.lang.String,Definition> loadDefinitions(java.util.Locale customizationKey)
customizationKey
- The locale to use when loading URLs.
protected java.util.Map<java.lang.String,Definition> loadDefinitionsFromURLs(java.util.Locale customizationKey)
customizationKey
- The locale to use when loading URLs.
protected java.util.Map<java.lang.String,Definition> loadParentDefinitions(java.util.Locale parentLocale)
parentLocale
- The locale to use when loading URLs.
protected void postDefinitionLoadOperations(java.util.Map<java.lang.String,Definition> localeDefsMap, java.util.Locale customizationKey)
localeDefsMap
- The loaded definitions.customizationKey
- The locale to use when loading URLs.protected void addWildcardPaths(java.util.List<CachingLocaleUrlDefinitionDAO.WildcardMapping> paths, java.util.Map<java.lang.String,Definition> defsMap)
paths
- The list containing the currently stored paths.defsMap
- The definition map to parse.protected Definition resolveWildcardDefinition(java.util.List<CachingLocaleUrlDefinitionDAO.WildcardMapping> paths, java.lang.String name)
paths
- The list containing the currently stored paths.name
- The name of the definition to resolve.
null
if not.protected Definition replaceDefinition(Definition d, java.lang.String name, java.util.Map<java.lang.Integer,java.lang.String> vars)
d
- The definition to replace.name
- The name of the definition to be created.vars
- The variables to be substituted.
protected java.lang.String replace(java.lang.String st, java.util.Map<java.lang.Integer,java.lang.String> vars)
st
- The string to replace.vars
- The variables.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |