net.sf.okapi.lib.preprocessing.filters.common

Class PreprocessingFilter

java.lang.Object

net.sf.okapi.lib.preprocessing.filters.common.PreprocessingFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

Direct Known Subclasses:

SimplificationFilter

public class PreprocessingFilter
extends Object
implements IFilter

This filter is a wrapper around another filter, used when events generated by the internal filter should be modified (transformed, pre-processed) for the pipeline steps consuming the filter events. The constructor takes an instance of the internal filter and an array of the needed transformation steps.

Field Summary

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

SUB_FILTER

Constructor Summary

Constructors

Constructor and Description
PreprocessingFilter(IFilter filter, IPipelineStep... steps)

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	close()
IFilterWriter	createFilterWriter()
ISkeletonWriter	createSkeletonWriter()
List<FilterConfiguration>	getConfigurations()
String	getDisplayName()
EncoderManager	getEncoderManager()
protected IFilter	getFilter()
String	getMimeType()
String	getName()
IParameters	getParameters()
protected List<IPipelineStep>	getSteps()
boolean	hasNext()
Event	next()
void	open(RawDocument input)
void	open(RawDocument input, boolean generateSkeleton)
protected void	setFilter(IFilter filter)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
void	setParameters(IParameters params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

PreprocessingFilter

public PreprocessingFilter(IFilter filter,
                           IPipelineStep... steps)

Method Detail

getName

public String getName()

Specified by:

getName in interface IFilter

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface IFilter

open

public void open(RawDocument input)

Specified by:

open in interface IFilter

open

public void open(RawDocument input,
                 boolean generateSkeleton)

Specified by:

open in interface IFilter

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IFilter

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Event>

Specified by:

hasNext in interface IFilter

next

public Event next()

Specified by:

next in interface Iterator<Event>

Specified by:

next in interface IFilter

cancel

public void cancel()

Specified by:

cancel in interface IFilter

getParameters

public IParameters getParameters()

Specified by:

getParameters in interface IFilter

setParameters

public void setParameters(IParameters params)

Specified by:

setParameters in interface IFilter

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

Specified by:

setFilterConfigurationMapper in interface IFilter

createSkeletonWriter

public ISkeletonWriter createSkeletonWriter()

Specified by:

createSkeletonWriter in interface IFilter

createFilterWriter

public IFilterWriter createFilterWriter()

Specified by:

createFilterWriter in interface IFilter

getEncoderManager

public EncoderManager getEncoderManager()

Specified by:

getEncoderManager in interface IFilter

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface IFilter

getConfigurations

public List<FilterConfiguration> getConfigurations()

Specified by:

getConfigurations in interface IFilter

getFilter

protected IFilter getFilter()

setFilter

protected void setFilter(IFilter filter)

getSteps

protected List<IPipelineStep> getSteps()