Package org.ametys.core.resources

Class I18nTextResourceHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.resources.SimpleResourceHandler

org.ametys.core.resources.I18nTextResourceHandler

All Implemented Interfaces:

ResourceHandler, LogEnabled, Contextualizable, Serviceable

Direct Known Subclasses:

JSResourceHandler

public class I18nTextResourceHandler
extends SimpleResourceHandler
implements Contextualizable

This class generates a translated version of an input file. It is designed to handle the following notation : {{i18n x}}
When encountering this pattern, we instantiate an I18nizableText with x and try to translate it.
Unknown translations are logged and do not prevent the generation process from continuing.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The application context

Fields inherited from class org.ametys.core.resources.SimpleResourceHandler

_objectModel, _parameters, _readForDownload, _requestedLocation, _resolver, _source

Constructor Summary

Constructors

Constructor	Description
I18nTextResourceHandler()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
void	generate(OutputStream out)	Generate the resource configured during setup, and output it
Serializable	getKey()	Get the unique key for this resource, for cache purpose.
protected String	getLocale()	Retrieve the locale from the parameters
void	service(ServiceManager serviceManager)
Source	setup(String location, Map objectModel, Parameters parameters, boolean readForDownload)	Initialize the resource handler with a resource.

Methods inherited from class org.ametys.core.resources.SimpleResourceHandler

getLastModified, getMimeType, getValidity

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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.resources.ResourceHandler

acceptRanges, generate, getLength, shouldUseSourceContentLength

Field Details

_context

protected Context _context

The application context

Constructor Details

I18nTextResourceHandler

public I18nTextResourceHandler()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SimpleResourceHandler

Throws:

ServiceException

setup

public Source setup(String location,
 Map objectModel,
 Parameters parameters,
 boolean readForDownload)
             throws ProcessingException,
IOException

Description copied from interface: ResourceHandler

Initialize the resource handler with a resource.

Specified by:

setup in interface ResourceHandler

Overrides:

setup in class SimpleResourceHandler

Parameters:

location - The source uri

objectModel - The object model

parameters - The parameters

readForDownload - if the resource is to be downloaded and not rendered.

Returns:

the resolved source

Throws:

ProcessingException - If an error occurs

IOException - If an error occurs

getLocale

protected String getLocale()

Retrieve the locale from the parameters

Returns:

The locale, or null

generate

public void generate(OutputStream out)
              throws IOException,
ProcessingException

Description copied from interface: ResourceHandler

Generate the resource configured during setup, and output it

Specified by:

generate in interface ResourceHandler

Overrides:

generate in class SimpleResourceHandler

Parameters:

out - The output stream to write to

Throws:

IOException - If an error occurs

ProcessingException - If an error occurs

getKey

public Serializable getKey()

Description copied from interface: ResourceHandler

Get the unique key for this resource, for cache purpose.

Specified by:

getKey in interface ResourceHandler

Overrides:

getKey in class SimpleResourceHandler

Returns:

The cache key.