Package org.tribuo.data.columnar

Class RowProcessor.Builder<T extends Output<T>>

java.lang.Object

org.tribuo.data.columnar.RowProcessor.Builder<T>

Type Parameters:

T - The output type.

Enclosing class:

RowProcessor<T extends Output<T>>

public static class RowProcessor.Builder<T extends Output<T>>
extends Object

Builder for RowProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()	Builder for RowProcessor, see RowProcessor constructors for argument details.

Method Summary

Modifier and Type	Method	Description
RowProcessor.Builder<T>	addFeatureProcessor(FeatureProcessor featureProcessor)	Add a single feature processor to the builder.
RowProcessor.Builder<T>	addFieldProcessor(FieldProcessor fieldProcessor)	Add a single field processor to the builder.
RowProcessor.Builder<T>	addMetadataExtractor(FieldExtractor<?> metadataExtractor)	Add a single metadata extractor to the builder.
RowProcessor.Builder<T>	addRegexMappingProcessor(String regex, FieldProcessor fieldProcessor)	Add a single regex FieldProcessor mapping to the builder.
RowProcessor<T>	build(ResponseProcessor<T> responseProcessor)	Construct the RowProcessor represented by this builder's state.
Optional<FieldProcessor>	getFieldProcessor(String fieldName)	Retrieves, if present, the fieldProcessor with the given name
Optional<FieldProcessor>	getRegexFieldProcessor(String regexName)	Retrieves, if present, the regexFieldProcessor with the given regex
RowProcessor.Builder<T>	setFeatureProcessors(Set<FeatureProcessor> featureProcessors)	The FeatureProcessors to apply to each extracted feature list.
RowProcessor.Builder<T>	setFieldProcessors(Iterable<FieldProcessor> fieldProcessors)	the FieldProcessors to apply to each row.
RowProcessor.Builder<T>	setMetadataExtractors(List<FieldExtractor<?>> metadataExtractors)	If set, the supplied FieldExtractors will be run for each example, populating Example.getMetadata().
RowProcessor.Builder<T>	setRegexMappingProcessors(Map<String,FieldProcessor> regexMappingProcessors)	A map from strings (interpreted as regular expressions by Pattern.compile(String)) to FieldProcessors such that if a field name matches a regular expression, the corresponding FieldProcessor is used to process it.
RowProcessor.Builder<T>	setReplaceNewLinesWithSpaces(boolean replaceNewLinesWithSpaces)	If true, replaces newlines in fields with spaces before passing them to FieldProcessors.
RowProcessor.Builder<T>	setWeightExtractor(FieldExtractor<Float> weightExtractor)	If set, the constructed RowProcessor will add the extracted floats into the Example.setWeight(float)s.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Builder for RowProcessor, see RowProcessor constructors for argument details.

Method Details

setReplaceNewLinesWithSpaces

public RowProcessor.Builder<T> setReplaceNewLinesWithSpaces(boolean replaceNewLinesWithSpaces)

If true, replaces newlines in fields with spaces before passing them to FieldProcessors.

Defaults to true, some FieldProcessors may behave unexpectedly if this is false.

Parameters:

replaceNewLinesWithSpaces - Should newlines be replaced with spaces when parsing fields?

Returns:

This builder with updated state

setWeightExtractor

public RowProcessor.Builder<T> setWeightExtractor(FieldExtractor<Float> weightExtractor)

If set, the constructed RowProcessor will add the extracted floats into the Example.setWeight(float)s. Otherwise, all examples will be equally weighted.

Parameters:

weightExtractor - FieldExtractor to generate example-wise weights

Returns:

This builder with updated state

setMetadataExtractors

public RowProcessor.Builder<T> setMetadataExtractors(List<FieldExtractor<?>> metadataExtractors)

If set, the supplied FieldExtractors will be run for each example, populating Example.getMetadata(). If two FieldExtractors in this list share the same FieldExtractor.getMetadataName(), build(ResponseProcessor) will throw a PropertyException.

N.B. this method overrides all existing values for metadata extractors, to non-destructively add use addMetadataExtractor(FieldExtractor).

Parameters:

metadataExtractors - List of metadata extractors to use

Returns:

This builder with updated state

addMetadataExtractor

public RowProcessor.Builder<T> addMetadataExtractor(FieldExtractor<?> metadataExtractor)

Add a single metadata extractor to the builder. See setMetadataExtractors(List) for more detail.

Parameters:

metadataExtractor - The extractor to add.

Returns:

This builder with updated state

setFeatureProcessors

public RowProcessor.Builder<T> setFeatureProcessors(Set<FeatureProcessor> featureProcessors)

The FeatureProcessors to apply to each extracted feature list.

N.B. this method overrides all existing values for feature processors, to non-destructively add use addFeatureProcessor(FeatureProcessor).

Parameters:

featureProcessors - the processors to add.

Returns:

This builder with updated state

addFeatureProcessor

public RowProcessor.Builder<T> addFeatureProcessor(FeatureProcessor featureProcessor)

Add a single feature processor to the builder. See setFeatureProcessors(Set) for more detail.

Parameters:

featureProcessor - the processor to add.

Returns:

This builder with updated state

addFieldProcessor

public RowProcessor.Builder<T> addFieldProcessor(FieldProcessor fieldProcessor)

Add a single field processor to the builder. If there is already a field processor with the same FieldProcessor.getFieldName(), warns and overwrites.

Parameters:

fieldProcessor - The field processor to add

Returns:

This builder with updated state

setFieldProcessors

public RowProcessor.Builder<T> setFieldProcessors(Iterable<FieldProcessor> fieldProcessors)

the FieldProcessors to apply to each row. Throws IllegalArgumentException if fieldProcessors have duplicate FieldProcessor.getFieldName() values.

N.B. this method overrides all existing values for field processors, to non-descructively add use addFieldProcessor(FieldProcessor).

Parameters:

fieldProcessors - an Iterable of field processors

Returns:

This builder with updated state

getFieldProcessor

public Optional<FieldProcessor> getFieldProcessor(String fieldName)

Retrieves, if present, the fieldProcessor with the given name

Parameters:

fieldName - The field name.

Returns:

The field processor or an empty optional.

setRegexMappingProcessors

public RowProcessor.Builder<T> setRegexMappingProcessors(Map<String,FieldProcessor> regexMappingProcessors)

A map from strings (interpreted as regular expressions by Pattern.compile(String)) to FieldProcessors such that if a field name matches a regular expression, the corresponding FieldProcessor is used to process it.

N.B. This method overrides all existing values for regex mapping, to non-destructively add use addRegexMappingProcessor(String, FieldProcessor). If none of the keys in the regex mapping processor match fields in your data, and there are only regex mapped fields, the RowProcessor's behavior is undefined.

Parameters:

regexMappingProcessors - The map from regex strings to FieldProcessors.

Returns:

This builder with updated state

getRegexFieldProcessor

public Optional<FieldProcessor> getRegexFieldProcessor(String regexName)

Retrieves, if present, the regexFieldProcessor with the given regex

Parameters:

regexName - The regex.

Returns:

The regexFieldProcessor or an empty optional.

addRegexMappingProcessor

public RowProcessor.Builder<T> addRegexMappingProcessor(String regex,
 FieldProcessor fieldProcessor)

Add a single regex FieldProcessor mapping to the builder. If there is already a field processor with the same regex, warns and overwrites.

N.B. If none of the keys in the regex mapping processor match fields in your data, and there are only regex mapped fields, the RowProcessor's behavior is undefined.

Parameters:

regex - The regex to use.

fieldProcessor - The field processor to apply when the regex matches.

Returns:

This builder with updated state

build

public RowProcessor<T> build(ResponseProcessor<T> responseProcessor)

Construct the RowProcessor represented by this builder's state. Throws PropertyException if the state is invalid. Throws IllegalArgumentException if there is not at least one FieldProcessor set via either addFieldProcessor(FieldProcessor), setFieldProcessors(Iterable), addRegexMappingProcessor(String, FieldProcessor) or setRegexMappingProcessors(Map).

N.B. If none of the keys in the regex mapping processor match fields in your data, and there are only regex mapped fields, the RowProcessor's behavior is undefined.

Parameters:

responseProcessor - The response processor to use.

Returns:

The RowProcessor represented by the builder's state