net.sf.okapi.lib.extra.filters

Class AbstractLineFilter

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

All Implemented Interfaces:

AutoCloseable, IFilter, IComponent, IConfigurable, INotifiable

public abstract class AbstractLineFilter
extends AbstractBaseFilter

Base class for the filters which input is processed line-upon-line. Provides low-level skeleton, events, and configuration handling mechanisms.

Version:

0.1, 09.06.2009

Field Summary

Fields

Modifier and Type	Field and Description
protected RawDocument	input
static String	LINE_NUMBER
protected LocaleId	srcLang
protected StartDocument	startDoc
protected LocaleId	trgLang

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

SUB_FILTER

Constructor Summary

Constructors

Constructor and Description
AbstractLineFilter()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addLineBreak()
void	cancel()
void	close()
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()
IFilterWriter	createFilterWriter()
ISkeletonWriter	createSkeletonWriter()
protected GenericSkeleton	getActiveSkeleton()
IFilterWriter	getFilterWriter()
protected DocumentPart	getFirstDocumentPart()
protected ITextUnit	getFirstTextUnit()
protected GenericSkeleton	getHeadSkeleton()
protected String	getLineBreak()
protected int	getQueueSize()
protected LocaleId	getTargetLocale()
boolean	hasNext()
boolean	isMultilingual()
Event	next()
boolean	notify(String notification, Object info)
void	open(RawDocument input)
void	open(RawDocument input, boolean generateSkeleton)
protected boolean	sendEvent(EventType eventType, IResource res)
protected boolean	sendEvent(int index, EventType eventType, IResource res)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
void	setFilterWriter(IFilterWriter filterWriter)
protected void	setMultilingual(boolean multilingual)

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

component_done, 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

Field Detail

LINE_NUMBER

public static final String LINE_NUMBER

See Also:

Constant Field Values

srcLang

protected LocaleId srcLang

trgLang

protected LocaleId trgLang

startDoc

protected StartDocument startDoc

input

protected RawDocument input

Constructor Detail

AbstractLineFilter

public AbstractLineFilter()

Method Detail

cancel

public void cancel()

close

public final void close()

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

Specified by:

setFilterConfigurationMapper in interface IFilter

Overrides:

setFilterConfigurationMapper in class AbstractBaseFilter

createFilterWriter

public IFilterWriter createFilterWriter()

createSkeletonWriter

public ISkeletonWriter createSkeletonWriter()

getFilterWriter

public IFilterWriter getFilterWriter()

setFilterWriter

public void setFilterWriter(IFilterWriter filterWriter)

setMultilingual

protected void setMultilingual(boolean multilingual)

isMultilingual

public boolean isMultilingual()

component_init

protected void component_init()

Specified by:

component_init in class OkapiComponent

component_exec

protected TextProcessingResult component_exec(TextContainer lineContainer)

Called by the filter for every line read from the input

Parameters:

lineContainer -

Returns:

component_idle

protected void component_idle(boolean lastChance)

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

Parameters:

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

notify

public boolean notify(String notification,
             Object info)

hasNext

public boolean hasNext()

open

public void open(RawDocument input)

open

public void open(RawDocument input,
        boolean generateSkeleton)

getFirstTextUnit

protected ITextUnit getFirstTextUnit()

getFirstDocumentPart

protected DocumentPart getFirstDocumentPart()

getTargetLocale

protected LocaleId getTargetLocale()

next

public Event next()

sendEvent

protected final boolean sendEvent(EventType eventType,
                IResource res)

getActiveSkeleton

protected final GenericSkeleton getActiveSkeleton()

getHeadSkeleton

protected final GenericSkeleton getHeadSkeleton()

getQueueSize

protected final int getQueueSize()

sendEvent

protected final boolean sendEvent(int index,
                EventType eventType,
                IResource res)

Parameters:

index -

eventType -

res -

getLineBreak

protected final String getLineBreak()

addLineBreak

protected final void addLineBreak()