org.tribuo.data.columnar.processors.field

Class TextFieldProcessor

java.lang.Object

org.tribuo.data.columnar.processors.field.TextFieldProcessor

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Configurable, com.oracle.labs.mlrg.olcut.provenance.Provenancable<com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance>, FieldProcessor

public class TextFieldProcessor
extends Object
implements FieldProcessor

A FieldProcessor which takes a text field and runs a TextPipeline on it to generate features.

Nested Class Summary

Nested classes/interfaces inherited from interface org.tribuo.data.columnar.FieldProcessor

FieldProcessor.GeneratedFeatureType

Field Summary

Fields inherited from interface org.tribuo.data.columnar.FieldProcessor

NAMESPACE

Constructor Summary

Constructors

Constructor and Description
TextFieldProcessor(String fieldName, TextPipeline pipeline) Constructs a field processor which uses the supplied text pipeline to process the field value.

Method Summary

Modifier and Type	Method and Description
TextFieldProcessor	copy(String newFieldName) Note: the copy shares the text pipeline with the original.
FieldProcessor.GeneratedFeatureType	getFeatureType() Returns the feature type this FieldProcessor generates.
String	getFieldName() Gets the field name this FieldProcessor uses.
com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance	getProvenance()
List<ColumnarFeature>	process(String value) Processes the field value and generates a (possibly empty) list of ColumnarFeatures.
String	toString()
static List<ColumnarFeature>	wrapFeatures(String fieldName, List<Feature> inputFeatures) Convert the Features from a text pipeline into ColumnarFeatures with the right field name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tribuo.data.columnar.FieldProcessor

getNumNamespaces

Methods inherited from interface com.oracle.labs.mlrg.olcut.config.Configurable

postConfig

Constructor Detail

TextFieldProcessor

public TextFieldProcessor(String fieldName,
                          TextPipeline pipeline)

Constructs a field processor which uses the supplied text pipeline to process the field value.

Parameters:

fieldName - The field name to read.

pipeline - The text processing pipeline to use.

Method Detail

getFieldName

public String getFieldName()

Description copied from interface: FieldProcessor

Gets the field name this FieldProcessor uses.

Specified by:

getFieldName in interface FieldProcessor

Returns:

The field name.

process

public List<ColumnarFeature> process(String value)

Description copied from interface: FieldProcessor

Processes the field value and generates a (possibly empty) list of ColumnarFeatures.

Specified by:

process in interface FieldProcessor

Parameters:

value - The field value to process.

Returns:

A list of ColumnarFeatures.

getFeatureType

public FieldProcessor.GeneratedFeatureType getFeatureType()

Description copied from interface: FieldProcessor

Returns the feature type this FieldProcessor generates.

Specified by:

getFeatureType in interface FieldProcessor

Returns:

The feature type.

copy

public TextFieldProcessor copy(String newFieldName)

Note: the copy shares the text pipeline with the original. This may induce multithreading issues if the underlying pipeline is not thread safe. Tribuo builtin pipelines are thread safe.

Specified by:

copy in interface FieldProcessor

Parameters:

newFieldName - The new field name for the copy.

Returns:

A copy of this TextFieldProcessor with the new field name.

wrapFeatures

public static List<ColumnarFeature> wrapFeatures(String fieldName,
                                                 List<Feature> inputFeatures)

Convert the Features from a text pipeline into ColumnarFeatures with the right field name.

Parameters:

fieldName - The field name to prepend.

inputFeatures - The features to convert.

Returns:

A list of columnar features.

toString

public String toString()

Overrides:

toString in class Object

getProvenance

public com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance getProvenance()

Specified by:

getProvenance in interface com.oracle.labs.mlrg.olcut.provenance.Provenancable<com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance>