com.liferay.portlet.journal.lar
Class JournalPortletDataHandlerImpl

java.lang.Object
  extended by com.liferay.portal.kernel.lar.BasePortletDataHandler
      extended by com.liferay.portlet.journal.lar.JournalPortletDataHandlerImpl
All Implemented Interfaces:
com.liferay.portal.kernel.lar.PortletDataHandler
Direct Known Subclasses:
RSSPortletDataHandlerImpl

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

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, Wesley Gong, Hugo Huijser
See Also:
PortletDataHandler, JournalContentPortletDataHandlerImpl, JournalCreationStrategy

Constructor Summary
JournalPortletDataHandlerImpl()
           
 
Method Summary
protected  javax.portlet.PortletPreferences doDeleteData(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences)
           
protected  java.lang.String doExportData(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences)
           
protected  javax.portlet.PortletPreferences doImportData(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences, java.lang.String data)
           
static void exportArticle(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element articlesElement, com.liferay.portal.kernel.xml.Element structuresElement, com.liferay.portal.kernel.xml.Element templatesElement, com.liferay.portal.kernel.xml.Element dlFileEntryTypesElement, com.liferay.portal.kernel.xml.Element dlFoldersElement, com.liferay.portal.kernel.xml.Element dlFileEntriesElement, com.liferay.portal.kernel.xml.Element dlFileRanksElement, com.liferay.portlet.journal.model.JournalArticle article, boolean checkDateRange)
           
protected static java.lang.String exportDLFileEntries(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element dlFileEntryTypesElement, com.liferay.portal.kernel.xml.Element dlFoldersElement, com.liferay.portal.kernel.xml.Element dlFileEntriesElement, com.liferay.portal.kernel.xml.Element dlFileRanksElement, com.liferay.portal.kernel.xml.Element entityElement, java.lang.String content, boolean checkDateRange)
           
protected static void exportFeed(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element feedsElement, com.liferay.portlet.journal.model.JournalFeed feed)
           
protected static java.lang.String exportLayoutFriendlyURLs(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, java.lang.String content)
           
protected static java.lang.String exportLinksToLayout(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, java.lang.String content)
           
static java.lang.String exportReferencedContent(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element dlFileEntryTypesElement, com.liferay.portal.kernel.xml.Element dlFoldersElement, com.liferay.portal.kernel.xml.Element dlFileEntriesElement, com.liferay.portal.kernel.xml.Element dlFileRanksElement, com.liferay.portal.kernel.xml.Element entityElement, java.lang.String content)
           
protected static void exportStructure(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element structuresElement, com.liferay.portlet.journal.model.JournalStructure structure)
           
protected static void exportTemplate(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element templatesElement, com.liferay.portal.kernel.xml.Element dlFileEntryTypesElement, com.liferay.portal.kernel.xml.Element dlFoldersElement, com.liferay.portal.kernel.xml.Element dlFileEntriesElement, com.liferay.portal.kernel.xml.Element dlFileRanksElement, com.liferay.portlet.journal.model.JournalTemplate template)
           
protected static java.lang.String getArticleImagePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portlet.journal.model.JournalArticle article)
           
protected static java.lang.String getArticleImagePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portlet.journal.model.JournalArticle article, com.liferay.portlet.journal.model.JournalArticleImage articleImage, com.liferay.portal.model.Image image)
           
static java.lang.String getArticlePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portlet.journal.model.JournalArticle article)
           
protected static java.lang.String getArticleSmallImagePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portlet.journal.model.JournalArticle article)
           
 com.liferay.portal.kernel.lar.PortletDataHandlerControl[] getExportControls()
           
protected static java.lang.String getFeedPath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portlet.journal.model.JournalFeed feed)
           
 com.liferay.portal.kernel.lar.PortletDataHandlerControl[] getImportControls()
           
protected static java.lang.String getStructurePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portlet.journal.model.JournalStructure structure)
           
protected static java.lang.String getTemplatePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portlet.journal.model.JournalTemplate template)
           
protected static java.lang.String getTemplateSmallImagePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portlet.journal.model.JournalTemplate template)
           
static void importArticle(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element articleElement)
           
protected static java.lang.String importDLFileEntries(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element parentElement, java.lang.String content)
           
static void importFeed(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element feedElement)
           
protected static java.lang.String importLinksToLayout(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, java.lang.String content)
           
static java.lang.String importReferencedContent(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element parentElement, java.lang.String content)
           
static void importReferencedData(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element entityElement)
           
static void importStructure(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element structureElement)
           
static void importTemplate(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element templateElement)
           
 boolean isAlwaysExportable()
           
 boolean isPublishToLiveByDefault()
           
 
Methods inherited from class com.liferay.portal.kernel.lar.BasePortletDataHandler
deleteData, exportData, importData, isAlwaysStaged
 
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.kernel.lar.PortletDataContext portletDataContext,
                                 com.liferay.portal.kernel.xml.Element articlesElement,
                                 com.liferay.portal.kernel.xml.Element structuresElement,
                                 com.liferay.portal.kernel.xml.Element templatesElement,
                                 com.liferay.portal.kernel.xml.Element dlFileEntryTypesElement,
                                 com.liferay.portal.kernel.xml.Element dlFoldersElement,
                                 com.liferay.portal.kernel.xml.Element dlFileEntriesElement,
                                 com.liferay.portal.kernel.xml.Element dlFileRanksElement,
                                 com.liferay.portlet.journal.model.JournalArticle article,
                                 boolean checkDateRange)
                          throws java.lang.Exception
Throws:
java.lang.Exception

exportReferencedContent

public static java.lang.String exportReferencedContent(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                       com.liferay.portal.kernel.xml.Element dlFileEntryTypesElement,
                                                       com.liferay.portal.kernel.xml.Element dlFoldersElement,
                                                       com.liferay.portal.kernel.xml.Element dlFileEntriesElement,
                                                       com.liferay.portal.kernel.xml.Element dlFileRanksElement,
                                                       com.liferay.portal.kernel.xml.Element entityElement,
                                                       java.lang.String content)
                                                throws java.lang.Exception
Throws:
java.lang.Exception

getArticlePath

public static java.lang.String getArticlePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                              com.liferay.portlet.journal.model.JournalArticle article)
                                       throws java.lang.Exception
Throws:
java.lang.Exception

importArticle

public static void importArticle(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                 com.liferay.portal.kernel.xml.Element articleElement)
                          throws java.lang.Exception
Throws:
java.lang.Exception

importFeed

public static void importFeed(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                              com.liferay.portal.kernel.xml.Element feedElement)
                       throws java.lang.Exception
Throws:
java.lang.Exception

importReferencedContent

public static java.lang.String importReferencedContent(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                       com.liferay.portal.kernel.xml.Element parentElement,
                                                       java.lang.String content)
                                                throws java.lang.Exception
Throws:
java.lang.Exception

importReferencedData

public static void importReferencedData(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                        com.liferay.portal.kernel.xml.Element entityElement)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

importStructure

public static void importStructure(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                   com.liferay.portal.kernel.xml.Element structureElement)
                            throws java.lang.Exception
Throws:
java.lang.Exception

importTemplate

public static void importTemplate(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                  com.liferay.portal.kernel.xml.Element templateElement)
                           throws java.lang.Exception
Throws:
java.lang.Exception

exportDLFileEntries

protected static java.lang.String exportDLFileEntries(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                      com.liferay.portal.kernel.xml.Element dlFileEntryTypesElement,
                                                      com.liferay.portal.kernel.xml.Element dlFoldersElement,
                                                      com.liferay.portal.kernel.xml.Element dlFileEntriesElement,
                                                      com.liferay.portal.kernel.xml.Element dlFileRanksElement,
                                                      com.liferay.portal.kernel.xml.Element entityElement,
                                                      java.lang.String content,
                                                      boolean checkDateRange)
                                               throws java.lang.Exception
Throws:
java.lang.Exception

exportFeed

protected static void exportFeed(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                 com.liferay.portal.kernel.xml.Element feedsElement,
                                 com.liferay.portlet.journal.model.JournalFeed feed)
                          throws java.lang.Exception
Throws:
java.lang.Exception

exportLayoutFriendlyURLs

protected static java.lang.String exportLayoutFriendlyURLs(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                           java.lang.String content)

exportLinksToLayout

protected static java.lang.String exportLinksToLayout(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                      java.lang.String content)
                                               throws java.lang.Exception
Throws:
java.lang.Exception

exportStructure

protected static void exportStructure(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                      com.liferay.portal.kernel.xml.Element structuresElement,
                                      com.liferay.portlet.journal.model.JournalStructure structure)
                               throws java.lang.Exception
Throws:
java.lang.Exception

exportTemplate

protected static void exportTemplate(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                     com.liferay.portal.kernel.xml.Element templatesElement,
                                     com.liferay.portal.kernel.xml.Element dlFileEntryTypesElement,
                                     com.liferay.portal.kernel.xml.Element dlFoldersElement,
                                     com.liferay.portal.kernel.xml.Element dlFileEntriesElement,
                                     com.liferay.portal.kernel.xml.Element dlFileRanksElement,
                                     com.liferay.portlet.journal.model.JournalTemplate template)
                              throws java.lang.Exception
Throws:
java.lang.Exception

getArticleImagePath

protected static java.lang.String getArticleImagePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                      com.liferay.portlet.journal.model.JournalArticle article)
                                               throws java.lang.Exception
Throws:
java.lang.Exception

getArticleImagePath

protected static java.lang.String getArticleImagePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                      com.liferay.portlet.journal.model.JournalArticle article,
                                                      com.liferay.portlet.journal.model.JournalArticleImage articleImage,
                                                      com.liferay.portal.model.Image image)
                                               throws java.lang.Exception
Throws:
java.lang.Exception

getArticleSmallImagePath

protected static java.lang.String getArticleSmallImagePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                           com.liferay.portlet.journal.model.JournalArticle article)
                                                    throws java.lang.Exception
Throws:
java.lang.Exception

getFeedPath

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

getStructurePath

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

getTemplatePath

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

getTemplateSmallImagePath

protected static java.lang.String getTemplateSmallImagePath(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                            com.liferay.portlet.journal.model.JournalTemplate template)
                                                     throws java.lang.Exception
Throws:
java.lang.Exception

importDLFileEntries

protected static java.lang.String importDLFileEntries(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                      com.liferay.portal.kernel.xml.Element parentElement,
                                                      java.lang.String content)
                                               throws java.lang.Exception
Throws:
java.lang.Exception

importLinksToLayout

protected static java.lang.String importLinksToLayout(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                      java.lang.String content)
                                               throws java.lang.Exception
Throws:
java.lang.Exception

getExportControls

public com.liferay.portal.kernel.lar.PortletDataHandlerControl[] getExportControls()
Specified by:
getExportControls in interface com.liferay.portal.kernel.lar.PortletDataHandler
Overrides:
getExportControls in class com.liferay.portal.kernel.lar.BasePortletDataHandler

getImportControls

public com.liferay.portal.kernel.lar.PortletDataHandlerControl[] getImportControls()
Specified by:
getImportControls in interface com.liferay.portal.kernel.lar.PortletDataHandler
Overrides:
getImportControls in class com.liferay.portal.kernel.lar.BasePortletDataHandler

isAlwaysExportable

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

isPublishToLiveByDefault

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

doDeleteData

protected javax.portlet.PortletPreferences doDeleteData(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                        java.lang.String portletId,
                                                        javax.portlet.PortletPreferences portletPreferences)
                                                 throws java.lang.Exception
Overrides:
doDeleteData in class com.liferay.portal.kernel.lar.BasePortletDataHandler
Throws:
java.lang.Exception

doExportData

protected java.lang.String doExportData(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                        java.lang.String portletId,
                                        javax.portlet.PortletPreferences portletPreferences)
                                 throws java.lang.Exception
Overrides:
doExportData in class com.liferay.portal.kernel.lar.BasePortletDataHandler
Throws:
java.lang.Exception

doImportData

protected javax.portlet.PortletPreferences doImportData(com.liferay.portal.kernel.lar.PortletDataContext portletDataContext,
                                                        java.lang.String portletId,
                                                        javax.portlet.PortletPreferences portletPreferences,
                                                        java.lang.String data)
                                                 throws java.lang.Exception
Overrides:
doImportData in class com.liferay.portal.kernel.lar.BasePortletDataHandler
Throws:
java.lang.Exception