com.liferay.portlet.journal.lar
Class JournalPortletDataHandlerImpl

java.lang.Object
  extended by com.liferay.portal.lar.BasePortletDataHandler
      extended by com.liferay.portlet.journal.lar.JournalPortletDataHandlerImpl
All Implemented Interfaces:
com.liferay.portal.lar.PortletDataHandler

public class JournalPortletDataHandlerImpl
extends com.liferay.portal.lar.BasePortletDataHandler

View Source

Provides the Journal portlet export and import functionality, which is to clone all articles, structures, and templates associated with the layout's group. Upon import, new instances of the corresponding articles, structures, and templates are created or updated according to the DATA_MIRROW strategy The author of the newly created objects are determined by the JournalCreationStrategy class defined in portal.properties. That strategy also allows the text of the journal article to be modified prior to import.

This PortletDataHandler differs from JournalContentPortletDataHandlerImpl in that it exports all articles owned by the group whether or not they are actually displayed in a portlet in the layout set.

Author:
Raymond Augé, Joel Kozikowski, Brian Wing Shun Chan, Bruno Farache, Karthik Sudarshan
See Also:
PortletDataHandler, JournalContentPortletDataHandlerImpl, JournalCreationStrategy

Constructor Summary
JournalPortletDataHandlerImpl()
           
 
Method Summary
 javax.portlet.PortletPreferences deleteData(com.liferay.portal.lar.PortletDataContext context, java.lang.String portletId, javax.portlet.PortletPreferences preferences)
           
static void exportArticle(com.liferay.portal.lar.PortletDataContext context, com.liferay.portal.kernel.xml.Element articlesEl, com.liferay.portal.kernel.xml.Element dlFoldersEl, com.liferay.portal.kernel.xml.Element dlFileEntriesEl, com.liferay.portal.kernel.xml.Element dlFileRanks, com.liferay.portal.kernel.xml.Element igFoldersEl, com.liferay.portal.kernel.xml.Element igImagesEl, com.liferay.portlet.journal.model.JournalArticle article)
           
 java.lang.String exportData(com.liferay.portal.lar.PortletDataContext context, java.lang.String portletId, javax.portlet.PortletPreferences preferences)
           
static java.lang.String exportDLFileEntries(com.liferay.portal.lar.PortletDataContext context, com.liferay.portal.kernel.xml.Element foldersEl, com.liferay.portal.kernel.xml.Element fileEntriesEl, com.liferay.portal.kernel.xml.Element fileRanks, long entityGroupId, java.lang.String content)
           
static void exportFeed(com.liferay.portal.lar.PortletDataContext context, com.liferay.portal.kernel.xml.Element feedsEl, com.liferay.portlet.journal.model.JournalFeed feed)
           
static java.lang.String exportIGImages(com.liferay.portal.lar.PortletDataContext context, com.liferay.portal.kernel.xml.Element foldersEl, com.liferay.portal.kernel.xml.Element imagesEl, long entityGroupId, java.lang.String content)
           
static void exportStructure(com.liferay.portal.lar.PortletDataContext context, com.liferay.portal.kernel.xml.Element structuresEl, com.liferay.portlet.journal.model.JournalStructure structure)
           
static void exportTemplate(com.liferay.portal.lar.PortletDataContext context, com.liferay.portal.kernel.xml.Element templatesEl, com.liferay.portal.kernel.xml.Element dlFoldersEl, com.liferay.portal.kernel.xml.Element dlFileEntriesEl, com.liferay.portal.kernel.xml.Element dlFileRanks, com.liferay.portal.kernel.xml.Element igFoldersEl, com.liferay.portal.kernel.xml.Element igImagesEl, com.liferay.portlet.journal.model.JournalTemplate template)
           
protected static java.lang.String getArticleImagePath(com.liferay.portal.lar.PortletDataContext context, com.liferay.portlet.journal.model.JournalArticle article)
           
protected static java.lang.String getArticleImagePath(com.liferay.portal.lar.PortletDataContext context, com.liferay.portlet.journal.model.JournalArticle article, com.liferay.portlet.journal.model.JournalArticleImage articleImage, com.liferay.portal.model.Image image)
           
protected static java.lang.String getArticlePath(com.liferay.portal.lar.PortletDataContext context, com.liferay.portlet.journal.model.JournalArticle article)
           
protected static java.lang.String getArticleSmallImagePath(com.liferay.portal.lar.PortletDataContext context, com.liferay.portlet.journal.model.JournalArticle article)
           
 com.liferay.portal.lar.PortletDataHandlerControl[] getExportControls()
           
protected static java.lang.String getFeedPath(com.liferay.portal.lar.PortletDataContext context, com.liferay.portlet.journal.model.JournalFeed feed)
           
 com.liferay.portal.lar.PortletDataHandlerControl[] getImportControls()
           
protected static java.lang.String getImportStructurePath(com.liferay.portal.lar.PortletDataContext context, java.lang.String structureId)
           
protected static java.lang.String getImportTemplatePath(com.liferay.portal.lar.PortletDataContext context, java.lang.String templateId)
           
protected static java.lang.String getImportTemplateSmallImagePath(com.liferay.portal.lar.PortletDataContext context, java.lang.String templateId)
           
protected static java.lang.String getStructurePath(com.liferay.portal.lar.PortletDataContext context, com.liferay.portlet.journal.model.JournalStructure structure)
           
protected static java.lang.String getTemplatePath(com.liferay.portal.lar.PortletDataContext context, com.liferay.portlet.journal.model.JournalTemplate template)
           
protected static java.lang.String getTemplateSmallImagePath(com.liferay.portal.lar.PortletDataContext context, com.liferay.portlet.journal.model.JournalTemplate template)
           
static void importArticle(com.liferay.portal.lar.PortletDataContext context, java.util.Map<java.lang.String,java.lang.String> structureIds, java.util.Map<java.lang.String,java.lang.String> templateIds, java.util.Map<java.lang.String,java.lang.String> articleIds, com.liferay.portal.kernel.xml.Element articleEl)
           
 javax.portlet.PortletPreferences importData(com.liferay.portal.lar.PortletDataContext context, java.lang.String portletId, javax.portlet.PortletPreferences preferences, java.lang.String data)
           
static void importFeed(com.liferay.portal.lar.PortletDataContext context, java.util.Map<java.lang.String,java.lang.String> structureIds, java.util.Map<java.lang.String,java.lang.String> templateIds, java.util.Map<java.lang.String,java.lang.String> feedIds, com.liferay.portal.kernel.xml.Element feedEl)
           
static void importStructure(com.liferay.portal.lar.PortletDataContext context, java.util.Map<java.lang.String,java.lang.String> structureIds, com.liferay.portal.kernel.xml.Element structureEl)
           
protected static void importStructure(com.liferay.portal.lar.PortletDataContext context, java.util.Map<java.lang.String,java.lang.String> structureIds, java.lang.String path)
           
static void importTemplate(com.liferay.portal.lar.PortletDataContext context, java.util.Map<java.lang.String,java.lang.String> structureIds, java.util.Map<java.lang.String,java.lang.String> templateIds, com.liferay.portal.kernel.xml.Element templateEl)
           
protected static void importTemplate(com.liferay.portal.lar.PortletDataContext context, java.util.Map<java.lang.String,java.lang.String> structureIds, java.util.Map<java.lang.String,java.lang.String> templateIds, java.lang.String smallImagePath, java.lang.String path)
           
 boolean isAlwaysExportable()
           
 boolean isPublishToLiveByDefault()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JournalPortletDataHandlerImpl

public JournalPortletDataHandlerImpl()
Method Detail

exportArticle

public static void exportArticle(com.liferay.portal.lar.PortletDataContext context,
                                 com.liferay.portal.kernel.xml.Element articlesEl,
                                 com.liferay.portal.kernel.xml.Element dlFoldersEl,
                                 com.liferay.portal.kernel.xml.Element dlFileEntriesEl,
                                 com.liferay.portal.kernel.xml.Element dlFileRanks,
                                 com.liferay.portal.kernel.xml.Element igFoldersEl,
                                 com.liferay.portal.kernel.xml.Element igImagesEl,
                                 com.liferay.portlet.journal.model.JournalArticle article)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

exportFeed

public static void exportFeed(com.liferay.portal.lar.PortletDataContext context,
                              com.liferay.portal.kernel.xml.Element feedsEl,
                              com.liferay.portlet.journal.model.JournalFeed feed)
                       throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

exportDLFileEntries

public static java.lang.String exportDLFileEntries(com.liferay.portal.lar.PortletDataContext context,
                                                   com.liferay.portal.kernel.xml.Element foldersEl,
                                                   com.liferay.portal.kernel.xml.Element fileEntriesEl,
                                                   com.liferay.portal.kernel.xml.Element fileRanks,
                                                   long entityGroupId,
                                                   java.lang.String content)

exportIGImages

public static java.lang.String exportIGImages(com.liferay.portal.lar.PortletDataContext context,
                                              com.liferay.portal.kernel.xml.Element foldersEl,
                                              com.liferay.portal.kernel.xml.Element imagesEl,
                                              long entityGroupId,
                                              java.lang.String content)

exportStructure

public static void exportStructure(com.liferay.portal.lar.PortletDataContext context,
                                   com.liferay.portal.kernel.xml.Element structuresEl,
                                   com.liferay.portlet.journal.model.JournalStructure structure)
                            throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

exportTemplate

public static void exportTemplate(com.liferay.portal.lar.PortletDataContext context,
                                  com.liferay.portal.kernel.xml.Element templatesEl,
                                  com.liferay.portal.kernel.xml.Element dlFoldersEl,
                                  com.liferay.portal.kernel.xml.Element dlFileEntriesEl,
                                  com.liferay.portal.kernel.xml.Element dlFileRanks,
                                  com.liferay.portal.kernel.xml.Element igFoldersEl,
                                  com.liferay.portal.kernel.xml.Element igImagesEl,
                                  com.liferay.portlet.journal.model.JournalTemplate template)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

importArticle

public static void importArticle(com.liferay.portal.lar.PortletDataContext context,
                                 java.util.Map<java.lang.String,java.lang.String> structureIds,
                                 java.util.Map<java.lang.String,java.lang.String> templateIds,
                                 java.util.Map<java.lang.String,java.lang.String> articleIds,
                                 com.liferay.portal.kernel.xml.Element articleEl)
                          throws java.lang.Exception
Throws:
java.lang.Exception

importFeed

public static void importFeed(com.liferay.portal.lar.PortletDataContext context,
                              java.util.Map<java.lang.String,java.lang.String> structureIds,
                              java.util.Map<java.lang.String,java.lang.String> templateIds,
                              java.util.Map<java.lang.String,java.lang.String> feedIds,
                              com.liferay.portal.kernel.xml.Element feedEl)
                       throws java.lang.Exception
Throws:
java.lang.Exception

importStructure

public static void importStructure(com.liferay.portal.lar.PortletDataContext context,
                                   java.util.Map<java.lang.String,java.lang.String> structureIds,
                                   com.liferay.portal.kernel.xml.Element structureEl)
                            throws java.lang.Exception
Throws:
java.lang.Exception

importStructure

protected static void importStructure(com.liferay.portal.lar.PortletDataContext context,
                                      java.util.Map<java.lang.String,java.lang.String> structureIds,
                                      java.lang.String path)
                               throws java.lang.Exception
Throws:
java.lang.Exception

importTemplate

public static void importTemplate(com.liferay.portal.lar.PortletDataContext context,
                                  java.util.Map<java.lang.String,java.lang.String> structureIds,
                                  java.util.Map<java.lang.String,java.lang.String> templateIds,
                                  com.liferay.portal.kernel.xml.Element templateEl)
                           throws java.lang.Exception
Throws:
java.lang.Exception

importTemplate

protected static void importTemplate(com.liferay.portal.lar.PortletDataContext context,
                                     java.util.Map<java.lang.String,java.lang.String> structureIds,
                                     java.util.Map<java.lang.String,java.lang.String> templateIds,
                                     java.lang.String smallImagePath,
                                     java.lang.String path)
                              throws java.lang.Exception
Throws:
java.lang.Exception

deleteData

public javax.portlet.PortletPreferences deleteData(com.liferay.portal.lar.PortletDataContext context,
                                                   java.lang.String portletId,
                                                   javax.portlet.PortletPreferences preferences)
                                            throws com.liferay.portal.lar.PortletDataException
Throws:
com.liferay.portal.lar.PortletDataException

exportData

public java.lang.String exportData(com.liferay.portal.lar.PortletDataContext context,
                                   java.lang.String portletId,
                                   javax.portlet.PortletPreferences preferences)
                            throws com.liferay.portal.lar.PortletDataException
Throws:
com.liferay.portal.lar.PortletDataException

getExportControls

public com.liferay.portal.lar.PortletDataHandlerControl[] getExportControls()

getImportControls

public com.liferay.portal.lar.PortletDataHandlerControl[] getImportControls()

importData

public javax.portlet.PortletPreferences importData(com.liferay.portal.lar.PortletDataContext context,
                                                   java.lang.String portletId,
                                                   javax.portlet.PortletPreferences preferences,
                                                   java.lang.String data)
                                            throws com.liferay.portal.lar.PortletDataException
Throws:
com.liferay.portal.lar.PortletDataException

isAlwaysExportable

public boolean isAlwaysExportable()
Specified by:
isAlwaysExportable in interface com.liferay.portal.lar.PortletDataHandler
Overrides:
isAlwaysExportable in class com.liferay.portal.lar.BasePortletDataHandler

isPublishToLiveByDefault

public boolean isPublishToLiveByDefault()
Specified by:
isPublishToLiveByDefault in interface com.liferay.portal.lar.PortletDataHandler
Overrides:
isPublishToLiveByDefault in class com.liferay.portal.lar.BasePortletDataHandler

getArticlePath

protected static java.lang.String getArticlePath(com.liferay.portal.lar.PortletDataContext context,
                                                 com.liferay.portlet.journal.model.JournalArticle article)

getArticleImagePath

protected static java.lang.String getArticleImagePath(com.liferay.portal.lar.PortletDataContext context,
                                                      com.liferay.portlet.journal.model.JournalArticle article)

getArticleImagePath

protected static java.lang.String getArticleImagePath(com.liferay.portal.lar.PortletDataContext context,
                                                      com.liferay.portlet.journal.model.JournalArticle article,
                                                      com.liferay.portlet.journal.model.JournalArticleImage articleImage,
                                                      com.liferay.portal.model.Image image)

getArticleSmallImagePath

protected static java.lang.String getArticleSmallImagePath(com.liferay.portal.lar.PortletDataContext context,
                                                           com.liferay.portlet.journal.model.JournalArticle article)
                                                    throws com.liferay.portal.PortalException,
                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFeedPath

protected static java.lang.String getFeedPath(com.liferay.portal.lar.PortletDataContext context,
                                              com.liferay.portlet.journal.model.JournalFeed feed)

getImportStructurePath

protected static java.lang.String getImportStructurePath(com.liferay.portal.lar.PortletDataContext context,
                                                         java.lang.String structureId)

getImportTemplatePath

protected static java.lang.String getImportTemplatePath(com.liferay.portal.lar.PortletDataContext context,
                                                        java.lang.String templateId)

getImportTemplateSmallImagePath

protected static java.lang.String getImportTemplateSmallImagePath(com.liferay.portal.lar.PortletDataContext context,
                                                                  java.lang.String templateId)

getTemplatePath

protected static java.lang.String getTemplatePath(com.liferay.portal.lar.PortletDataContext context,
                                                  com.liferay.portlet.journal.model.JournalTemplate template)

getTemplateSmallImagePath

protected static java.lang.String getTemplateSmallImagePath(com.liferay.portal.lar.PortletDataContext context,
                                                            com.liferay.portlet.journal.model.JournalTemplate template)
                                                     throws com.liferay.portal.PortalException,
                                                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getStructurePath

protected static java.lang.String getStructurePath(com.liferay.portal.lar.PortletDataContext context,
                                                   com.liferay.portlet.journal.model.JournalStructure structure)