org.nuxeo.ecm.diff.web

Class DiffActionsBean

java.lang.Object

org.nuxeo.ecm.diff.web.DiffActionsBean

All Implemented Interfaces:

Serializable

@Name(value="diffActions")
 @Scope(value=CONVERSATION)
public class DiffActionsBean
extends Object
implements Serializable

Handles document diff actions.

Since:

5.6

Author:

Antoine Taillefer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	diffSelectionType
protected org.nuxeo.ecm.core.api.CoreSession	documentManager
protected DocumentsListsManager	documentsListsManager
protected org.nuxeo.ecm.core.api.DocumentModel	leftDoc
protected org.jboss.seam.international.LocaleSelector	localeSelector
protected org.nuxeo.ecm.platform.ui.web.api.NavigationContext	navigationContext
protected org.nuxeo.ecm.core.api.DocumentModel	rightDoc
protected String	selectedVersionId
protected VersionedActions	versionedActions

Constructor Summary

Constructors

Constructor and Description
DiffActionsBean()

Method Summary

Modifier and Type	Method and Description
boolean	getCanDiffCurrentDefaultSelection() Checks if the diff action is available for the DocumentsListsManager.DEFAULT_WORKING_LIST working list.
boolean	getCanDiffCurrentDocumentSelection() Checks if the diff action is available for the DocumentsListsManager.CURRENT_DOCUMENT_SELECTION working list.
boolean	getCanDiffCurrentSectionSelection() Checks if the diff action is available for the DocumentsListsManager.CURRENT_DOCUMENT_SECTION_SELECTION working list.
boolean	getCanDiffCurrentTrashSelection() Checks if the diff action is available for the DocumentsListsManager.CURRENT_DOCUMENT_TRASH_SELECTION working list.
boolean	getCanDiffCurrentVersionSelection() Checks if the diff action is available for the VersionDocumentsListsConstants#CURRENT_VERSION_SELECTION working list.
boolean	getCanDiffWorkingList(String listName) Checks if the diff action is available for the listName working list.
String	getContentDiffDifferenceTypeMsgKey(DifferenceType differenceType) Gets the content diff difference type message key.
String	getContentDiffFancyBoxURL(String propertyLabel, String propertyXPath) Gets the content diff fancybox URL for the property with xpath propertyXPath.
String	getContentDiffFancyBoxURL(String propertyLabel, String propertyXPath, String conversionType) Gets the content diff fancybox URL for the property with xpath propertyXPath using conversionType.
String	getContentDiffURL(String propertyXPath, String conversionTypeParam) Gets the content diff URL.
String	getContentDiffURL(String docLeftId, String docRightId, String propertyXPath, String conversionTypeParam) Gets the content diff URL of two documents independently of the current document
String	getContentDiffWithBlobPostProcessingURL(String propertyXPath, String conversionTypeParam) Gets the content diff with blob post processing URL.
List<DiffDisplayBlock>	getDefaultDiffDisplayBlocks() Gets the document diff.
protected DiffDisplayService	getDiffDisplayService() Gets the diff display service.
String	getDiffSelectionType()
protected DocumentDiffService	getDocumentDiffService() Gets the document diff service.
org.nuxeo.ecm.core.api.DocumentModel	getLeftDoc()
org.nuxeo.ecm.core.api.DocumentModel	getRightDoc()
protected List<org.nuxeo.ecm.core.api.DocumentModel>	getWorkingList(String listName) Gets the listName working list.
boolean	isDifferentFilename(DifferenceType differenceType) Checks if is different filename.
boolean	isDocumentDiffAvailable() Checks if document diff is available.
String	prepareCurrentDefaultSelectionDiff() Prepares a diff of the current default selection.
String	prepareCurrentDocumentSelectionDiff() Prepares a diff of the current document selection.
String	prepareCurrentSectionSelectionDiff() Prepares a diff of the current section selection.
String	prepareCurrentTrashSelectionDiff() Prepares a diff of the current document trash selection.
String	prepareCurrentVersionDiff() Prepares a diff of the selected version with the live doc.
String	prepareCurrentVersionDiff(String versionLabel) Prepare a diff of the current document with a specific version
String	prepareCurrentVersionSelectionDiff() Prepares a diff of the current version selection.
String	prepareWorkingListDiff(String listName) Prepares a diff of the listName working list.
String	refresh() Refreshes the diff between leftDoc and rightDoc.
void	setDiffSelectionType(String diffSelectionType)
void	setLeftDoc(org.nuxeo.ecm.core.api.DocumentModel leftDoc)
void	setRightDoc(org.nuxeo.ecm.core.api.DocumentModel rightDoc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

documentManager

@In(create=true,
    required=false)
protected transient org.nuxeo.ecm.core.api.CoreSession documentManager

navigationContext

@In(create=true,
    required=false)
protected transient org.nuxeo.ecm.platform.ui.web.api.NavigationContext navigationContext

documentsListsManager

@In(create=true,
    required=false)
protected transient DocumentsListsManager documentsListsManager

versionedActions

@In(create=true,
    required=false)
protected transient VersionedActions versionedActions

localeSelector

@In(create=true)
protected transient org.jboss.seam.international.LocaleSelector localeSelector

leftDoc

protected org.nuxeo.ecm.core.api.DocumentModel leftDoc

rightDoc

protected org.nuxeo.ecm.core.api.DocumentModel rightDoc

selectedVersionId

protected String selectedVersionId

diffSelectionType

protected String diffSelectionType

Constructor Detail

DiffActionsBean

public DiffActionsBean()

Method Detail

getCanDiffCurrentDocumentSelection

public boolean getCanDiffCurrentDocumentSelection()

Checks if the diff action is available for the DocumentsListsManager.CURRENT_DOCUMENT_SELECTION working list.

Returns:

true if can diff the current document selection

getCanDiffCurrentTrashSelection

public boolean getCanDiffCurrentTrashSelection()

Checks if the diff action is available for the DocumentsListsManager.CURRENT_DOCUMENT_TRASH_SELECTION working list.

Returns:

true if can diff the current document trash selection

getCanDiffCurrentSectionSelection

public boolean getCanDiffCurrentSectionSelection()

Checks if the diff action is available for the DocumentsListsManager.CURRENT_DOCUMENT_SECTION_SELECTION working list.

Returns:

true if can diff the current section selection

getCanDiffCurrentVersionSelection

public boolean getCanDiffCurrentVersionSelection()

Checks if the diff action is available for the VersionDocumentsListsConstants#CURRENT_VERSION_SELECTION working list.

Returns:

true if can diff the current version selection

getCanDiffCurrentDefaultSelection

public boolean getCanDiffCurrentDefaultSelection()

Checks if the diff action is available for the DocumentsListsManager.DEFAULT_WORKING_LIST working list.

Returns:

true if can diff the current default working list selection

getCanDiffWorkingList

public boolean getCanDiffWorkingList(String listName)

Checks if the diff action is available for the listName working list.

Condition: the working list has exactly 2 documents.

Parameters:

listName - the list name

Returns:

true if can diff the listName working list

prepareCurrentDocumentSelectionDiff

public String prepareCurrentDocumentSelectionDiff()
                                           throws org.nuxeo.ecm.core.api.ClientException

Prepares a diff of the current document selection.

Returns:

the view id

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

prepareCurrentTrashSelectionDiff

public String prepareCurrentTrashSelectionDiff()
                                        throws org.nuxeo.ecm.core.api.ClientException

Prepares a diff of the current document trash selection.

Returns:

the view id

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

prepareCurrentSectionSelectionDiff

public String prepareCurrentSectionSelectionDiff()
                                          throws org.nuxeo.ecm.core.api.ClientException

Prepares a diff of the current section selection.

Returns:

the view id

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

prepareCurrentVersionSelectionDiff

public String prepareCurrentVersionSelectionDiff()
                                          throws org.nuxeo.ecm.core.api.ClientException

Prepares a diff of the current version selection.

Returns:

the view id

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

prepareCurrentDefaultSelectionDiff

public String prepareCurrentDefaultSelectionDiff()
                                          throws org.nuxeo.ecm.core.api.ClientException

Prepares a diff of the current default selection.

Returns:

the view id

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

prepareWorkingListDiff

public String prepareWorkingListDiff(String listName)
                              throws org.nuxeo.ecm.core.api.ClientException

Prepares a diff of the listName working list.

Returns:

the view id

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

prepareCurrentVersionDiff

public String prepareCurrentVersionDiff(String versionLabel)
                                 throws org.nuxeo.ecm.core.api.ClientException

Prepare a diff of the current document with a specific version

Parameters:

versionLabel - version label to look for, if you want the last version use org.nuxeo.ecm.diff.web .DiffActionsBean#LAST_VERSION_PROPERTY

Throws:

org.nuxeo.ecm.core.api.ClientException - if current document is null or if the expected version is missing.

prepareCurrentVersionDiff

public String prepareCurrentVersionDiff()
                                 throws org.nuxeo.ecm.core.api.ClientException

Prepares a diff of the selected version with the live doc.

Returns:

the view id

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

refresh

public String refresh()
               throws org.nuxeo.ecm.core.api.ClientException

Refreshes the diff between leftDoc and rightDoc.

Returns:

the view id

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

isDocumentDiffAvailable

public boolean isDocumentDiffAvailable()

Checks if document diff is available.

Returns:

true, if is document diff available

getDefaultDiffDisplayBlocks

@Factory(value="defaultDiffDisplayBlocks",
         scope=PAGE)
public List<DiffDisplayBlock> getDefaultDiffDisplayBlocks()
                                                                                                                   throws org.nuxeo.ecm.core.api.ClientException

Gets the document diff.

Returns:

the document diff between leftDoc and rightDoc if leftDoc and rightDoc aren't null, else null

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

getContentDiffFancyBoxURL

public String getContentDiffFancyBoxURL(String propertyLabel,
                                        String propertyXPath)
                                 throws org.nuxeo.ecm.core.api.ClientException

Gets the content diff fancybox URL for the property with xpath propertyXPath.

Parameters:

propertyLabel - the property label

propertyXPath - the property xpath

Returns:

the content diff fancybox URL

Throws:

org.nuxeo.ecm.core.api.ClientException - if the content diff fancybox URL cannot be retrieved

getContentDiffFancyBoxURL

public String getContentDiffFancyBoxURL(String propertyLabel,
                                        String propertyXPath,
                                        String conversionType)
                                 throws org.nuxeo.ecm.core.api.ClientException

Gets the content diff fancybox URL for the property with xpath propertyXPath using conversionType.

Parameters:

propertyLabel - the property label

propertyXPath - the property xpath

conversionType - the conversion type

Returns:

the content diff fancybox URL

Throws:

org.nuxeo.ecm.core.api.ClientException - if the content diff fancybox URL cannot be retrieved

getContentDiffURL

public String getContentDiffURL(String docLeftId,
                                String docRightId,
                                String propertyXPath,
                                String conversionTypeParam)
                         throws org.nuxeo.ecm.core.api.ClientException

Gets the content diff URL of two documents independently of the current document

Parameters:

docLeftId - a DocumentModel id, not a path.

docRightId - a DocumentModel id, not a path.

propertyXPath -

conversionTypeParam -

Returns:

Throws:

org.nuxeo.ecm.core.api.ClientException

getContentDiffURL

public String getContentDiffURL(String propertyXPath,
                                String conversionTypeParam)

Gets the content diff URL.

Parameters:

propertyXPath - the property xpath

conversionTypeParam - the conversion type param

Returns:

the content diff URL

getContentDiffWithBlobPostProcessingURL

public String getContentDiffWithBlobPostProcessingURL(String propertyXPath,
                                                      String conversionTypeParam)

Gets the content diff with blob post processing URL.

Parameters:

propertyXPath - the property xpath

conversionTypeParam - the conversion type param

Returns:

the content diff with blob post processing URL

isDifferentFilename

public boolean isDifferentFilename(DifferenceType differenceType)

Checks if is different filename.

getContentDiffDifferenceTypeMsgKey

public String getContentDiffDifferenceTypeMsgKey(DifferenceType differenceType)

Gets the content diff difference type message key.

getWorkingList

protected final List<org.nuxeo.ecm.core.api.DocumentModel> getWorkingList(String listName)
                                                                   throws org.nuxeo.ecm.core.api.ClientException

Gets the listName working list.

Returns:

the listName working list

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

getDocumentDiffService

protected final DocumentDiffService getDocumentDiffService()
                                                    throws org.nuxeo.ecm.core.api.ClientException

Gets the document diff service.

Returns:

the document diff service

Throws:

org.nuxeo.ecm.core.api.ClientException - if cannot get the document diff service

getDiffDisplayService

protected final DiffDisplayService getDiffDisplayService()
                                                  throws org.nuxeo.ecm.core.api.ClientException

Gets the diff display service.

Returns:

the diff display service

Throws:

org.nuxeo.ecm.core.api.ClientException - the client exception

getLeftDoc

public org.nuxeo.ecm.core.api.DocumentModel getLeftDoc()

setLeftDoc

public void setLeftDoc(org.nuxeo.ecm.core.api.DocumentModel leftDoc)

getRightDoc

public org.nuxeo.ecm.core.api.DocumentModel getRightDoc()

setRightDoc

public void setRightDoc(org.nuxeo.ecm.core.api.DocumentModel rightDoc)

getDiffSelectionType

public String getDiffSelectionType()

setDiffSelectionType

public void setDiffSelectionType(String diffSelectionType)