org.alfresco.repo.content.transform

Class StringExtractingContentTransformer

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.StringExtractingContentTransformer

All Implemented Interfaces:

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

public class StringExtractingContentTransformer
extends AbstractContentTransformer2

Converts any textual format to plain text.

The transformation is sensitive to the source and target string encodings.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFIX_TEXT

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

transformerDebug

Constructor Summary

Constructors

Constructor and Description
StringExtractingContentTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isTransformableMimetype(java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options) Gives a high reliability for all translations from text/sometype to text/plain.
void	transformInternal(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, TransformationOptions options) Text to text conversions are done directly using the content reader and writer string manipulation methods.

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

checkTransformable, getTransformationTime, recordTime, register, setProperties, setRegistry, toString, transform, transform, transform

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

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

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

getMimetype, getMimetypeService, isExplicitTransformation, isSupportedTransformation, setExplicitTransformations, setMimetypeService, setSupportedTransformations

Methods inherited from class java.lang.Object

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

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

isExplicitTransformation

Field Detail

PREFIX_TEXT

public static final java.lang.String PREFIX_TEXT

See Also:

Constant Field Values

Constructor Detail

StringExtractingContentTransformer

public StringExtractingContentTransformer()

Method Detail

isTransformableMimetype

public boolean isTransformableMimetype(java.lang.String sourceMimetype,
                              java.lang.String targetMimetype,
                              TransformationOptions options)

Gives a high reliability for all translations from text/sometype to text/plain. As the text formats are already text, the characters are preserved and no actual conversion takes place.

Extraction of text from binary data is wholly unreliable.

Specified by:

isTransformableMimetype in interface ContentTransformer

Overrides:

isTransformableMimetype in class AbstractContentTransformerLimits

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

transformInternal

public void transformInternal(org.alfresco.service.cmr.repository.ContentReader reader,
                     org.alfresco.service.cmr.repository.ContentWriter writer,
                     TransformationOptions options)
                       throws java.lang.Exception

Text to text conversions are done directly using the content reader and writer string manipulation methods.

Extraction of text from binary content attempts to take the possible character encoding into account. The text produced from this will, if the encoding was correct, be unformatted but valid.

Specified by:

transformInternal in class AbstractContentTransformer2

Parameters:

reader - the source of the content to transform

writer - the target to which to write the transformed content

options - a map of options to use when performing the transformation. The map will never be null.

Throws:

java.lang.Exception - exceptions will be handled by this class - subclasses can throw anything