org.alfresco.repo.content.transform

Class PoiHssfContentTransformer

java.lang.Object

org.alfresco.repo.content.transform.ContentTransformerHelper

org.alfresco.repo.content.transform.AbstractContentTransformerLimits

org.alfresco.repo.content.transform.AbstractContentTransformer2

org.alfresco.repo.content.transform.TikaPoweredContentTransformer

org.alfresco.repo.content.transform.PoiHssfContentTransformer

All Implemented Interfaces:

ContentWorker, ContentTransformer, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class PoiHssfContentTransformer
extends TikaPoweredContentTransformer

Uses Apache Tika and Apache POI to perform conversions from Excel spreadsheets.

Will transform from Excel spreadsheets into Html, Xml or Text (space or comma separated)

Handles all sheets in the file.

Author:

Nick Burch, Derek Hulley

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PoiHssfContentTransformer.CsvContentHandler A wrapper around the normal Tika BodyContentHandler, which causes things to be CSV encoded rather than tab separated

Field Summary

Fields

Modifier and Type	Field and Description
static String	WRONG_FORMAT_MESSAGE_ID Error message to delegate to NodeInfoBean

Fields inherited from class org.alfresco.repo.content.transform.TikaPoweredContentTransformer

documentSelector, LINE_BREAK, sourceMimeTypes

Fields inherited from class org.alfresco.repo.content.transform.AbstractContentTransformerLimits

transformerDebug

Fields inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

transformerConfig

Constructor Summary

Constructors

Constructor and Description
PoiHssfContentTransformer()

Method Summary

Modifier and Type	Method and Description
protected ContentHandler	getContentHandler(String targetMimeType, Writer output) Returns an appropriate Tika ContentHandler for the requested content type.
protected org.apache.tika.parser.Parser	getParser() Returns the correct Tika Parser to process the document.
boolean	isExplicitTransformation(String sourceMimetype, String targetMimetype, TransformationOptions options) Make sure we win over openoffice when it comes to producing HTML
boolean	isTransformableMimetype(String sourceMimetype, String targetMimetype, TransformationOptions options) Can we do the requested transformation via Tika? We support transforming to HTML, XML, Text or CSV

Methods inherited from class org.alfresco.repo.content.transform.TikaPoweredContentTransformer

buildParseContext, getComments, getDocumentSelector, setDocumentSelector, transformInternal

Methods inherited from class org.alfresco.repo.content.transform.AbstractContentTransformer2

checkTransformable, getExecutorService, getRetryTransformOnDifferentMimeType, getStrictMimeTypeCheck, getTransformationTime, getTransformationTime, isTransformationLimitedInternally, recordError, recordTime, recordTime, register, setAdditionalThreadTimout, setExecutorService, setMetadataExtracterConfig, setRegisterTransformer, setRegistry, setRetryTransformOnDifferentMimeType, setStrictMimeTypeCheck, setUseTimeoutThread, toString, transform, transform, transform

Methods inherited from class org.alfresco.repo.content.transform.AbstractContentTransformerLimits

getLimits, getLimits, getLimits, getMaxPages, getMaxSourceSizeKBytes, getMaxSourceSizeKBytes, getPageLimit, getReadLimitKBytes, getReadLimitTimeMs, getTimeoutMs, isPageLimitSupported, isTransformable, isTransformable, isTransformableSize, setLimits, setMaxPages, setMaxSourceSizeKBytes, setMimetypeLimits, setPageLimit, setPageLimitsSupported, setReaderLimits, setReadLimitKBytes, setReadLimitTimeMs, setTimeoutMs, setTransformerDebug

Methods inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

deprecatedSetter, equals, getBeanName, getCommentsOnlySupports, getExtensionOrAny, getMimetype, getMimetypeService, getName, getSimpleName, hashCode, isSupportedTransformation, onlySupports, setBeanName, setExplicitTransformations, setMimetypeService, setSupportedTransformations, setTransformerConfig, setUnsupportedTransformations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.alfresco.repo.content.transform.ContentTransformer

getName

Field Detail

WRONG_FORMAT_MESSAGE_ID

public static final String WRONG_FORMAT_MESSAGE_ID

Error message to delegate to NodeInfoBean

See Also:

Constant Field Values

Constructor Detail

PoiHssfContentTransformer

public PoiHssfContentTransformer()

Method Detail

getParser

protected org.apache.tika.parser.Parser getParser()

Description copied from class: TikaPoweredContentTransformer

Returns the correct Tika Parser to process the document. If you don't know which you want, use TikaAutoContentTransformer which makes use of the Tika auto-detection.

Specified by:

getParser in class TikaPoweredContentTransformer

isTransformableMimetype

public boolean isTransformableMimetype(String sourceMimetype,
                                       String targetMimetype,
                                       TransformationOptions options)

Can we do the requested transformation via Tika? We support transforming to HTML, XML, Text or CSV

Specified by:

isTransformableMimetype in interface ContentTransformer

Overrides:

isTransformableMimetype in class TikaPoweredContentTransformer

Parameters:

sourceMimetype - the source mimetype

targetMimetype - the target mimetype

options - the transformation options

Returns:

boolean true if this content transformer can satify the mimetypes, false otherwise

isExplicitTransformation

public boolean isExplicitTransformation(String sourceMimetype,
                                        String targetMimetype,
                                        TransformationOptions options)

Make sure we win over openoffice when it comes to producing HTML

Specified by:

isExplicitTransformation in interface ContentTransformer

Overrides:

isExplicitTransformation in class ContentTransformerHelper

Parameters:

sourceMimetype - the source mimetype

targetMimetype - the target mimetype

options - the transformation options

Returns:

boolean true if it is an explicit transformation, false otherwise

See Also:

ContentTransformer.isExplicitTransformation(java.lang.String, java.lang.String, org.alfresco.service.cmr.repository.TransformationOptions)

getContentHandler

protected ContentHandler getContentHandler(String targetMimeType,
                                           Writer output)
                                    throws TransformerConfigurationException

Description copied from class: TikaPoweredContentTransformer

Returns an appropriate Tika ContentHandler for the requested content type. Normally you'll let this work as default, but if you need fine-grained control of how the Tika events become text then override and supply your own.

Overrides:

getContentHandler in class TikaPoweredContentTransformer

Throws:

TransformerConfigurationException