gov.sandia.cognition.text.convert

Class DocumentSingleFieldConverter

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.data.convert.AbstractDataConverter<InputType,OutputType>

gov.sandia.cognition.text.convert.AbstractSingleTextualConverter<Document,Field>

gov.sandia.cognition.text.convert.DocumentSingleFieldConverter

All Implemented Interfaces:

DataConverter<Document,Field>, Evaluator<Document,Field>, SingleTextualConverter<Document,Field>, TextualConverter<Document,Field>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

public class DocumentSingleFieldConverter
extends AbstractSingleTextualConverter<Document,Field>

Extracts a single field from a document. Typically used between the document extraction stage and tokenization stage to choose what text field to use in the text analysis.

Since:

3.1

Author:

Justin Basilico

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	fieldName The name of the field to extract.

Constructor Summary

Constructors

Constructor and Description
DocumentSingleFieldConverter() Creates a new DocumentSingleFieldConverter with the body field as the field to extract.
DocumentSingleFieldConverter(java.lang.String fieldName) Creates a new DocumentSingleFieldConverter with the given field to extract.

Method Summary

Modifier and Type	Method and Description
Field	evaluate(Document input) Evaluates the function on the given input and returns the output.
java.lang.String	getFieldName() Gets the name of the field to extract.
void	setFieldName(java.lang.String fieldName) Sets the name of the field to extract.

Methods inherited from class gov.sandia.cognition.text.convert.AbstractSingleTextualConverter

convert, convertAll

Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable

clone

Methods inherited from class java.lang.Object

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

Field Detail

fieldName

protected java.lang.String fieldName

The name of the field to extract.

Constructor Detail

DocumentSingleFieldConverter

public DocumentSingleFieldConverter()

Creates a new DocumentSingleFieldConverter with the body field as the field to extract.

DocumentSingleFieldConverter

public DocumentSingleFieldConverter(java.lang.String fieldName)

Creates a new DocumentSingleFieldConverter with the given field to extract.

Parameters:

fieldName - The name of the field to extract.

Method Detail

evaluate

public Field evaluate(Document input)

Description copied from interface: Evaluator

Evaluates the function on the given input and returns the output.

Parameters:

input - The input to evaluate.

Returns:

The output produced by evaluating the input.

getFieldName

public java.lang.String getFieldName()

Gets the name of the field to extract.

Returns:

The name of the field to extract.

setFieldName

public void setFieldName(java.lang.String fieldName)

Sets the name of the field to extract.

Parameters:

fieldName - The name of the field to extract.