net.sf.okapi.filters.plaintext.base

Class BasePlainTextFilter

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

All Implemented Interfaces:

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

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 and 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.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
BasePlainTextFilter()

Method Summary

Modifier and Type	Method and Description
protected List<Event>	callSubfilter(ITextUnit parent)
protected boolean	checkTU(ITextUnit textUnit)
protected void	component_done()
protected TextProcessingResult	component_exec(TextContainer lineContainer) Called by the filter for every line read from the input
protected void	component_init()
protected IFilterConfigurationMapper	getFilterConfigurationMapper()
protected boolean	isEmpty(ITextUnit textUnit)
protected boolean	processTU(ITextUnit textUnit)
protected TextProcessingResult	sendAsSkeleton(GenericSkeleton skelPart)
protected TextProcessingResult	sendAsSkeleton(ITextUnit textUnit)
protected TextProcessingResult	sendAsSkeleton(String 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)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper) Sets the filter configuration mapper for this filter.

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

addLineBreak, cancel, close, component_idle, 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_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

component_init

protected void component_init()

Overrides:

component_init in class AbstractLineFilter

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

Description copied from interface: IFilter

Sets the filter configuration mapper for this filter. This object is used by this filter if it needs to instantiate sub-filters. The implementations of IFilter that do not use sub-filters can use an empty stub for this method.

Specified by:

setFilterConfigurationMapper in interface IFilter

Overrides:

setFilterConfigurationMapper in class AbstractLineFilter

Parameters:

fcMapper - the mapper to set.

getFilterConfigurationMapper

protected IFilterConfigurationMapper getFilterConfigurationMapper()

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)

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 AbstractLineFilter

Returns:

component_done

protected void component_done()

Overrides:

component_done in class OkapiComponent