Yannick Pignot (European Commission) multilingual services

- EditionService for versioning of groups of translations - Quite a bit of trimming of whitespace that I have no intention of undoing. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5927 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-07-24 17:32:48 +00:00 · 2007-06-13 01:13:25 +00:00
parent f4c758dfe5
commit 9e836f04f8
23 changed files with 1835 additions and 1067 deletions
--- a/source/java/org/alfresco/service/cmr/ml/ContentFilterLanguagesService.java
+++ b/source/java/org/alfresco/service/cmr/ml/ContentFilterLanguagesService.java
@@ -35,7 +35,7 @@ import org.alfresco.service.PublicService;
 /**
 * This service interface provides support for content filter languages .
 * 
- * @author yanipig
+ * @author Yannick Pignot
 *
 */
@PublicService
--- a/source/java/org/alfresco/service/cmr/ml/EditionService.java
+++ b/source/java/org/alfresco/service/cmr/ml/EditionService.java
@@ -0,0 +1,95 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of
+ * the GPL, you may redistribute this Program in connection with Free/Libre
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's
+ * FLOSS exception.  You should have recieved a copy of the text describing
+ * the FLOSS exception, and it is also available here:
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.service.cmr.ml;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.version.Version;
+import org.alfresco.service.cmr.version.VersionHistory;
+import org.alfresco.service.namespace.QName;
+
+/**
+ * The API to manage editions of a mlContainer. An edition is a version of a <b>mlContainer</b>
+ *
+ * @since 2.1
+ * @author Yannick Pignot
+ */
+@PublicService
+public interface EditionService
+{
+    /**
+     * Create a new edition of an existing <b>cm:mlContainer</b> using any one of the
+     * associated <b>cm:mlDocument</b> transalations.
+     *
+     * If startingTranslationNodeRef is multilingual, it will be copied. The copy will become the pivot translation
+     * of the new Edition of the <b>cm:mlContainer</b>. The reference of the copy will be returned.
+     *
+     * @param translationNodeRef        The specific <b>cm:mlDocument</b> to use as the starting point
+     *                                  of the new edition.  All other translations will be removed.
+     */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"translationNodeRef", "versionProperties"})
+    NodeRef createEdition(NodeRef translationNodeRef, Map<String, Serializable> versionProperties);
+
+    /**
+     * Get editions of an existing <b>cm:mlContainer</b>.
+     *
+     * @param mlContainer               An existing <b>cm:mlContainer</b>
+     * @return                          The Version History of the mlContainer
+     */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"mlContainer"})
+    VersionHistory getEditions(NodeRef mlContainer);
+
+    /**
+     * Get the different <b>cm:mlDocument</b> transalation version histories of a specific edition of a <b>cm:mlContainer</b>
+     *
+     * @param mlContainerEdition            An existing version of a mlContainer
+     * @return                              The list of <b>cm:mlDocument</b> transalation versions of the edition
+     */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"mlContainerEdition"})
+    List<VersionHistory> getVersionedTranslations(Version mlContainerEdition);
+
+    /**
+     * Get the the versioned metadata of a specific <b>cm:mlDocument</b> transalation version or a specific
+     * <b>cm:mlContainer</b> version
+     *
+     * @see org.alfresco.repo.model.ml.MultilingualDocumentAspect.PROPERTIES_TO_VERSION the versioned metadata
+     * of a <b>cm:mlDocument</b> transalation added to the usual metadata versioned for a normal node.
+     *
+     * @see org.alfresco.repo.model.ml.MLContainerType.PROPERTIES_TO_VERSION the versioned metadata
+     * of a <b>cm:mlContainer</b> added to the usual metadata versioned for a normal node.
+     *
+     * @param version                       An existing version of a <b>cm:mlDocument</b> translation version or
+     *                                      an existing version of a <b>cm:mlContainer</b> version.
+     * @return                              The versioned metadata
+     */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"version"})
+    Map<QName, Serializable> getVersionedMetadatas(Version version);
+
+ }
--- a/source/java/org/alfresco/service/cmr/ml/MultilingualContentService.java
+++ b/source/java/org/alfresco/service/cmr/ml/MultilingualContentService.java
@@ -15,11 +15,11 @@
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

- * As a special exception to the terms and conditions of version 2.0 of 
- * the GPL, you may redistribute this Program in connection with Free/Libre 
- * and Open Source Software ("FLOSS") applications as described in Alfresco's 
- * FLOSS exception.  You should have recieved a copy of the text describing 
- * the FLOSS exception, and it is also available here: 
+ * As a special exception to the terms and conditions of version 2.0 of
+ * the GPL, you may redistribute this Program in connection with Free/Libre
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's
+ * FLOSS exception.  You should have recieved a copy of the text describing
+ * the FLOSS exception, and it is also available here:
 * http://www.alfresco.com/legal/licensing"
 */
 package org.alfresco.service.cmr.ml;
@@ -35,7 +35,7 @@ import org.alfresco.service.cmr.repository.NodeRef;

 /**
 * The API to manage multilingual content and related structures.
- * 
+ *
 * @author Derek Hulley
 * @author Philippe Dubois
 */
@@ -44,19 +44,19 @@ public interface MultilingualContentService
 {
    /**
     * Checks whether an existing document is part of a translation group.
-     * 
+     *
     * @param contentNodeRef            An existing <b>cm:content</b>
     * @return                          Returns <tt>true</tt> if the document has a <b>cm:mlContainer</b> parent
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"contentNodeRef"})
    boolean isTranslation(NodeRef contentNodeRef);
-    
+
    /**
     * Make an existing document into a translation by adding the <b>cm:mlDocument</b> aspect and
     * creating a <b>cm:mlContainer</b> parent.  If it is already a translation, then nothing is done.
     *
     * @param contentNodeRef            An existing <b>cm:content</b>
-     * 
+     *
     * @see org.alfresco.model.ContentModel#ASPECT_MULTILINGUAL_DOCUMENT
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"contentNodeRef", "locale"})
@@ -65,12 +65,12 @@ public interface MultilingualContentService
    /**
     * Removes the node from any associated translations.  If the translation is the
     * pivot translation, then the entire set of translations will be unhooked.
-     * 
+     *
     * @param translationNodeRef        an existing <b>cm:mlDocument</b>
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"translationNodeRef"})
    void unmakeTranslation(NodeRef translationNodeRef);
-    
+
    /**
     * Make a translation out of an existing document.  The necessary translation structures will be created
     * as necessary.
@@ -90,61 +90,51 @@ public interface MultilingualContentService
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"translationNodeRef"})
    NodeRef getTranslationContainer(NodeRef translationNodeRef);

-    /**
-     * Create a new edition of an existing <b>cm:mlContainer</b> using any one of the
-     * associated <b>cm:mlDocument</b> transalations.
-     *
-     * @param translationNodeRef        The specific <b>cm:mlDocument</b> to use as the starting point
-     *                                  of the new edition.  All other translations will be removed.
-     */
-    @Auditable(key = Auditable.Key.ARG_0, parameters = {"translationNodeRef"})
-    void createEdition(NodeRef translationNodeRef);
-
    /**
     * Gets the set of sibling translations associated with the given <b>cm:mlDocument</b> or
     * <b>cm:mlContainer</b>.
-     * 
+     *
     * @param translationOfNodeRef      An existing <b>cm:mlDocument</b> or <b>cm:mlContainer</b>
     * @return                          Returns a map of translation nodes keyed by locale
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"translationOfNodeRef"})
    Map<Locale, NodeRef> getTranslations(NodeRef translationOfNodeRef);
-    
+
    /**
     * Given a <b>cm:mlDocument</b>, this method attempts to find the best translation for the given
     * locale.  If there is not even a
     * {@link org.alfresco.i18n.I18NUtil#getNearestLocale(Locale, Set) partial match}, then the
     * {@link #getPivotTranslation(NodeRef) pivot translation} is used.  If that also gives no results
     * then the translation itself is returned.
-     * 
+     *
     * @param translationNodeRef        the <b>cm:mlDocument</b>
     * @param locale                    the target locale
     * @return                          Returns the best match for the locale (never <tt>null</tt>)
-     * 
+     *
     * @see #getTranslations(NodeRef)
     * @see org.alfresco.i18n.I18NUtil#getNearestLocale(Locale, Set)
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"translationNodeRef", "locale"})
    NodeRef getTranslationForLocale(NodeRef translationNodeRef, Locale locale);
-    
-    
+
+
    /**
     * Given a <b>cm:mlDocument</b> or <b>cm:mlContainer</b> this node returns each locale for
-     * which there isn't a translation. 
-     * 
+     * which there isn't a translation.
+     *
     * @param localizedNodeRef          the <b>cm:mlDocument</b> or <b>cm:mlContainer</b>
-     * @param addThisNodeLocale         if true, add the locale of the given <b>cm:mlDocument</b> in the list.  
+     * @param addThisNodeLocale         if true, add the locale of the given <b>cm:mlDocument</b> in the list.
     * @return                          Returns a list of missng locales
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"localizedNodeRef", "addThisNodeLocale"})
    List<Locale> getMissingTranslations(NodeRef localizedNodeRef, boolean addThisNodeLocale);
-            
+
    /**
     * Given any node, this returns the pivot translation.  All multilingual documents belong to
     * a group linked by a hidden parent node of type <b>cm:mlContainer</b>.  The pivot language
     * for the translations is stored on the parent, and the child that has the same locale is the
     * pivot translation.
-     * 
+     *
     * @param nodeRef       a <b>cm:mlDocument</b> translation or <b>cm:mlContainer</b> translation
     *                      container
     * @return              Returns a corresponding <b>cm:mlDocument</b> that matches the locale of
@@ -153,7 +143,7 @@ public interface MultilingualContentService
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
    NodeRef getPivotTranslation(NodeRef nodeRef);
-    
+
    /**
     * 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
@@ -164,12 +154,40 @@ public interface MultilingualContentService
     * </pre>
     * <p/>
     * The necessary translation structures will be created as necessary.
-     * 
+     *
     * @param translationOfNodeRef      An existing <b>cm:mlDocument</b>
     * @param name                      The name of the file to create, or <tt>null</tt> to use
     *                                  the default naming convention.
-     * @return Returns                  the new created <b>cm:mlEmptyTranslation</b> 
+     * @return Returns                  the new created <b>cm:mlEmptyTranslation</b>
     */
    @Auditable(key = Auditable.Key.ARG_0, parameters = {"translationOfNodeRef", "name", "locale"})
    NodeRef addEmptyTranslation(NodeRef translationOfNodeRef, String name, Locale locale);
+
+    /**
+     * Copies the given <b>cm:mlContainer</b>.
+     * <p>
+     * This involves the copy of the <b>cm:mlContainer</b> node and the copy of its <b>cm:mlDocument</b>.
+     * <p>
+     *
+     * @param translationNodeRef            The <b>cm:mlContainer</b> to copy
+     * @param newParentRef                  The new parent of the copied <b>cm:mlDocument</b>
+     * @return                              The copied <b>cm:mlContainer</b>
+     */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"translationNodeRef", "newParentRef"})
+    NodeRef copyTranslationContainer(NodeRef translationNodeRef, NodeRef newParentRef);
+
+    /**
+     * Moves the location of the given <b>cm:mlContainer</b>.
+     * <p>
+     * This not involves changing the <b>cm:mlContainer</b> node but moves its <b>cm:mlDocument</b>.
+     * <p>
+     *
+     * @param translationNodeRef            The <b>cm:mlContainer</b> to move
+     * @param newParentRef                  The new parent of the moved <b>cm:mlDocument</b>
+     */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"translationNodeRef", "newParentRef"})
+    void moveTranslationContainer(NodeRef translationNodeRef, NodeRef newParentRef);
+
+
+
 }