gov.sandia.cognition.text.convert

Interface TextualConverter<InputType,OutputType extends Textual>

Type Parameters:

InputType - The type of input that can be converted to a textual form.

OutputType - The type of textual output of the converter. Must implement the Textual interface.

All Known Subinterfaces:

MultiTextualConverter<InputType,OutputType>, SingleTextualConverter<InputType,OutputType>

All Known Implementing Classes:

AbstractMultiTextualConverter, AbstractSingleTextualConverter, AbstractTextualConverter, DocumentFieldConcatenator, DocumentSingleFieldConverter, ObjectToStringTextualConverter, SingleToMultiTextualConverterAdapter

public interface TextualConverter<InputType,OutputType extends Textual>

Interface for a class that can convert some type of object into one or more textual objects. This is usually done to encapsulate a strategy for transforming an object so that it can be used in text analysis, such as being fed into tokenization for a term extraction pipeline.

Since:

3.1

Author:

Justin Basilico

See Also:

SingleTextualConverter, MultiTextualConverter

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<OutputType>	convertAll(java.lang.Iterable<? extends InputType> inputs) Convert the given input objects into zero or more textual objects.

Method Detail

convertAll

java.lang.Iterable<OutputType> convertAll(java.lang.Iterable<? extends InputType> inputs)

Convert the given input objects into zero or more textual objects. Typically the result is the concatenation of calls to the single convert methods.

Parameters:

inputs - The inputs to convert.

Returns:

Zero or more textual objects.