com.exalead.pdoc.plugins

Interface DocumentPartTransformer

All Known Implementing Classes:

DocumentPartTransformer.DefaultImpl

public interface DocumentPartTransformer

Document format transformer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DocumentPartTransformer.DefaultImpl Default DocumentPartTransformer implementation.
static class	DocumentPartTransformer.DocumentPartTransformerException Document exception.
static interface	DocumentPartTransformer.Format Format transformation.
static class	DocumentPartTransformer.TransformationException Transformation exception.
static class	DocumentPartTransformer.TransformationTimeoutException Timeout during transformation.
static class	DocumentPartTransformer.TransformKind Kind of transformation.
static class	DocumentPartTransformer.UnsupportedFormatException Unsupported format (generic).
static class	DocumentPartTransformer.UnsupportedInputFormatException Unsupported input format.
static class	DocumentPartTransformer.UnsupportedOutputFormatException Unsupported output format.

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.

Method Detail

transform

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

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

Parameters:

part - the input part.

format - the transformation format

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

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

Throws:

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

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

getSupporterOutputMime

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

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)

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.