org.nuxeo.ecm.platform.preview.adapter.base

Class ConverterBasedHtmlPreviewAdapter

java.lang.Object

org.nuxeo.ecm.platform.preview.adapter.base.AbstractHtmlPreviewAdapter

org.nuxeo.ecm.platform.preview.adapter.base.ConverterBasedHtmlPreviewAdapter

All Implemented Interfaces:

HtmlPreviewAdapter

public class ConverterBasedHtmlPreviewAdapter
extends AbstractHtmlPreviewAdapter

Base class for preview based on "on the fly" HTML transformers

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALLOW_ZIP_PREVIEW
protected String	defaultFieldXPath
protected MimetypeRegistry	mimeTypeService
static String	OLD_PREVIEW_PROPERTY Deprecated. since 10.3
static String	TEXT_ANNOTATIONS_PROPERTY Deprecated. since 10.3

Fields inherited from class org.nuxeo.ecm.platform.preview.adapter.base.AbstractHtmlPreviewAdapter

adaptedDoc, previewManager

Constructor Summary

Constructors

Constructor and Description
ConverterBasedHtmlPreviewAdapter()

Method Summary

Modifier and Type	Method and Description
boolean	cachable()
void	cleanup()
ConversionService	getConversionService()
protected String	getDefaultPreviewFieldXPath()
protected static String	getMimeType(Blob blob)
String	getMimeType(File file)
protected String	getMimeType(String xpath)
MimetypeRegistry	getMimeTypeService()
List<Blob>	getPreviewBlobs()
List<Blob>	getPreviewBlobs(String xpath)
protected List<Blob>	getPreviewFromMimeTypePreviewer(MimeTypePreviewer mtPreviewer, Blob blob2Preview) Deprecated. since 10.3
protected PreviewAdapterManager	getPreviewManager()
boolean	hasBlobToPreview() Check if the document holds some blobs that are suitable for preview
boolean	hasPreview(String xpath)
void	setDefaultPreviewFieldXPath(String xPath)
protected void	setDigest(BlobHolder result)
protected void	setMimeType(BlobHolder result)

Methods inherited from class org.nuxeo.ecm.platform.preview.adapter.base.AbstractHtmlPreviewAdapter

getFilePreviewBlobs, getFilePreviewBlobs, getFilePreviewBlobs, getFilePreviewBlobs, getFilePreviewURL, getFilePreviewURL, getPreviewTitle, postProcessBlobs, setAdaptedDocument, updateTitleInHtml, updateTitleInHtml

Methods inherited from class java.lang.Object

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

Field Detail

OLD_PREVIEW_PROPERTY

public static final String OLD_PREVIEW_PROPERTY

Deprecated. since 10.3

Since:

10.3

See Also:

Constant Field Values

TEXT_ANNOTATIONS_PROPERTY

public static final String TEXT_ANNOTATIONS_PROPERTY

Deprecated. since 10.3

Since:

10.3

See Also:

Constant Field Values

defaultFieldXPath

protected String defaultFieldXPath

mimeTypeService

protected MimetypeRegistry mimeTypeService

ALLOW_ZIP_PREVIEW

protected static final String ALLOW_ZIP_PREVIEW

Since:

8.10

See Also:

Constant Field Values

Constructor Detail

ConverterBasedHtmlPreviewAdapter

public ConverterBasedHtmlPreviewAdapter()

Method Detail

getConversionService

public ConversionService getConversionService()

getPreviewManager

protected PreviewAdapterManager getPreviewManager()

Overrides:

getPreviewManager in class AbstractHtmlPreviewAdapter

getMimeType

protected static String getMimeType(Blob blob)

getMimeType

protected String getMimeType(String xpath)

getDefaultPreviewFieldXPath

protected String getDefaultPreviewFieldXPath()

setDefaultPreviewFieldXPath

public void setDefaultPreviewFieldXPath(String xPath)

getPreviewBlobs

public List<Blob> getPreviewBlobs()
                           throws PreviewException

Specified by:

getPreviewBlobs in class AbstractHtmlPreviewAdapter

Throws:

PreviewException

hasPreview

public boolean hasPreview(String xpath)

getPreviewBlobs

public List<Blob> getPreviewBlobs(String xpath)
                           throws PreviewException

Specified by:

getPreviewBlobs in class AbstractHtmlPreviewAdapter

Throws:

PreviewException

getPreviewFromMimeTypePreviewer

protected List<Blob> getPreviewFromMimeTypePreviewer(MimeTypePreviewer mtPreviewer,
                                                     Blob blob2Preview)

Deprecated. since 10.3

Backward compatibility method to trigger the right previewers if 'nuxeo.old.jsf.preview' is set.

This allows old HTML preview to be used, to make annotations available.

To be removed with JSF UI.

Since:

10.3

setMimeType

protected void setMimeType(BlobHolder result)

setDigest

protected void setDigest(BlobHolder result)

getMimeType

public String getMimeType(File file)
                   throws ConversionException

Throws:

ConversionException

getMimeTypeService

public MimetypeRegistry getMimeTypeService()
                                    throws ConversionException

Throws:

ConversionException

cleanup

public void cleanup()

cachable

public boolean cachable()

hasBlobToPreview

public boolean hasBlobToPreview()
                         throws PreviewException

Description copied from interface: HtmlPreviewAdapter

Check if the document holds some blobs that are suitable for preview

Returns:

Throws:

PreviewException