net.sf.okapi.filters.plaintext.paragraphs

Class ParaPlainTextFilter

java.lang.Object

net.sf.okapi.lib.extra.Component

net.sf.okapi.lib.extra.OkapiComponent

net.sf.okapi.lib.extra.filters.AbstractBaseFilter

net.sf.okapi.lib.extra.filters.AbstractLineFilter

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

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

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter, IComponent, IConfigurable, INotifiable

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.lib.extra.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	component_done()
protected TextProcessingResult	component_exec(TextContainer lineContainer) Called by the filter for every line read from the input
protected void	component_idle(boolean lastChance) Called by the filter when there are no input lines (the input has been read).
protected void	component_init()

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

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

Methods inherited from class net.sf.okapi.lib.extra.filters.AbstractLineFilter

addLineBreak, cancel, close, createFilterWriter, createSkeletonWriter, getActiveSkeleton, getFilterWriter, getFirstDocumentPart, getFirstTextUnit, getHeadSkeleton, getLineBreak, getQueueSize, getTargetLocale, hasNext, isMultilingual, next, notify, open, open, sendEvent, sendEvent, setFilterWriter, setMultilingual

Methods inherited from class net.sf.okapi.lib.extra.filters.AbstractBaseFilter

addConfiguration, addConfiguration, addConfigurations, findConfiguration, getConfigurations, getDisplayName, getEncoderManager, getMimeType, removeConfiguration, setConfiguration, setDisplayName, setMimeType

Methods inherited from class net.sf.okapi.lib.extra.OkapiComponent

getParameters, getParameters, getParametersClassName, setParameters

Methods inherited from class net.sf.okapi.lib.extra.Component

exec, getDescription, getName, setDescription, setName, toString

Methods inherited from class java.lang.Object

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

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

getName, getParameters, setParameters, 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

component_init

protected void component_init()

Overrides:

component_init in class BasePlainTextFilter

component_exec

protected TextProcessingResult component_exec(TextContainer lineContainer)

Description copied from class: AbstractLineFilter

Called by the filter for every line read from the input

Overrides:

component_exec in class BasePlainTextFilter

Returns:

component_idle

protected void component_idle(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:

component_idle 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.

component_done

protected void component_done()

Overrides:

component_done in class BasePlainTextFilter