org.nuxeo.ecm.diff.content.adapter.base

Class ConverterBasedContentDiffAdapter

java.lang.Object

org.nuxeo.ecm.diff.content.adapter.base.AbstractContentDiffAdapter

org.nuxeo.ecm.diff.content.adapter.base.ConverterBasedContentDiffAdapter

All Implemented Interfaces:

ContentDiffAdapter

public class ConverterBasedContentDiffAdapter
extends AbstractContentDiffAdapter

Base class for content diff based on "on the fly html or text transformers.

Since:

5.6

Author:

Antoine Taillefer

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_CONVERTER_NAME
protected String	defaultFieldXPath
protected org.nuxeo.ecm.platform.mimetype.interfaces.MimetypeRegistry	mimeTypeService

Fields inherited from class org.nuxeo.ecm.diff.content.adapter.base.AbstractContentDiffAdapter

adaptedDoc

Constructor Summary

Constructors

Constructor and Description
ConverterBasedContentDiffAdapter()

Method Summary

Modifier and Type	Method and Description
protected void	addSecondaryBlobs(List<org.nuxeo.ecm.core.api.Blob> blobResults, org.nuxeo.ecm.core.api.blobholder.BlobHolder blobHolder, String mainBlobFilename)
boolean	cachable()
void	cleanup()
protected org.nuxeo.ecm.core.api.blobholder.BlobHolder	getBlobHolder(org.nuxeo.ecm.core.api.DocumentModel doc, String xPath)
List<org.nuxeo.ecm.core.api.Blob>	getContentDiffBlobs(org.nuxeo.ecm.core.api.DocumentModel otherDoc, ContentDiffConversionType conversionType, Locale locale)
List<org.nuxeo.ecm.core.api.Blob>	getContentDiffBlobs(org.nuxeo.ecm.core.api.DocumentModel otherDoc, String xpath, ContentDiffConversionType conversionType, Locale locale)
protected org.nuxeo.ecm.core.convert.api.ConversionService	getConversionService() Gets the conversion service.
protected org.nuxeo.ecm.core.api.blobholder.BlobHolder	getConvertedBlobHolder(org.nuxeo.ecm.core.api.blobholder.BlobHolder blobHolder, String converterName) Returns a blob holder converted using the specified converter name.
protected String	getDefaultContentDiffFieldXPath()
protected org.nuxeo.ecm.core.api.impl.blob.StringBlob	getHtmlStringBlob(org.nuxeo.ecm.core.api.Blob blob)
protected String	getMimeType(org.nuxeo.ecm.core.api.Blob blob)
void	setDefaultContentDiffFieldXPath(String xPath)
protected void	setMimeType(org.nuxeo.ecm.core.api.blobholder.BlobHolder result)

Methods inherited from class org.nuxeo.ecm.diff.content.adapter.base.AbstractContentDiffAdapter

getContentDiffAdapterManager, getFileContentDiffBlobs, getFileContentDiffBlobs, getFileContentDiffURL, getFileContentDiffURL, setAdaptedDocument

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONVERTER_NAME

protected static final String DEFAULT_CONVERTER_NAME

See Also:

Constant Field Values

defaultFieldXPath

protected String defaultFieldXPath

mimeTypeService

protected org.nuxeo.ecm.platform.mimetype.interfaces.MimetypeRegistry mimeTypeService

Constructor Detail

ConverterBasedContentDiffAdapter

public ConverterBasedContentDiffAdapter()

Method Detail

getContentDiffBlobs

public List<org.nuxeo.ecm.core.api.Blob> getContentDiffBlobs(org.nuxeo.ecm.core.api.DocumentModel otherDoc,
                                                             ContentDiffConversionType conversionType,
                                                             Locale locale)
                                                      throws ContentDiffException,
                                                             org.nuxeo.ecm.core.convert.api.ConversionException

Specified by:

getContentDiffBlobs in class AbstractContentDiffAdapter

Throws:

ContentDiffException

org.nuxeo.ecm.core.convert.api.ConversionException

getContentDiffBlobs

public List<org.nuxeo.ecm.core.api.Blob> getContentDiffBlobs(org.nuxeo.ecm.core.api.DocumentModel otherDoc,
                                                             String xpath,
                                                             ContentDiffConversionType conversionType,
                                                             Locale locale)
                                                      throws ContentDiffException,
                                                             org.nuxeo.ecm.core.convert.api.ConversionException

Specified by:

getContentDiffBlobs in class AbstractContentDiffAdapter

Throws:

ContentDiffException

org.nuxeo.ecm.core.convert.api.ConversionException

cleanup

public void cleanup()

cachable

public boolean cachable()

setDefaultContentDiffFieldXPath

public void setDefaultContentDiffFieldXPath(String xPath)

getBlobHolder

protected org.nuxeo.ecm.core.api.blobholder.BlobHolder getBlobHolder(org.nuxeo.ecm.core.api.DocumentModel doc,
                                                                     String xPath)
                                                              throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getMimeType

protected String getMimeType(org.nuxeo.ecm.core.api.Blob blob)

setMimeType

protected void setMimeType(org.nuxeo.ecm.core.api.blobholder.BlobHolder result)
                    throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getDefaultContentDiffFieldXPath

protected String getDefaultContentDiffFieldXPath()

getConvertedBlobHolder

protected org.nuxeo.ecm.core.api.blobholder.BlobHolder getConvertedBlobHolder(org.nuxeo.ecm.core.api.blobholder.BlobHolder blobHolder,
                                                                              String converterName)
                                                                       throws org.nuxeo.ecm.core.convert.api.ConversionException,
                                                                              org.nuxeo.ecm.core.api.ClientException

Returns a blob holder converted using the specified converter name.

Parameters:

blobHolder - the blob holder

converterName - the converter name

Returns:

the converted blob holder

Throws:

org.nuxeo.ecm.core.api.ClientException - if an error occurs while getting the conversion service

org.nuxeo.ecm.core.convert.api.ConversionException - if an error occurs while converting the blob holder

getHtmlStringBlob

protected org.nuxeo.ecm.core.api.impl.blob.StringBlob getHtmlStringBlob(org.nuxeo.ecm.core.api.Blob blob)
                                                                 throws ContentDiffException

Throws:

ContentDiffException

addSecondaryBlobs

protected void addSecondaryBlobs(List<org.nuxeo.ecm.core.api.Blob> blobResults,
                                 org.nuxeo.ecm.core.api.blobholder.BlobHolder blobHolder,
                                 String mainBlobFilename)
                          throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getConversionService

protected final org.nuxeo.ecm.core.convert.api.ConversionService getConversionService()
                                                                               throws org.nuxeo.ecm.core.api.ClientException

Gets the conversion service.

Returns:

the conversion service

Throws:

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