net.sf.okapi.filters.plaintext.paragraphs

Class ParaPlainTextFilter

java.lang.Object

net.sf.okapi.common.filters.AbstractFilter

net.sf.okapi.common.filters.AbstractLineFilter

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

net.sf.okapi.filters.plaintext.paragraphs.ParaPlainTextFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

public class ParaPlainTextFilter
extends BasePlainTextFilter

The filter breaks text into paragraphs and sends them as text units. The filter is aware of the following line terminators:

• Carriage return character followed immediately by a newline character ("\r\n")
• Newline (line feed) character ("\n")
• Stand-alone carriage return character ("\r")

Version:

0.1, 09.06.2009

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_CONFIG
static String	FILTER_CONFIG_LINES
static String	FILTER_NAME

Fields inherited from class net.sf.okapi.filters.plaintext.base.BasePlainTextFilter

FILTER_CONFIG_TRIM_ALL, FILTER_CONFIG_TRIM_TRAIL, FILTER_MIME

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 and Description
ParaPlainTextFilter()

Method Summary

Modifier and Type	Method and Description
protected void	done()
protected void	init()
protected TextProcessingResult	processLine(TextContainer lineContainer) Called by the filter for every line read from the input
protected void	waitForLine(boolean lastChance) Called by the filter when there are no input lines (the input has been read).

Methods inherited from class net.sf.okapi.filters.plaintext.base.BasePlainTextFilter

callSubfilter, checkTU, isEmpty, processTU, sendAsSkeleton, sendAsSkeleton, sendAsSkeleton, sendAsSource, sendAsSource, sendAsSource, sendAsTarget

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

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

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_CONFIG

public static final String FILTER_CONFIG

See Also:

Constant Field Values

FILTER_CONFIG_LINES

public static final String FILTER_CONFIG_LINES

See Also:

Constant Field Values

Constructor Detail

ParaPlainTextFilter

public ParaPlainTextFilter()

Method Detail

init

protected void init()

Overrides:

init in class BasePlainTextFilter

processLine

protected TextProcessingResult processLine(TextContainer lineContainer)

Description copied from class: AbstractLineFilter

Called by the filter for every line read from the input

Overrides:

processLine in class BasePlainTextFilter

Returns:

waitForLine

protected void waitForLine(boolean lastChance)

Description copied from class: AbstractLineFilter

Called by the filter when there are no input lines (the input has been read). Used to control implementation-specific internal buffers.

Overrides:

waitForLine in class AbstractLineFilter

Parameters:

lastChance - True if there are no events in the queue, and if the method will not produce events, the filter will be finished.

done

protected void done()

Overrides:

done in class AbstractLineFilter