Package net.sf.okapi.filters.plaintext.base

Class BasePlainTextFilter

java.lang.Object

net.sf.okapi.common.filters.AbstractFilter

net.sf.okapi.common.filters.AbstractLineFilter

net.sf.okapi.filters.plaintext.base.BasePlainTextFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

Direct Known Subclasses:

BaseTableFilter, ParaPlainTextFilter, SplicedLinesFilter

public class BasePlainTextFilter
extends AbstractLineFilter

PlainTextFilter extracts lines of input text, separated by line terminators.

Version:

0.1, 09.06.2009

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILTER_CONFIG
static String	FILTER_CONFIG_TRIM_ALL
static String	FILTER_CONFIG_TRIM_TRAIL
static String	FILTER_MIME
static String	FILTER_NAME

Fields inherited from class net.sf.okapi.common.filters.AbstractLineFilter

input, LINE_NUMBER, srcLang, startDoc, trgLang

Fields inherited from interface net.sf.okapi.common.filters.IFilter

SUB_FILTER

Constructor Summary

Constructors

Constructor	Description
BasePlainTextFilter()

Method Summary

Modifier and Type	Method	Description
protected List<Event>	callSubfilter(ITextUnit parent)
protected boolean	checkTU(ITextUnit textUnit)
protected void	init()
protected boolean	isEmpty(ITextUnit textUnit)
protected TextProcessingResult	processLine(TextContainer lineContainer)	Called by the filter for every line read from the input
protected boolean	processTU(ITextUnit textUnit)
protected TextProcessingResult	sendAsSkeleton(String skelPart)
protected TextProcessingResult	sendAsSkeleton(ITextUnit textUnit)
protected TextProcessingResult	sendAsSkeleton(GenericSkeleton skelPart)
protected TextProcessingResult	sendAsSource(ITextUnit textUnit)
protected TextProcessingResult	sendAsSource(ITextUnit textUnit, boolean rejectEmpty)
protected TextProcessingResult	sendAsSource(TextContainer textContainer)
protected TextProcessingResult	sendAsTarget(ITextUnit target, ITextUnit source, LocaleId language)

Methods inherited from class net.sf.okapi.common.filters.AbstractLineFilter

addLineBreak, cancel, close, done, getActiveSkeleton, getFirstDocumentPart, getFirstTextUnit, getHeadSkeleton, getLineBreak, getQueueSize, getTargetLocale, hasNext, next, open, open, sendEvent, sendEvent, waitForLine

Methods inherited from class net.sf.okapi.common.filters.AbstractFilter

addConfiguration, addConfiguration, addConfiguration, addConfigurations, createEndFilterEvent, createFilterWriter, createSkeletonWriter, createStartFilterEvent, findConfiguration, getConfiguration, getConfigurations, getDisplayName, getDocumentId, getDocumentName, getEncoderManager, getEncoding, getFilterConfigurationMapper, getFilterWriter, getMimeType, getName, getNewlineType, getParameters, getParameters, getParametersClassName, getParentId, getSrcLoc, getTrgLoc, isCanceled, isGenerateSkeleton, isMultilingual, isUtf8Bom, isUtf8Encoding, removeConfiguration, setDisplayName, setDocumentName, setEncoding, setFilterConfigurationMapper, setFilterWriter, setGenerateSkeleton, setMimeType, setMultilingual, setName, setNewlineType, setOptions, setParameters, setParentId, setSrcLoc, setTrgLoc

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.okapi.common.filters.IFilter

stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

FILTER_NAME

public static final String FILTER_NAME

See Also:

Constant Field Values

FILTER_MIME

public static final String FILTER_MIME

See Also:

Constant Field Values

FILTER_CONFIG

public static final String FILTER_CONFIG

See Also:

Constant Field Values

FILTER_CONFIG_TRIM_TRAIL

public static final String FILTER_CONFIG_TRIM_TRAIL

See Also:

Constant Field Values

FILTER_CONFIG_TRIM_ALL

public static final String FILTER_CONFIG_TRIM_ALL

See Also:

Constant Field Values

Constructor Detail

BasePlainTextFilter

public BasePlainTextFilter()

Method Detail

init

protected void init()

Overrides:

init in class AbstractLineFilter

sendAsSource

protected final TextProcessingResult sendAsSource(ITextUnit textUnit)

sendAsSource

protected final TextProcessingResult sendAsSource(ITextUnit textUnit,
                                                  boolean rejectEmpty)

sendAsSource

protected final TextProcessingResult sendAsSource(TextContainer textContainer)

sendAsTarget

protected final TextProcessingResult sendAsTarget(ITextUnit target,
                                                  ITextUnit source,
                                                  LocaleId language)

sendAsSkeleton

protected final TextProcessingResult sendAsSkeleton(ITextUnit textUnit)

sendAsSkeleton

protected final TextProcessingResult sendAsSkeleton(GenericSkeleton skelPart)

sendAsSkeleton

protected final TextProcessingResult sendAsSkeleton(String skelPart)

processTU

protected boolean processTU(ITextUnit textUnit)

callSubfilter

protected List<Event> callSubfilter(ITextUnit parent)

checkTU

protected boolean checkTU(ITextUnit textUnit)

isEmpty

protected boolean isEmpty(ITextUnit textUnit)

processLine

protected TextProcessingResult processLine(TextContainer lineContainer)

Description copied from class: AbstractLineFilter

Called by the filter for every line read from the input

Specified by:

processLine in class AbstractLineFilter

Returns: