com.sample.module

Class SampleFieldValueCreatingTransformer

java.lang.Object

com.sample.module.SampleFieldValueCreatingTransformer

All Implemented Interfaces:

HasFieldMappingProperty, BaseDocumentTransformer, FieldValueCreatingTransformer<String>, Stage

public class SampleFieldValueCreatingTransformer
extends Object
implements FieldValueCreatingTransformer<String>

Sample document transformer demonstrating implementation of a FieldValueCreatingTransformer. In this example, a new field value is created that will contain the lower-case version of the input field's value.

Constructor Summary

Constructors

Constructor and Description
SampleFieldValueCreatingTransformer()

Method Summary

Modifier and Type	Method and Description
IngestFieldValue	createMappedValue(String inputFieldName, IngestFieldValue fv) Process a single IngestFieldValue and return a new value to be placed into the document for this input->output mapping.
Map<String,String>	getFieldMapping() Gets the Input to Output field name mapping for this stage to process.
void	setFieldMapping(Map<String,String> value) Sets the Input to Output field name mapping for this stage to process.

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleFieldValueCreatingTransformer

public SampleFieldValueCreatingTransformer()

Method Detail

createMappedValue

public IngestFieldValue createMappedValue(String inputFieldName,
                                          IngestFieldValue fv)
                                   throws AttivioException

Description copied from interface: FieldValueCreatingTransformer

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

Specified by:

createMappedValue in interface FieldValueCreatingTransformer<String>

Parameters:

inputFieldName - The input field name being processed.

fv - The value to process.

Returns:

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

Throws:

AttivioException

getFieldMapping

public Map<String,String> getFieldMapping()

Description copied from interface: HasFieldMappingProperty

Gets the Input to Output field name mapping for this stage to process.

Specified by:

getFieldMapping in interface HasFieldMappingProperty

setFieldMapping

public void setFieldMapping(Map<String,String> value)

Description copied from interface: HasFieldMappingProperty

Sets the Input to Output field name mapping for this stage to process.

Specified by:

setFieldMapping in interface HasFieldMappingProperty