com.norconex.importer.handler.transformer

Interface IDocumentTransformer

All Superinterfaces:

IImporterHandler

All Known Implementing Classes:

AbstractCharStreamTransformer, AbstractDocumentTransformer, AbstractStringTransformer, CharsetTransformer, ExternalTransformer, NoContentTransformer, ReduceConsecutivesTransformer, ReplaceTransformer, ScriptTransformer, StripAfterTransformer, StripBeforeTransformer, StripBetweenTransformer, SubstringTransformer

public interface IDocumentTransformer
extends IImporterHandler

Transformers allow to manipulate and modify a document metadata or content.

Author:

Pascal Essiembre

Method Summary

Modifier and Type	Method and Description
void	transformDocument(String reference, InputStream input, OutputStream output, ImporterMetadata metadata, boolean parsed) Transforms document content and metadata.

Method Detail

transformDocument

void transformDocument(String reference,
                       InputStream input,
                       OutputStream output,
                       ImporterMetadata metadata,
                       boolean parsed)
                throws ImporterHandlerException

Transforms document content and metadata.

Parameters:

reference - document reference (e.g. URL)

input - document to transform

output - transformed document

metadata - document metadata

parsed - whether the document has been parsed already or not (a parsed document should normally be text-based)

Throws:

ImporterHandlerException - could not transform the document