org.tribuo.data.columnar.processors.field

Class IdentityProcessor

java.lang.Object

org.tribuo.data.columnar.processors.field.IdentityProcessor

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 IdentityProcessor
extends Object
implements FieldProcessor

A FieldProcessor which converts the field name and value into a feature with a value of FEATURE_VALUE.

Nested Class Summary

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

FieldProcessor.GeneratedFeatureType

Field Summary

Fields

Modifier and Type	Field and Description
static double	FEATURE_VALUE The value of the emitted features.

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

NAMESPACE

Constructor Summary

Constructors

Constructor and Description
IdentityProcessor(String fieldName) Constructs a field processor which emits a single feature with a specific value and uses the field name and field value as the feature name.

Method Summary

Modifier and Type	Method and Description
IdentityProcessor	copy(String newFieldName) Returns a copy of this FieldProcessor bound to the supplied newFieldName.
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()

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

Field Detail

FEATURE_VALUE

public static final double FEATURE_VALUE

The value of the emitted features.

See Also:

Constant Field Values

Constructor Detail

IdentityProcessor

public IdentityProcessor(String fieldName)

Constructs a field processor which emits a single feature with a specific value and uses the field name and field value as the feature name.

Parameters:

fieldName - The field name to read.

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 IdentityProcessor copy(String newFieldName)

Description copied from interface: FieldProcessor

Returns a copy of this FieldProcessor bound to the supplied newFieldName.

Specified by:

copy in interface FieldProcessor

Parameters:

newFieldName - The new field name for the copy.

Returns:

A copy of this FieldProcessor.

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>