textractor.sentence
Interface SentenceTransformer

All Superinterfaces:

SentenceProcessor, TextractorProcessor

All Known Implementing Classes:

AbnerSentenceTransformer, AbstractSentenceTransformer, Filter, RandomArticleSampler, SentenceCapitalizer, SentenceCountFilter, TitleExtractor

public interface SentenceTransformer
extends SentenceProcessor

An SentenceProcessor that modifies an ArticleSentencesPair based on some criteria.

Method Summary

ArticleSentencesPair

transform(ArticleSentencesPair pair) Transform a ArticleSentencesPair into a new ArticleSentencesPair.

Methods inherited from interface textractor.sentence.SentenceProcessor

addSentenceProcessedListener, addSentenceProcessingCompleteListener, getNumberOfArticlesProcessed, getNumberOfSentencesProcessed, removeSentenceProcessedListener, removeSentenceProcessingCompleteListener

Method Detail

transform

ArticleSentencesPair transform(ArticleSentencesPair pair)
                               throws SentenceProcessingException

Transform a ArticleSentencesPair into a new ArticleSentencesPair.

Parameters:

pair - The ArticleSentencesPair to be transformed.

Returns:

A (possibly null) ArticleSentencesPair based on the original

Throws:

SentenceProcessingException - If there was an error condition in the textractor sentence processing pipeline