com.exalead.pdoc.plugins

Class DocumentPartTransformer.DefaultImpl

java.lang.Object

com.exalead.pdoc.plugins.DocumentPartTransformer.DefaultImpl

All Implemented Interfaces:

DocumentPartTransformer

Enclosing interface:

DocumentPartTransformer

public static class DocumentPartTransformer.DefaultImpl
extends java.lang.Object
implements DocumentPartTransformer

Default DocumentPartTransformer implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface com.exalead.pdoc.plugins.DocumentPartTransformer

DocumentPartTransformer.DefaultImpl, DocumentPartTransformer.DocumentPartTransformerException, DocumentPartTransformer.Format, DocumentPartTransformer.TransformationException, DocumentPartTransformer.TransformationTimeoutException, DocumentPartTransformer.TransformKind, DocumentPartTransformer.UnsupportedFormatException, DocumentPartTransformer.UnsupportedInputFormatException, DocumentPartTransformer.UnsupportedOutputFormatException

Constructor Summary

Constructors

Constructor and Description
DefaultImpl()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getSupporterOutputMime(DocumentPartTransformer.TransformKind kind) Get the list of supported MIME output formats per transformation kind.
void	transform(DocumentPart part, ProcessableDocument input, ProcessableDocument output, DocumentPartTransformer.Format format) Transform a part 'part' using the format 'format' into a destination document.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultImpl

public DefaultImpl()

Method Detail

transform

public void transform(DocumentPart part,
                      ProcessableDocument input,
                      ProcessableDocument output,
                      DocumentPartTransformer.Format format)
               throws DocumentPartTransformer.TransformationException,
                      DocumentPartTransformer.UnsupportedInputFormatException,
                      DocumentPartTransformer.UnsupportedOutputFormatException,
                      java.lang.NoSuchMethodException

Description copied from interface: DocumentPartTransformer

Transform a part 'part' using the format 'format' into a destination document. Use getSupporterOutputMime() to get the list of supported output MIME types.

Specified by:

transform in interface DocumentPartTransformer

Parameters:

part - the input part.

input - the source document (part is probably in this document)

output - the target document (parts are stored inside this document)

format - the transformation format

Throws:

DocumentPartTransformer.TransformationException - upon error (in this case, the upstream client may choose to give up on the input, or select another filter) Note: input and output may be the same objects

DocumentPartTransformer.UnsupportedInputFormatException - if the input format is not supported by the filter (in this case, the upstream client will give up with the current filter)

DocumentPartTransformer.UnsupportedOutputFormatException - if the output format is not supported by the filter (in this case, the upstream client may retry with a different format, using the same transformer)

java.lang.NoSuchMethodException - if the method is not supported

getSupporterOutputMime

public java.util.List<java.lang.String> getSupporterOutputMime(DocumentPartTransformer.TransformKind kind)

Description copied from interface: DocumentPartTransformer

Get the list of supported MIME output formats per transformation kind. For TransformKind.display, the types advertise the first produced part MIME type. (an hypertext text/html document may have additional parts with different formats)

Specified by:

getSupporterOutputMime in interface DocumentPartTransformer

Parameters:

kind - the kind of transformation: Note: the returned array may include Format.MIME_GENERIC to advertise a filter producing any type of document or an unknown subset of document types.