Package net.sf.okapi.common.filters

Class SubFilterWrapperStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.common.filters.SubFilterWrapperStep

All Implemented Interfaces:

AutoCloseable, Function<Stream<Event>,Stream<Event>>, IPipelineStep

public class SubFilterWrapperStep
extends BasePipelineStep
implements IPipelineStep

Constructor Summary

Constructors

Constructor	Description
SubFilterWrapperStep(IFilter filter, IFilter primaryFilter)

Method Summary

Modifier and Type	Method	Description
void	close()
String	getDescription()	Gets a short localizable description of what this step does.
String	getName()	Gets the localizable name of this step.
ISubFilter	getSubFilter()
Stream<Event>	handleStream(Event event)	Processes a stream of events sent though the pipeline.

Methods inherited from class net.sf.okapi.common.pipeline.BasePipelineStep

cancel, destroy, getHelpLocation, getParameters, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatch, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleRawDocument, handleStartBatch, handleStartBatchItem, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, handleTextUnit, isDone, isLastOutputStep, setLastOutputStep, setParameters, setSourceLocale, setTargetLocale

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface net.sf.okapi.common.pipeline.IPipelineStep

apply, cancel, destroy, getHelpLocation, getParameters, getSourceLocale, getTargetLocale, handleEvent, isDone, isLastOutputStep, setLastOutputStep, setParameters, setSourceLocale, setTargetLocale

Constructor Detail

SubFilterWrapperStep

public SubFilterWrapperStep(IFilter filter,
                            IFilter primaryFilter)

Method Detail

getName

public String getName()

Description copied from interface: IPipelineStep

Gets the localizable name of this step.

Specified by:

getName in interface IPipelineStep

Returns:

the localizable name of this step.

getDescription

public String getDescription()

Description copied from interface: IPipelineStep

Gets a short localizable description of what this step does.

Specified by:

getDescription in interface IPipelineStep

Returns:

the text of a short description of what this step does.

handleStream

public Stream<Event> handleStream(Event event)

Description copied from interface: IPipelineStep

Processes a stream of events sent though the pipeline.

Specified by:

handleStream in interface IPipelineStep

Parameters:

event - the event to process.

Returns:

the stream to pass down the pipeline.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IPipelineStep

getSubFilter

public ISubFilter getSubFilter()