Package org.tribuo.data.columnar.extractors

Class DateExtractor

java.lang.Object

org.tribuo.data.columnar.extractors.SimpleFieldExtractor<LocalDate>

org.tribuo.data.columnar.extractors.DateExtractor

All Implemented Interfaces:

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

public class DateExtractor
extends SimpleFieldExtractor<LocalDate>

Extracts the field value and translates it to a LocalDate based on the specified DateTimeFormatter.

Returns an empty optional if the date failed to parse.

Field Summary

Fields inherited from class org.tribuo.data.columnar.extractors.SimpleFieldExtractor

fieldName, metadataName

Constructor Summary

Constructors

Constructor	Description
DateExtractor(String fieldName, String metadataName, String dateFormat)	Constructs a date extractor that emits a LocalDate by applying the supplied format to the specified field.
DateExtractor(String fieldName, String metadataName, String dateFormat, String localeLanguage, String localeCountry)	Constructs a date extractor that emits a LocalDate by applying the supplied format to the specified field.
DateExtractor(String fieldName, String metadataName, DateTimeFormatter formatter)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected Optional<LocalDate>	extractField(String s)	Extracts the field value, or returns Optional.empty() if it failed to parse.
com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance	getProvenance()
Class<LocalDate>	getValueType()	Gets the class of the value produced by this extractor.
void	postConfig()	Used by the OLCUT configuration system, and should not be called by external code.
String	toString()

Methods inherited from class org.tribuo.data.columnar.extractors.SimpleFieldExtractor

extract, getFieldName, getMetadataName

Methods inherited from class java.lang.Object

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

Constructor Details

DateExtractor

public DateExtractor(String fieldName,
 String metadataName,
 String dateFormat)

Constructs a date extractor that emits a LocalDate by applying the supplied format to the specified field.

Uses the system locale for backwards compatibility with 4.0 and 4.1.

Parameters:

fieldName - The field to read.

metadataName - The metadata field to write.

dateFormat - The date format (supplied to DateTimeFormatter.

DateExtractor

public DateExtractor(String fieldName,
 String metadataName,
 String dateFormat,
 String localeLanguage,
 String localeCountry)

Constructs a date extractor that emits a LocalDate by applying the supplied format to the specified field.

Parameters:

fieldName - The field to read.

metadataName - The metadata field to write to.

dateFormat - The date format (supplied to DateTimeFormatter.

localeLanguage - The locale language.

localeCountry - The locale country.

DateExtractor

@Deprecated
public DateExtractor(String fieldName,
 String metadataName,
 DateTimeFormatter formatter)

Deprecated.

Constructs a date extractor that emits a LocalDate by applying the supplied format to the specified field.

Deprecated as it does not allow recovery of the formatter pattern for the provenance.

Uses the system locale for backwards compatibility with 4.0 and 4.1.

Parameters:

fieldName - The field to read.

metadataName - The metadata field to write.

formatter - The date format (supplied to DateTimeFormatter.

Method Details

postConfig

public void postConfig()

Used by the OLCUT configuration system, and should not be called by external code.

Specified by:

postConfig in interface com.oracle.labs.mlrg.olcut.config.Configurable

Overrides:

postConfig in class SimpleFieldExtractor<LocalDate>

getValueType

public Class<LocalDate> getValueType()

Description copied from interface: FieldExtractor

Gets the class of the value produced by this extractor.

Returns:

The class of the value.

extractField

protected Optional<LocalDate> extractField(String s)

Description copied from class: SimpleFieldExtractor

Extracts the field value, or returns Optional.empty() if it failed to parse.

Specified by:

extractField in class SimpleFieldExtractor<LocalDate>

Parameters:

s - The field value to read.

Returns:

The extracted value.

toString

public String toString()

Overrides:

toString in class SimpleFieldExtractor<LocalDate>

getProvenance

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