Package com.attivio.sdk.server.component.ingest

Interface MultiOutputDocumentTransformer

All Superinterfaces:

BaseDocumentTransformer, Stage

public interface MultiOutputDocumentTransformer
extends BaseDocumentTransformer

Interface for document transformers that create multiple output documents or messages for each input document.

Please refer to the com.attivio.sdk.server.component.configuration and com.attivio.sdk.server.component.lifecycle packages for mix-in interfaces that may be appropriate to implement along with this interface.

See Also:

ChildDocumentPostProcessor, ProvidesProcessingFeedback, MultiOutputDocumentTransformerMode

Method Summary

Modifier and Type	Method	Description
void	process(IngestDocument doc, DocumentOutputClient out)	Generates documents and messages from a single input document.

Method Detail

process

void process(IngestDocument doc,
             DocumentOutputClient out)
      throws AttivioException

Generates documents and messages from a single input document. The (possibly transformed) input document will be in the results only if explicitly fed via the out client. Otherwise it will be dropped.

Note, an exception will be thrown if the processing result contains new documents or messages. Such documents and messages should be added via the out client.

Parameters:

doc - the input document.

out - the IngestClient used to output the results of the transformation

Throws:

AttivioException