org.nuxeo.ecm.diff.content

Class ContentDiffHelper

java.lang.Object

org.nuxeo.ecm.diff.content.ContentDiffHelper

public final class ContentDiffHelper
extends Object

Helper for content diff.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_DIFF_FANCYBOX_VIEW
static String	CONTENT_DIFF_URL_PREFIX
static String	CONVERSION_TYPE_URL_PARAM_NAME
static String	DEFAULT_XPATH
static String	LABEL_URL_PARAM_NAME
static String	LOCALE_URL_PARAM_NAME
static String	XPATH_URL_PARAM_NAME

Method Summary

Modifier and Type	Method and Description
static BlobHolder	getBlobHolder(DocumentModel doc, String xPath)
static String	getContentDiffFancyBoxURL(DocumentModel currentDoc, String propertyLabel, String propertyXPath, String conversionType) Gets the content diff fancy box URL.
static String	getContentDiffURL(DocumentModel leftDoc, DocumentModel rightDoc, String conversionType, String locale) Gets the content diff URL.
static String	getContentDiffURL(DocumentModel leftDoc, DocumentModel rightDoc, String propertyXPath, String conversionType, String locale) Gets the content diff URL.
static String	getContentDiffURL(String repositoryName, DocumentModel leftDoc, DocumentModel rightDoc, String propertyXPath, String conversionType, String locale) Gets the content diff URL.
protected static List<String>	getHtmlConversionBlackListedMimeTypes() Gets the list of blacklisted mime types for HTML conversion.
static boolean	isContentProperty(Serializable property) Checks if the specified property is a content property, ie.
static boolean	isDisplayHtmlConversion(Serializable property) Checks if the HTML conversion content diff is relevant for the specified property.
static boolean	isDisplayTextConversion(Serializable property) Checks if the text conversion content diff is relevant for the specified property.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_DIFF_FANCYBOX_VIEW

public static final String CONTENT_DIFF_FANCYBOX_VIEW

See Also:

Constant Field Values

LABEL_URL_PARAM_NAME

public static final String LABEL_URL_PARAM_NAME

See Also:

Constant Field Values

XPATH_URL_PARAM_NAME

public static final String XPATH_URL_PARAM_NAME

See Also:

Constant Field Values

CONVERSION_TYPE_URL_PARAM_NAME

public static final String CONVERSION_TYPE_URL_PARAM_NAME

See Also:

Constant Field Values

LOCALE_URL_PARAM_NAME

public static final String LOCALE_URL_PARAM_NAME

See Also:

Constant Field Values

CONTENT_DIFF_URL_PREFIX

public static final String CONTENT_DIFF_URL_PREFIX

See Also:

Constant Field Values

DEFAULT_XPATH

public static final String DEFAULT_XPATH

See Also:

Constant Field Values

Method Detail

getContentDiffFancyBoxURL

public static String getContentDiffFancyBoxURL(DocumentModel currentDoc,
                                               String propertyLabel,
                                               String propertyXPath,
                                               String conversionType)

Gets the content diff fancy box URL.

Parameters:

currentDoc - the current doc

propertyLabel - the property label

propertyXPath - the property xpath

conversionType - the conversion type

Returns:

the content diff fancy box URL

getContentDiffURL

public static String getContentDiffURL(DocumentModel leftDoc,
                                       DocumentModel rightDoc,
                                       String conversionType,
                                       String locale)

Gets the content diff URL.

Parameters:

leftDoc - the left doc

rightDoc - the right doc

conversionType - the conversion type

locale - the locale

Returns:

the content diff URL

getContentDiffURL

public static String getContentDiffURL(DocumentModel leftDoc,
                                       DocumentModel rightDoc,
                                       String propertyXPath,
                                       String conversionType,
                                       String locale)

Gets the content diff URL.

Parameters:

leftDoc - the left doc

rightDoc - the right doc

propertyXPath - the property xpath

conversionType - the conversion type

locale - the locale

Returns:

the content diff URL

getContentDiffURL

public static String getContentDiffURL(String repositoryName,
                                       DocumentModel leftDoc,
                                       DocumentModel rightDoc,
                                       String propertyXPath,
                                       String conversionType,
                                       String locale)

Gets the content diff URL.

Parameters:

repositoryName - the repository name

leftDoc - the left doc

rightDoc - the right doc

propertyXPath - the xpath

conversionType - the conversion type

locale - the locale

Returns:

the content diff URL

isDisplayHtmlConversion

public static boolean isDisplayHtmlConversion(Serializable property)

Checks if the HTML conversion content diff is relevant for the specified property.

isDisplayTextConversion

public static boolean isDisplayTextConversion(Serializable property)

Checks if the text conversion content diff is relevant for the specified property.

isContentProperty

public static boolean isContentProperty(Serializable property)

Checks if the specified property is a content property, ie. instanceof Blob.

getHtmlConversionBlackListedMimeTypes

protected static List<String> getHtmlConversionBlackListedMimeTypes()

Gets the list of blacklisted mime types for HTML conversion.

For now:

• PDF
• Office spreadsheet mime types
• Office presentation mime types

See Also:

https://jira.nuxeo.com/browse/NXP-9421, https://jira.nuxeo.com/browse/NXP-9431

getBlobHolder

public static BlobHolder getBlobHolder(DocumentModel doc,
                                       String xPath)
                                throws ContentDiffException

Throws:

ContentDiffException