Package net.sf.okapi.steps.common

Class RawDocumentToFilterEventsStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.common.RawDocumentToFilterEventsStep

All Implemented Interfaces:

IPipelineStep

public class RawDocumentToFilterEventsStep
extends BasePipelineStep

Converts a RawDocument into filter events.

This class implements the IPipelineStep interface for a step that takes a RawDocument and to generate its corresponding events either: a provided IFilter implementation, or the filter configuration mapper accessible through the pipeline's context.

This step can also work with the filters that generates multiple documents.

See Also:

FilterEventsToRawDocumentStep, FilterEventsWriterStep

Constructor Summary

Constructors

Constructor	Description
RawDocumentToFilterEventsStep()	Creates a new RawDocumentToFilterEventsStep object.
RawDocumentToFilterEventsStep(IFilter filter)	Creates a new RawDocumentToFilterEventsStep object with a given filter.

Method Summary

Modifier and Type	Method	Description
void	cancel()
void	destroy()
String	getDescription()
String	getName()
Event	handleEvent(Event event)
boolean	isDone()
void	setFilter(IFilter filter)
void	setFilterConfigurationId(String filterConfigId)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RawDocumentToFilterEventsStep

public RawDocumentToFilterEventsStep()

Creates a new RawDocumentToFilterEventsStep object. This constructor is needed to be able to instantiate an object from newInstance()

RawDocumentToFilterEventsStep

public RawDocumentToFilterEventsStep(IFilter filter)

Creates a new RawDocumentToFilterEventsStep object with a given filter. Use this constructor to create an object that is using a filter set using the one provided here, or using setFilter(IFilter), not using the filter configuration mapper of the pipeline context.

Parameters:

filter - the filter to set.

Method Detail

setFilter

public void setFilter(IFilter filter)

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

setFilterConfigurationId

public void setFilterConfigurationId(String filterConfigId)

getName

public String getName()

getDescription

public String getDescription()

handleEvent

public Event handleEvent(Event event)

Specified by:

handleEvent in interface IPipelineStep

Overrides:

handleEvent in class BasePipelineStep

isDone

public boolean isDone()

Specified by:

isDone in interface IPipelineStep

Overrides:

isDone in class BasePipelineStep

destroy

public void destroy()

Specified by:

destroy in interface IPipelineStep

Overrides:

destroy in class BasePipelineStep

cancel

public void cancel()

Specified by:

cancel in interface IPipelineStep

Overrides:

cancel in class BasePipelineStep