org.alfresco.service.cmr.ml
Interface MultilingualContentService

All Known Implementing Classes:

MultilingualContentServiceImpl

@PublicService
public interface MultilingualContentService

The API to manage multilingual content and related structures.

Method Summary

NodeRef	addEmptyTranslation(NodeRef translationOfNodeRef, java.lang.String name, java.util.Locale locale) Make a empty translation out of an existing pivot translation.
void	addTranslation(NodeRef newTranslationNodeRef, NodeRef translationOfNodeRef, java.util.Locale locale) Make a translation out of an existing document.
NodeRef	copyTranslationContainer(NodeRef mlContainerNodeRef, NodeRef newParentRef, java.lang.String prefixName) Copies the given cm:mlContainer.
void	deleteTranslationContainer(NodeRef mlContainerNodeRef) Delete the given mlContainer and its translations.
java.util.List	getMissingTranslations(NodeRef localizedNodeRef, boolean addThisNodeLocale) Given a cm:mlDocument or cm:mlContainer this node returns each locale for which there isn't a translation.
NodeRef	getPivotTranslation(NodeRef nodeRef) Given any node, this returns the pivot translation.
NodeRef	getTranslationContainer(NodeRef translationNodeRef) Convenience method for super user.
NodeRef	getTranslationForLocale(NodeRef translationNodeRef, java.util.Locale locale) Given a cm:mlDocument, this method attempts to find the best translation for the given locale.
java.util.Map	getTranslations(NodeRef translationOfNodeRef) Gets the set of sibling translations associated with the given cm:mlDocument or cm:mlContainer.
boolean	isTranslation(NodeRef contentNodeRef) Checks whether an existing document is part of a translation group.
void	makeTranslation(NodeRef contentNodeRef, java.util.Locale locale) Make an existing document into a translation by adding the cm:mlDocument aspect and creating a cm:mlContainer parent.
void	moveTranslationContainer(NodeRef mlContainerNodeRef, NodeRef newParentRef) Moves the location of the given cm:mlContainer.
void	unmakeTranslation(NodeRef translationNodeRef) Removes the node from any associated translations.

Method Detail

isTranslation

@Auditable(key=ARG_0,
           parameters="contentNodeRef")
boolean isTranslation(NodeRef contentNodeRef)

Checks whether an existing document is part of a translation group.

Parameters:

contentNodeRef - An existing cm:content

Returns:

Returns true if the document has a cm:mlContainer parent

makeTranslation

@Auditable(key=ARG_0,
           parameters={"contentNodeRef", "locale"})
void makeTranslation(NodeRef contentNodeRef,
                                                 java.util.Locale locale)

Make an existing document into a translation by adding the cm:mlDocument aspect and creating a cm:mlContainer parent. If it is already a translation, then nothing is done.

Parameters:

contentNodeRef - An existing cm:content

See Also:

ContentModel.ASPECT_MULTILINGUAL_DOCUMENT

unmakeTranslation

@Auditable(key=ARG_0,
           parameters="translationNodeRef")
void unmakeTranslation(NodeRef translationNodeRef)

Removes the node from any associated translations. If the translation is the pivot translation, then the entire set of translations will be unhooked.

Parameters:

translationNodeRef - an existing cm:mlDocument

addTranslation

@Auditable(key=ARG_0,
           parameters={"newTranslationNodeRef", "translationOfNodeRef", "locale"})
void addTranslation(NodeRef newTranslationNodeRef,
                                                NodeRef translationOfNodeRef,
                                                java.util.Locale locale)

Make a translation out of an existing document. The necessary translation structures will be created as necessary.

Parameters:

newTranslationNodeRef - An existing cm:content

translationOfNodeRef - An existing cm:mlDocument

getTranslationContainer

@Auditable(key=ARG_0,
           parameters="translationNodeRef")
NodeRef getTranslationContainer(NodeRef translationNodeRef)

Convenience method for super user.

Parameters:

translationNodeRef - An existing cm:mlDocument

Returns:

Returns the cm:mlContainer translation parent

getTranslations

@Auditable(key=ARG_0,
           parameters="translationOfNodeRef")
java.util.Map getTranslations(NodeRef translationOfNodeRef)

Gets the set of sibling translations associated with the given cm:mlDocument or cm:mlContainer.

Parameters:

translationOfNodeRef - An existing cm:mlDocument or cm:mlContainer

Returns:

Returns a map of translation nodes keyed by locale

getTranslationForLocale

@Auditable(key=ARG_0,
           parameters={"translationNodeRef", "locale"})
NodeRef getTranslationForLocale(NodeRef translationNodeRef,
                                                            java.util.Locale locale)

Given a cm:mlDocument, this method attempts to find the best translation for the given locale. If there is not even a partial match, then the pivot translation is used. If that also gives no results then the translation itself is returned.

Parameters:

translationNodeRef - the cm:mlDocument

locale - the target locale

Returns:

Returns the best match for the locale (never null)

See Also:

MultilingualContentService.getTranslations(NodeRef), I18NUtil.getNearestLocale(Locale, Set)

getMissingTranslations

@Auditable(key=ARG_0,
           parameters={"localizedNodeRef", "addThisNodeLocale"})
java.util.List getMissingTranslations(NodeRef localizedNodeRef,
                                                                  boolean addThisNodeLocale)

Given a cm:mlDocument or cm:mlContainer this node returns each locale for which there isn't a translation.

Parameters:

localizedNodeRef - the cm:mlDocument or cm:mlContainer

addThisNodeLocale - if true, add the locale of the given cm:mlDocument in the list.

Returns:

Returns a list of missng locales

getPivotTranslation

@Auditable(key=ARG_0,
           parameters="nodeRef")
NodeRef getPivotTranslation(NodeRef nodeRef)

Given any node, this returns the pivot translation. All multilingual documents belong to a group linked by a hidden parent node of type cm:mlContainer. The pivot language for the translations is stored on the parent, and the child that has the same locale is the pivot translation.

Parameters:

nodeRef - a cm:mlDocument translation or cm:mlContainer translation container

Returns:

Returns a corresponding cm:mlDocument that matches the locale of of the cm:mlContainer. null is returned if there is no pivot translation.

addEmptyTranslation

@Auditable(key=ARG_0,
           parameters={"translationOfNodeRef", "name", "locale"})
NodeRef addEmptyTranslation(NodeRef translationOfNodeRef,
                                                        java.lang.String name,
                                                        java.util.Locale locale)

Make a empty translation out of an existing pivot translation. The given translation or container will be used to find the pivot translation. Failing this, the given translation will be used directly. If no name is provided or if the name is the same as the original's then the locale will be added to the main portion of the filename, i.e.

    Document.txt --> Document_fr.txt
 

The necessary translation structures will be created as necessary.

Parameters:

translationOfNodeRef - An existing cm:mlDocument

name - The name of the file to create, or null to use the default naming convention.

Returns:

Returns the new created cm:mlEmptyTranslation

copyTranslationContainer

@Auditable(key=ARG_0,
           parameters={"mlContainerNodeRef", "newParentRef"})
NodeRef copyTranslationContainer(NodeRef mlContainerNodeRef,
                                                             NodeRef newParentRef,
                                                             java.lang.String prefixName)
                                 throws FileExistsException,
                                        FileNotFoundException,
                                        java.lang.Exception

Copies the given cm:mlContainer.

This involves the copy of the cm:mlContainer node and the copy of its cm:mlDocument.

Parameters:

translationNodeRef - The cm:mlContainer to copy

newParentRef - The new parent of the copied cm:mlDocument

prefixName - The prefix of the name of the copied translations. Can be null.

Returns:

The copied cm:mlContainer

Throws:

FileNotFoundException

FileExistsException

java.lang.Exception

moveTranslationContainer

@Auditable(key=ARG_0,
           parameters={"mlContainerNodeRef", "newParentRef"})
void moveTranslationContainer(NodeRef mlContainerNodeRef,
                                                          NodeRef newParentRef)
                              throws FileExistsException,
                                     FileNotFoundException

Moves the location of the given cm:mlContainer.

This not involves changing the cm:mlContainer node but moves its cm:mlDocument.

Parameters:

translationNodeRef - The cm:mlContainer to move

newParentRef - The new parent of the moved cm:mlDocument

Throws:

FileExistsException

FileNotFoundException

deleteTranslationContainer

@Auditable(key=ARG_0,
           parameters="mlContainerNodeRef")
void deleteTranslationContainer(NodeRef mlContainerNodeRef)

Delete the given mlContainer and its translations. The translations will lost their cm:mlDocument aspect and will be archved. The empty translations will be permanently deleted.

Parameters:

mlContainerNodeRef - The cm:mlContainer to remove