com.attivio.sdk.server.component.ingest

Interface FieldValueCreatingTransformer<T>

All Superinterfaces:

BaseDocumentTransformer, HasFieldMappingProperty, Stage

All Known Implementing Classes:

SampleFieldValueCreatingTransformer

public interface FieldValueCreatingTransformer<T>
extends BaseDocumentTransformer, HasFieldMappingProperty

Interface for document transformers that create a new field value based on an existing field's value.

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:

ProvidesProcessingFeedback

Method Summary

Modifier and Type	Method and Description
IngestFieldValue	createMappedValue(String inputFieldName, IngestFieldValue inputFieldValue) Process a single IngestFieldValue and return a new value to be placed into the document for this input->output mapping.

Methods inherited from interface com.attivio.sdk.server.component.configuration.HasFieldMappingProperty

getFieldMapping, setFieldMapping

Method Detail

createMappedValue

IngestFieldValue createMappedValue(String inputFieldName,
                                   IngestFieldValue inputFieldValue)
                            throws AttivioException

Process a single IngestFieldValue and return a new value to be placed into the document for this input->output mapping.

Parameters:

inputFieldName - The input field name being processed.

inputFieldValue - The value to process.

Returns:

the new IngestFieldValue or null to not output a value for this input value.

Throws:

AttivioException