org.exoplatform.services.cms.i18n

Interface MultiLanguageService

All Known Implementing Classes:

MultiLanguageServiceImpl

public interface MultiLanguageService

Author : Hung Nguyen Quang nguyenkequanghung@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMENTS Node name as COMMENTS
static String	EXO_LANGUAGE Property name as EXO_LANGUAGE
static String	LANGUAGES Node name as LANGUAGES

Method Summary

Modifier and Type	Method and Description
void	addFileLanguage(javax.jcr.Node node, String language, Map mappings, boolean isDefault) Add newLanguageNode node, then set property in mapping to newLanguageNode
void	addFileLanguage(javax.jcr.Node node, String fileName, javax.jcr.Value value, String mimeType, String language, String repositoryName, boolean isDefault) Add newLanguageNode node, then add new file to newLanguageNode
void	addFolderLanguage(javax.jcr.Node node, Map inputs, String language, boolean isDefault, String nodeType, String repositoryName) Add new language node as a folder
void	addLanguage(javax.jcr.Node node, Map inputs, String language, boolean isDefault) Add new language for current node Set value of property in inputs Map to new language node
void	addLanguage(javax.jcr.Node node, Map inputs, String language, boolean isDefault, String nodeType) Add new language for current node Processing for some new added node Set value of property in inputs Map to new language node Processing for nodeType in child node of current node and some new added node
void	addLinkedLanguage(javax.jcr.Node node, javax.jcr.Node translationNode) Add newLanguageNode node with a symlink, based on exo:language targetNode property
void	addLinkedLanguage(javax.jcr.Node node, javax.jcr.Node translationNode, boolean overrideExistence) Add newLanguageNode node with a symlink, based on exo:language targetNode property
void	addSynchronizedLinkedLanguage(javax.jcr.Node selectedNode, javax.jcr.Node newTranslationNode) Add new translation for one node and synchronize all related translation nodes.
String	getDefault(javax.jcr.Node node) Get value of property exo:language in current node
javax.jcr.Node	getLanguage(javax.jcr.Node node, String language) Get node following relative path = "languages/" + language
List<String>	getSupportedLanguages(javax.jcr.Node node) Get list of value in exo:language property in child node of current node
void	setDefault(javax.jcr.Node node, String language, String repositoryName) Set data for current node

Field Detail

LANGUAGES

static final String LANGUAGES

Node name as LANGUAGES

See Also:

Constant Field Values

EXO_LANGUAGE

static final String EXO_LANGUAGE

Property name as EXO_LANGUAGE

See Also:

Constant Field Values

COMMENTS

static final String COMMENTS

Node name as COMMENTS

See Also:

Constant Field Values

Method Detail

getSupportedLanguages

List<String> getSupportedLanguages(javax.jcr.Node node)
                            throws Exception

Get list of value in exo:language property in child node of current node

Parameters:

node - current node

Returns:

value of exo:language property

Throws:

Exception

setDefault

void setDefault(javax.jcr.Node node,
                String language,
                String repositoryName)
         throws Exception

Set data for current node

Parameters:

node - current node

language - language name

repositoryName - repository name

Throws:

Exception

addLanguage

void addLanguage(javax.jcr.Node node,
                 Map inputs,
                 String language,
                 boolean isDefault)
          throws Exception

Add new language for current node Set value of property in inputs Map to new language node

Parameters:

node - current node

inputs - Map includes key and value of property

language - language name

isDefault - flag to define default language is used or not

Throws:

Exception

addLanguage

void addLanguage(javax.jcr.Node node,
                 Map inputs,
                 String language,
                 boolean isDefault,
                 String nodeType)
          throws Exception

Add new language for current node Processing for some new added node Set value of property in inputs Map to new language node Processing for nodeType in child node of current node and some new added node

Parameters:

node - current node

inputs - Map includes key and value of property

language - language name

isDefault - flag to define default language is used or not

nodeType - node name

Throws:

Exception

addFileLanguage

void addFileLanguage(javax.jcr.Node node,
                     String fileName,
                     javax.jcr.Value value,
                     String mimeType,
                     String language,
                     String repositoryName,
                     boolean isDefault)
              throws Exception

Add newLanguageNode node, then add new file to newLanguageNode

Parameters:

node - current node

fileName - name of file

value - value of file

mimeType - mimiType

language - language name

repositoryName - repository name

isDefault - flag to use new language or default language

Throws:

Exception

addFileLanguage

void addFileLanguage(javax.jcr.Node node,
                     String language,
                     Map mappings,
                     boolean isDefault)
              throws Exception

Add newLanguageNode node, then set property in mapping to newLanguageNode

Parameters:

node - current node

language - language name

mappings - Map includes property and value

isDefault - flag to use new language or default language

Throws:

Exception

addLinkedLanguage

void addLinkedLanguage(javax.jcr.Node node,
                       javax.jcr.Node translationNode)
                throws Exception

Add newLanguageNode node with a symlink, based on exo:language targetNode property

Parameters:

node - current node

translationNode - target translation node

Throws:

Exception

addLinkedLanguage

void addLinkedLanguage(javax.jcr.Node node,
                       javax.jcr.Node translationNode,
                       boolean overrideExistence)
                throws Exception

Add newLanguageNode node with a symlink, based on exo:language targetNode property

Parameters:

node - current node

translationNode - target translation node

overrideExistence - true if override existing symlink pointing to other translation, else throw ItemExistsException

Throws:

Exception

addSynchronizedLinkedLanguage

void addSynchronizedLinkedLanguage(javax.jcr.Node selectedNode,
                                   javax.jcr.Node newTranslationNode)
                            throws Exception

Add new translation for one node and synchronize all related translation nodes.

Parameters:

selectedNode - Selected Node

newTranslationNode - New Translation Node

Throws:

Exception

addFolderLanguage

void addFolderLanguage(javax.jcr.Node node,
                       Map inputs,
                       String language,
                       boolean isDefault,
                       String nodeType,
                       String repositoryName)
                throws Exception

Add new language node as a folder

Parameters:

node -

inputs -

language -

isDefault -

nodeType -

repositoryName -

Throws:

Exception

getDefault

String getDefault(javax.jcr.Node node)
           throws Exception

Get value of property exo:language in current node

Parameters:

node - current node

Returns:

value of exo:language property

Throws:

Exception

getLanguage

javax.jcr.Node getLanguage(javax.jcr.Node node,
                           String language)
                    throws Exception

Get node following relative path = "languages/" + language

Parameters:

node -

language -

Returns:

node if exist node with relative path = "languages/" + language with current node null if not exist

Throws:

Exception