com.liferay.portal.lar
Class PortletDataContextImpl

java.lang.Object
  extended by com.liferay.portal.lar.PortletDataContextImpl
All Implemented Interfaces:
com.liferay.portal.kernel.lar.PortletDataContext, java.io.Serializable

public class PortletDataContextImpl
extends java.lang.Object
implements com.liferay.portal.kernel.lar.PortletDataContext

View Source

Holds context information that is used during exporting and importing portlet data.

Author:
Brian Wing Shun Chan, Raymond Augé, Bruno Farache, Alex Chow
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.liferay.portal.kernel.lar.PortletDataContext
ROOT_PATH_GROUPS, ROOT_PATH_LAYOUTS, ROOT_PATH_PORTLETS
 
Constructor Summary
PortletDataContextImpl(long companyId, long groupId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Set primaryKeys, java.util.Date startDate, java.util.Date endDate, com.liferay.portal.kernel.zip.ZipWriter zipWriter)
           
PortletDataContextImpl(long companyId, long groupId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Set primaryKeys, com.liferay.portal.kernel.lar.UserIdStrategy userIdStrategy, com.liferay.portal.kernel.zip.ZipReader zipReader)
           
 
Method Summary
 void addComments(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
 void addComments(java.lang.String className, java.lang.Object primaryKey, java.util.List messages)
           
 boolean addPrimaryKey(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
 void addRatingsEntries(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
 void addRatingsEntries(java.lang.String className, java.lang.Object primaryKey, java.util.List entries)
           
 void addTagsEntries(java.lang.Class<?> classObj, java.lang.Object classPK)
           
 void addTagsEntries(java.lang.String className, java.lang.Object classPK, java.lang.String[] values)
           
 void addZipEntry(java.lang.String path, byte[] bytes)
           
 void addZipEntry(java.lang.String path, java.lang.Object object)
           
 void addZipEntry(java.lang.String path, java.lang.String s)
           
 void addZipEntry(java.lang.String path, java.lang.StringBuilder sb)
           
 java.lang.Object fromXML(byte[] bytes)
           
 java.lang.Object fromXML(java.lang.String xml)
           
 boolean getBooleanParameter(java.lang.String namespace, java.lang.String name)
           
 java.util.Map getComments()
           
 long getCompanyId()
           
 java.lang.String getDataStrategy()
           
 java.util.Date getEndDate()
           
 long getGroupId()
           
 long getImportGroupId()
           
 java.lang.String getImportLayoutPath(long layoutId)
           
 java.lang.String getImportPortletPath(java.lang.String portletId)
           
 java.lang.String getImportRootPath()
           
 java.lang.String getLayoutPath(long layoutId)
           
 java.util.Map getNewPrimaryKeysMap(java.lang.Class<?> classObj)
           
 long getOldPlid()
           
 java.util.Map getParameterMap()
           
 long getPlid()
           
 java.lang.String getPortletPath(java.lang.String portletId)
           
 java.util.Set getPrimaryKeys()
           
protected  java.lang.String getPrimaryKeyString(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
protected  java.lang.String getPrimaryKeyString(java.lang.String className, java.lang.Object primaryKey)
           
 java.util.Map getRatingsEntries()
           
 java.lang.String getRootPath()
           
 java.util.Date getStartDate()
           
 java.util.Map getTagsEntries()
           
 java.lang.String[] getTagsEntries(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
 java.lang.String[] getTagsEntries(java.lang.String className, java.lang.Object primaryKey)
           
 long getUserId(java.lang.String userUuid)
           
 com.liferay.portal.kernel.lar.UserIdStrategy getUserIdStrategy()
           
 java.util.Map<java.lang.String,byte[]> getZipEntries()
           
 byte[] getZipEntryAsByteArray(java.lang.String path)
           
 java.lang.Object getZipEntryAsObject(java.lang.String path)
           
 java.lang.String getZipEntryAsString(java.lang.String path)
           
 java.util.Map<java.lang.String,java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>>> getZipFolderEntries()
           
 java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> getZipFolderEntries(java.lang.String path)
           
 com.liferay.portal.kernel.zip.ZipReader getZipReader()
           
 com.liferay.portal.kernel.zip.ZipWriter getZipWriter()
           
 boolean hasDateRange()
           
 boolean hasPrimaryKey(java.lang.Class<?> classObj, java.lang.Object primaryKey)
           
 void importComments(java.lang.Class<?> classObj, java.lang.Object primaryKey, java.lang.Object newPrimaryKey, long groupId)
           
 void importRatingsEntries(java.lang.Class<?> classObj, java.lang.Object primaryKey, java.lang.Object newPrimaryKey)
           
protected  void initXStream()
           
 boolean isPathNotProcessed(java.lang.String path)
           
 boolean isWithinDateRange(java.util.Date modifiedDate)
           
 void setImportGroupId(long importGroupId)
           
 void setOldPlid(long oldPlid)
           
 void setPlid(long plid)
           
 java.lang.String toXML(java.lang.Object object)
           
protected  void validateDateRange(java.util.Date startDate, java.util.Date endDate)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortletDataContextImpl

public PortletDataContextImpl(long companyId,
                              long groupId,
                              java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                              java.util.Set primaryKeys,
                              com.liferay.portal.kernel.lar.UserIdStrategy userIdStrategy,
                              com.liferay.portal.kernel.zip.ZipReader zipReader)

PortletDataContextImpl

public PortletDataContextImpl(long companyId,
                              long groupId,
                              java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                              java.util.Set primaryKeys,
                              java.util.Date startDate,
                              java.util.Date endDate,
                              com.liferay.portal.kernel.zip.ZipWriter zipWriter)
                       throws com.liferay.portal.kernel.lar.PortletDataException
Throws:
com.liferay.portal.kernel.lar.PortletDataException
Method Detail

addComments

public void addComments(java.lang.Class<?> classObj,
                        java.lang.Object primaryKey)
                 throws com.liferay.portal.PortalException,
                        com.liferay.portal.SystemException
Specified by:
addComments in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addComments

public void addComments(java.lang.String className,
                        java.lang.Object primaryKey,
                        java.util.List messages)
                 throws com.liferay.portal.PortalException,
                        com.liferay.portal.SystemException
Specified by:
addComments in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addPrimaryKey

public boolean addPrimaryKey(java.lang.Class<?> classObj,
                             java.lang.Object primaryKey)
Specified by:
addPrimaryKey in interface com.liferay.portal.kernel.lar.PortletDataContext

addRatingsEntries

public void addRatingsEntries(java.lang.Class<?> classObj,
                              java.lang.Object primaryKey)
                       throws com.liferay.portal.PortalException,
                              com.liferay.portal.SystemException
Specified by:
addRatingsEntries in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addRatingsEntries

public void addRatingsEntries(java.lang.String className,
                              java.lang.Object primaryKey,
                              java.util.List entries)
                       throws com.liferay.portal.PortalException,
                              com.liferay.portal.SystemException
Specified by:
addRatingsEntries in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addTagsEntries

public void addTagsEntries(java.lang.Class<?> classObj,
                           java.lang.Object classPK)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException
Specified by:
addTagsEntries in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addTagsEntries

public void addTagsEntries(java.lang.String className,
                           java.lang.Object classPK,
                           java.lang.String[] values)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException
Specified by:
addTagsEntries in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addZipEntry

public void addZipEntry(java.lang.String path,
                        byte[] bytes)
                 throws com.liferay.portal.SystemException
Specified by:
addZipEntry in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.SystemException

addZipEntry

public void addZipEntry(java.lang.String path,
                        java.lang.Object object)
                 throws com.liferay.portal.SystemException
Specified by:
addZipEntry in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.SystemException

addZipEntry

public void addZipEntry(java.lang.String path,
                        java.lang.String s)
                 throws com.liferay.portal.SystemException
Specified by:
addZipEntry in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.SystemException

addZipEntry

public void addZipEntry(java.lang.String path,
                        java.lang.StringBuilder sb)
                 throws com.liferay.portal.SystemException
Specified by:
addZipEntry in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.SystemException

fromXML

public java.lang.Object fromXML(byte[] bytes)
Specified by:
fromXML in interface com.liferay.portal.kernel.lar.PortletDataContext

fromXML

public java.lang.Object fromXML(java.lang.String xml)
Specified by:
fromXML in interface com.liferay.portal.kernel.lar.PortletDataContext

getBooleanParameter

public boolean getBooleanParameter(java.lang.String namespace,
                                   java.lang.String name)
Specified by:
getBooleanParameter in interface com.liferay.portal.kernel.lar.PortletDataContext

getComments

public java.util.Map getComments()
Specified by:
getComments in interface com.liferay.portal.kernel.lar.PortletDataContext

getCompanyId

public long getCompanyId()
Specified by:
getCompanyId in interface com.liferay.portal.kernel.lar.PortletDataContext

getDataStrategy

public java.lang.String getDataStrategy()
Specified by:
getDataStrategy in interface com.liferay.portal.kernel.lar.PortletDataContext

getEndDate

public java.util.Date getEndDate()
Specified by:
getEndDate in interface com.liferay.portal.kernel.lar.PortletDataContext

getGroupId

public long getGroupId()
Specified by:
getGroupId in interface com.liferay.portal.kernel.lar.PortletDataContext

getImportGroupId

public long getImportGroupId()
Specified by:
getImportGroupId in interface com.liferay.portal.kernel.lar.PortletDataContext

getImportLayoutPath

public java.lang.String getImportLayoutPath(long layoutId)
Specified by:
getImportLayoutPath in interface com.liferay.portal.kernel.lar.PortletDataContext

getImportPortletPath

public java.lang.String getImportPortletPath(java.lang.String portletId)
Specified by:
getImportPortletPath in interface com.liferay.portal.kernel.lar.PortletDataContext

getImportRootPath

public java.lang.String getImportRootPath()
Specified by:
getImportRootPath in interface com.liferay.portal.kernel.lar.PortletDataContext

getLayoutPath

public java.lang.String getLayoutPath(long layoutId)
Specified by:
getLayoutPath in interface com.liferay.portal.kernel.lar.PortletDataContext

getNewPrimaryKeysMap

public java.util.Map getNewPrimaryKeysMap(java.lang.Class<?> classObj)
Specified by:
getNewPrimaryKeysMap in interface com.liferay.portal.kernel.lar.PortletDataContext

getOldPlid

public long getOldPlid()
Specified by:
getOldPlid in interface com.liferay.portal.kernel.lar.PortletDataContext

getParameterMap

public java.util.Map getParameterMap()
Specified by:
getParameterMap in interface com.liferay.portal.kernel.lar.PortletDataContext

getPlid

public long getPlid()
Specified by:
getPlid in interface com.liferay.portal.kernel.lar.PortletDataContext

getPortletPath

public java.lang.String getPortletPath(java.lang.String portletId)
Specified by:
getPortletPath in interface com.liferay.portal.kernel.lar.PortletDataContext

getPrimaryKeys

public java.util.Set getPrimaryKeys()
Specified by:
getPrimaryKeys in interface com.liferay.portal.kernel.lar.PortletDataContext

getRatingsEntries

public java.util.Map getRatingsEntries()
Specified by:
getRatingsEntries in interface com.liferay.portal.kernel.lar.PortletDataContext

getRootPath

public java.lang.String getRootPath()
Specified by:
getRootPath in interface com.liferay.portal.kernel.lar.PortletDataContext

getStartDate

public java.util.Date getStartDate()
Specified by:
getStartDate in interface com.liferay.portal.kernel.lar.PortletDataContext

getTagsEntries

public java.util.Map getTagsEntries()
Specified by:
getTagsEntries in interface com.liferay.portal.kernel.lar.PortletDataContext

getTagsEntries

public java.lang.String[] getTagsEntries(java.lang.Class<?> classObj,
                                         java.lang.Object primaryKey)
Specified by:
getTagsEntries in interface com.liferay.portal.kernel.lar.PortletDataContext

getTagsEntries

public java.lang.String[] getTagsEntries(java.lang.String className,
                                         java.lang.Object primaryKey)
Specified by:
getTagsEntries in interface com.liferay.portal.kernel.lar.PortletDataContext

getUserId

public long getUserId(java.lang.String userUuid)
               throws com.liferay.portal.SystemException
Specified by:
getUserId in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.SystemException

getUserIdStrategy

public com.liferay.portal.kernel.lar.UserIdStrategy getUserIdStrategy()
Specified by:
getUserIdStrategy in interface com.liferay.portal.kernel.lar.PortletDataContext

getZipEntries

public java.util.Map<java.lang.String,byte[]> getZipEntries()
Specified by:
getZipEntries in interface com.liferay.portal.kernel.lar.PortletDataContext

getZipEntryAsByteArray

public byte[] getZipEntryAsByteArray(java.lang.String path)
Specified by:
getZipEntryAsByteArray in interface com.liferay.portal.kernel.lar.PortletDataContext

getZipEntryAsObject

public java.lang.Object getZipEntryAsObject(java.lang.String path)
Specified by:
getZipEntryAsObject in interface com.liferay.portal.kernel.lar.PortletDataContext

getZipEntryAsString

public java.lang.String getZipEntryAsString(java.lang.String path)
Specified by:
getZipEntryAsString in interface com.liferay.portal.kernel.lar.PortletDataContext

getZipFolderEntries

public java.util.Map<java.lang.String,java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>>> getZipFolderEntries()
Specified by:
getZipFolderEntries in interface com.liferay.portal.kernel.lar.PortletDataContext

getZipFolderEntries

public java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> getZipFolderEntries(java.lang.String path)
Specified by:
getZipFolderEntries in interface com.liferay.portal.kernel.lar.PortletDataContext

getZipReader

public com.liferay.portal.kernel.zip.ZipReader getZipReader()
Specified by:
getZipReader in interface com.liferay.portal.kernel.lar.PortletDataContext

getZipWriter

public com.liferay.portal.kernel.zip.ZipWriter getZipWriter()
Specified by:
getZipWriter in interface com.liferay.portal.kernel.lar.PortletDataContext

hasDateRange

public boolean hasDateRange()
Specified by:
hasDateRange in interface com.liferay.portal.kernel.lar.PortletDataContext

hasPrimaryKey

public boolean hasPrimaryKey(java.lang.Class<?> classObj,
                             java.lang.Object primaryKey)
Specified by:
hasPrimaryKey in interface com.liferay.portal.kernel.lar.PortletDataContext

importComments

public void importComments(java.lang.Class<?> classObj,
                           java.lang.Object primaryKey,
                           java.lang.Object newPrimaryKey,
                           long groupId)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException
Specified by:
importComments in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

importRatingsEntries

public void importRatingsEntries(java.lang.Class<?> classObj,
                                 java.lang.Object primaryKey,
                                 java.lang.Object newPrimaryKey)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Specified by:
importRatingsEntries in interface com.liferay.portal.kernel.lar.PortletDataContext
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

isPathNotProcessed

public boolean isPathNotProcessed(java.lang.String path)
Specified by:
isPathNotProcessed in interface com.liferay.portal.kernel.lar.PortletDataContext

isWithinDateRange

public boolean isWithinDateRange(java.util.Date modifiedDate)
Specified by:
isWithinDateRange in interface com.liferay.portal.kernel.lar.PortletDataContext

setImportGroupId

public void setImportGroupId(long importGroupId)
Specified by:
setImportGroupId in interface com.liferay.portal.kernel.lar.PortletDataContext

setOldPlid

public void setOldPlid(long oldPlid)
Specified by:
setOldPlid in interface com.liferay.portal.kernel.lar.PortletDataContext

setPlid

public void setPlid(long plid)
Specified by:
setPlid in interface com.liferay.portal.kernel.lar.PortletDataContext

toXML

public java.lang.String toXML(java.lang.Object object)
Specified by:
toXML in interface com.liferay.portal.kernel.lar.PortletDataContext

getPrimaryKeyString

protected java.lang.String getPrimaryKeyString(java.lang.Class<?> classObj,
                                               java.lang.Object primaryKey)

getPrimaryKeyString

protected java.lang.String getPrimaryKeyString(java.lang.String className,
                                               java.lang.Object primaryKey)

initXStream

protected void initXStream()

validateDateRange

protected void validateDateRange(java.util.Date startDate,
                                 java.util.Date endDate)
                          throws com.liferay.portal.kernel.lar.PortletDataException
Throws:
com.liferay.portal.kernel.lar.PortletDataException