com.sample.module

Class SampleDocumentModifyingTransformer

java.lang.Object

com.sample.module.SampleDocumentModifyingTransformer

All Implemented Interfaces:

BaseDocumentTransformer, DocumentModifyingTransformer, Stage

public class SampleDocumentModifyingTransformer
extends Object
implements DocumentModifyingTransformer

An Example of the simplest document transformer possible.

Constructor Summary

Constructors

Constructor and Description
SampleDocumentModifyingTransformer()

Method Summary

Modifier and Type	Method and Description
String	getField()
String	getValue()
boolean	processDocument(IngestDocument doc) Processes a single IngestDocument.
void	setField(String field)
void	setValue(String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleDocumentModifyingTransformer

public SampleDocumentModifyingTransformer()

Method Detail

processDocument

public boolean processDocument(IngestDocument doc)
                        throws AttivioException

Description copied from interface: DocumentModifyingTransformer

Processes a single IngestDocument.

Specified by:

processDocument in interface DocumentModifyingTransformer

Parameters:

doc - the Attivio document to process

Returns:

true to continue processing the document, false to drop it

Throws:

AttivioException

getField

public String getField()

setField

public void setField(String field)

getValue

public String getValue()

setValue

public void setValue(String value)