Package org.ametys.plugins.workflow.support

Class I18nHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workflow.support.I18nHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class I18nHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for saxing i18n catalogs

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected I18nUtils	_i18nUtils	I18n Utils
protected ObservationManager	_observationManager	The observation manager
protected SourceResolver	_sourceResolver	The source resolver
protected WorkflowHelper	_workflowHelper	The workflow helper
protected WorkflowLanguageManager	_workflowLanguageManager	The workflow language manager
protected WorkflowSessionHelper	_workflowSessionHelper	The workflow session helper
static final String	ROLE	The helper role

Constructor Summary

Constructors

Constructor	Description
I18nHelper()

Method Summary

Modifier and Type	Method	Description
protected void	_saveI18nCatalog(Map<I18nizableText,String> i18nMessages, String catalogPath, String language)	Save the i18n catalog with new values
static String	buildI18nWorkflowKey(String workflowName)	Build an i18n key for workflows like "WORKFLOW_[WORKFLOW_NAME]"
void	clearCaches()	Clear the i18n caches (ametys and cocoon)
Map<String,Map<I18nizableText,String>>	createNewI18nCatalogs(Map<I18nizableText,Map<String,String>> translationsToConvert)	Generate i18n catalog from workflow's new i18n translations
I18nizableText	generateI18nKey(String workflowName, String type, int workflowElementId)	Generate unique key for workflow element label
String	getI18nDefaultLanguage()	Get the default language to use for the i18n translation
String	getPrefixCatalogLocation(String catalogName)	Get the overridable catalog location for a plugin, workspace or application.
I18nizableText	getWorkflowLabelKey(String workflowName)	Transform workflow name in unique I18n key
Map<I18nizableText,String>	readI18nCatalog(Map<String,Map<I18nizableText,String>> i18nCatalogs, String path, String currentCatalog)	Read existing i18n catalog
void	saveCatalogs(Map<String,Map<I18nizableText,String>> newI18nMessages, String currentCatalog)	Sax new messages into i18N catalogs
void	service(ServiceManager manager)
String	translateKey(String workflowName, I18nizableText i18nKey, I18nizableText defaultKey)	Translate i18n label for workflow element, return a default name if translation is not found

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

Field Details

ROLE

public static final String ROLE

The helper role

_i18nUtils

protected I18nUtils _i18nUtils

I18n Utils

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

_workflowSessionHelper

protected WorkflowSessionHelper _workflowSessionHelper

The workflow session helper

_workflowLanguageManager

protected WorkflowLanguageManager _workflowLanguageManager

The workflow language manager

_sourceResolver

protected SourceResolver _sourceResolver

The source resolver

_observationManager

protected ObservationManager _observationManager

The observation manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

I18nHelper

public I18nHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getI18nDefaultLanguage

public String getI18nDefaultLanguage()

Get the default language to use for the i18n translation

Returns:

a language code

translateKey

public String translateKey(String workflowName,
 I18nizableText i18nKey,
 I18nizableText defaultKey)

Translate i18n label for workflow element, return a default name if translation is not found

Parameters:

workflowName - the workflow's unique name

i18nKey - an i18n key pointing to workflow element's label

defaultKey - a default i18n key for workflow element

Returns:

a translated label

getWorkflowLabelKey

public I18nizableText getWorkflowLabelKey(String workflowName)

Transform workflow name in unique I18n key

Parameters:

workflowName - the workflow's unique name

Returns:

the workflow label I18n Key

generateI18nKey

public I18nizableText generateI18nKey(String workflowName,
 String type,
 int workflowElementId)

Generate unique key for workflow element label

Parameters:

workflowName - the workflow's unique name

type - the workflow's element type

workflowElementId - the element's id

Returns:

a unique i18n key

saveCatalogs

public void saveCatalogs(Map<String,Map<I18nizableText,String>> newI18nMessages,
 String currentCatalog)
                  throws Exception

Sax new messages into i18N catalogs

Parameters:

newI18nMessages - catalog of the new i18N messages, key is language, value is map of i18nKeys, translation

currentCatalog - the current catalog

Throws:

Exception - exception while reading file

clearCaches

public void clearCaches()

Clear the i18n caches (ametys and cocoon)

createNewI18nCatalogs

public Map<String,Map<I18nizableText,String>> createNewI18nCatalogs(Map<I18nizableText,Map<String,String>> translationsToConvert)

Generate i18n catalog from workflow's new i18n translations

Parameters:

translationsToConvert - the workflow to save's translation list: keys are future i18n key, values are maps of language codes and translations

Returns:

a map of i18n catalogs : keys are languages, values are pair of i18nkey, translation

readI18nCatalog

public Map<I18nizableText,String> readI18nCatalog(Map<String,Map<I18nizableText,String>> i18nCatalogs,
 String path,
 String currentCatalog)

Read existing i18n catalog

Parameters:

i18nCatalogs - map of already read catalogs

path - the path to the file to read

currentCatalog - the catalog of the current workflow

Returns:

the messages in the catalog as map

_saveI18nCatalog

protected void _saveI18nCatalog(Map<I18nizableText,String> i18nMessages,
 String catalogPath,
 String language)

Save the i18n catalog with new values

Parameters:

i18nMessages - the messages to save

catalogPath - the path to the catalog

language - the language of the translations

getPrefixCatalogLocation

public String getPrefixCatalogLocation(String catalogName)

Get the overridable catalog location for a plugin, workspace or application.

Parameters:

catalogName - The catalog name

Returns:

the location

buildI18nWorkflowKey

public static String buildI18nWorkflowKey(String workflowName)

Build an i18n key for workflows like "WORKFLOW_[WORKFLOW_NAME]"

Parameters:

workflowName - the workflow name

Returns:

the built key