Package org.ametys.core.cocoon

Class XMLResourceBundleFactory

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.i18n.XMLResourceBundleFactory

org.ametys.core.cocoon.XMLResourceBundleFactory

All Implemented Interfaces:

Observer, Prioritizable, Supporter<Event>, Disposable, Initializable, Component, Configurable, LogEnabled, Serviceable, ThreadSafe, BundleFactory

public class XMLResourceBundleFactory
extends XMLResourceBundleFactory
implements Observer, Initializable

This XMLResourceBundleFactory creates a Bundle for XML resources which can be invalidated

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cocoon.i18n.BundleFactory

BundleFactory.ConfigurationKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUNDLE_CACHE	bundle cache id

Fields inherited from class org.apache.cocoon.i18n.XMLResourceBundleFactory

cache, directory, interval, manager, resolver

Fields inherited from interface org.apache.cocoon.i18n.BundleFactory

ROLE

Fields inherited from interface org.ametys.core.observation.Observer

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
XMLResourceBundleFactory()

Method Summary

Modifier and Type	Method	Description
protected void	_createCache()	Create the i18n cache
protected Cache<String,Bundle>	_getBundleCache()	get the i18n cache (link language and I18nizable text to a translated value)
void	configure(Configuration configuration)
protected XMLResourceBundle	create(String sourceURI, Locale locale, XMLResourceBundle parent)
int	getPriority()	Get the priority for the component.
void	initialize()
void	invalidateCatalogue(String location, String name, String localeName)	Invalidate catalogue
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
Bundle	select(String[] directories, String name, Locale locale)
void	service(ServiceManager smanager)
boolean	supports(Event event)	Check if an element is supported

Methods inherited from class org.apache.cocoon.i18n.XMLResourceBundleFactory

dispose, getCacheKey, getDirectory, getParentLocale, getSourceURI, release, select, select, select, select, selectCached, updateCache

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.observation.Observer

getTraits

Field Details

BUNDLE_CACHE

public static final String BUNDLE_CACHE

bundle cache id

Constructor Details

XMLResourceBundleFactory

public XMLResourceBundleFactory()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class XMLResourceBundleFactory

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class XMLResourceBundleFactory

Throws:

ConfigurationException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

create

protected XMLResourceBundle create(String sourceURI,
 Locale locale,
 XMLResourceBundle parent)

Overrides:

create in class XMLResourceBundleFactory

invalidateCatalogue

public void invalidateCatalogue(String location,
 String name,
 String localeName)
                         throws ComponentException

Invalidate catalogue

Parameters:

location - catalogue base location (URI)

name - bundle name

localeName - locale name

Throws:

ComponentException - If an error occurred

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority

supports

public boolean supports(Event event)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<Event>

Parameters:

event - The element

Returns:

true if the element is supported, false otherwise

observe

public void observe(Event event,
 Map<String,Object> transientVars)
             throws Exception

Description copied from interface: Observer

Observes an event.

Specified by:

observe in interface Observer

Parameters:

event - the event.

transientVars - transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.

Throws:

Exception - if an error occurs. All exceptions will be logged but not propagated, as the observation mechanism should never fail.

select

public Bundle select(String[] directories,
 String name,
 Locale locale)
              throws ComponentException

Specified by:

select in interface BundleFactory

Overrides:

select in class XMLResourceBundleFactory

Throws:

ComponentException

_getBundleCache

protected Cache<String,Bundle> _getBundleCache()

get the i18n cache (link language and I18nizable text to a translated value)

Returns:

the i18n cache

_createCache

protected void _createCache()

Create the i18n cache