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, Iterator<Event>, IFilter, IComponent, IConfigurable, INotifiable

Direct Known Subclasses:

BasePlainTextFilter

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

Modifier and Type	Method and Description
protected void	addLineBreak()
void	cancel() Cancels the current process.
void	close() Closes the input document.
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() Creates a new IFilterWriter object from the most appropriate class to use with this filter.
ISkeletonWriter	createSkeletonWriter() Creates a new ISkeletonWriter object that corresponds to the type of skeleton this filter uses.
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() Indicates if there is an event to process.
boolean	isMultilingual()
Event	next() Gets the next event available.
boolean	notify(String notification, Object info)
void	open(RawDocument input) Opens the input document described in a give RawDocument object.
void	open(RawDocument input, boolean generateSkeleton) Opens the input document described in a give RawDocument object, and optionally creates skeleton information.
protected boolean	sendEvent(EventType eventType, IResource res)
protected boolean	sendEvent(int index, EventType eventType, IResource res)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper) Sets the filter configuration mapper for this filter.
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, stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

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()

Description copied from interface: IFilter

Cancels the current process.

close

public final void close()

Description copied from interface: IFilter

Closes the input document. Developers should call this method from within their code before sending the last event: This can allow writer objects to overwrite the input file when they receive the last event. This method must also be safe to call even if the input document is not opened.

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 AbstractBaseFilter

Parameters:

fcMapper - the mapper to set.

createFilterWriter

public IFilterWriter createFilterWriter()

Description copied from interface: IFilter

Creates a new IFilterWriter object from the most appropriate class to use with this filter.

Returns:

A new instance of IFilterWriter for the preferred implementation for this filter.

createSkeletonWriter

public ISkeletonWriter createSkeletonWriter()

Description copied from interface: IFilter

Creates a new ISkeletonWriter object that corresponds to the type of skeleton this filter uses.

Returns:

A new instance of ISkeletonWriter for the type of skeleton this filter uses.

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()

Description copied from interface: IFilter

Indicates if there is an event to process.

Implementer Note: The caller must be able to call this method several times without changing state.

Returns:

True if there is at least one event to process, false if not.

open

public void open(RawDocument input)

Description copied from interface: IFilter

Opens the input document described in a give RawDocument object. Skeleton information is always created when you use this method.

Parameters:

input - The RawDocument object to use to open the document.

open

public void open(RawDocument input,
                 boolean generateSkeleton)

Description copied from interface: IFilter

Opens the input document described in a give RawDocument object, and optionally creates skeleton information.

Parameters:

input - The RawDocument object to use to open the document.

generateSkeleton - true to generate the skeleton data, false otherwise.

getFirstTextUnit

protected ITextUnit getFirstTextUnit()

getFirstDocumentPart

protected DocumentPart getFirstDocumentPart()

getTargetLocale

protected LocaleId getTargetLocale()

next

public Event next()

Description copied from interface: IFilter

Gets the next event available. Calling this method can be done only once on each event.

Returns:

The next event available or null if there are no events.

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()