net.sf.okapi.steps.common

Class ExtractionVerificationStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.common.ExtractionVerificationStep

All Implemented Interfaces:

IPipelineStep

public class ExtractionVerificationStep
extends BasePipelineStep

Verifies if a RawDocument is extracted and merged back properly. This step performs a first extraction, merges the result without changing the data, then re-exact the file generated by the merge, and compare the event generated in both extraction. There should be no difference.

This verification does not verify that the merge file is valid, but it should catch most of the problems caused by invalid merges.

Constructor Summary

Constructors

Constructor and Description
ExtractionVerificationStep() Creates a new ExtractionVerificationStep object.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel processing on this pipeline.
void	destroy() Executes any cleanup code for this step.
String	getDescription() Gets a short localizable description of what this step does.
String	getName() Gets the localizable name of this step.
ExtractionVerificationStepParameters	getParameters() Gets the current parameters for this step.
protected Event	handleRawDocument(Event event) Handles the EventType.RAW_DOCUMENT event.
void	setFilterConfigurationId(String filterConfigId)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
void	setParameters(IParameters params) Sets new parameters for this step.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtractionVerificationStep

public ExtractionVerificationStep()

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

Method Detail

setParameters

public void setParameters(IParameters params)

Description copied from interface: IPipelineStep

Sets new parameters for this step.

Specified by:

setParameters in interface IPipelineStep

Overrides:

setParameters in class BasePipelineStep

Parameters:

params - the new parameters to use.

getParameters

public ExtractionVerificationStepParameters getParameters()

Description copied from interface: IPipelineStep

Gets the current parameters for this step.

Specified by:

getParameters in interface IPipelineStep

Overrides:

getParameters in class BasePipelineStep

Returns:

the current parameters for this step or null if there are no parameters.

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

setFilterConfigurationId

public void setFilterConfigurationId(String filterConfigId)

getName

public String getName()

Description copied from interface: IPipelineStep

Gets the localizable name of this step.

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.

Returns:

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

handleRawDocument

protected Event handleRawDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.RAW_DOCUMENT event.

Overrides:

handleRawDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

destroy

public void destroy()

Description copied from interface: IPipelineStep

Executes any cleanup code for this step. Called once at the end of the pipeline lifecycle.

Specified by:

destroy in interface IPipelineStep

Overrides:

destroy in class BasePipelineStep

cancel

public void cancel()

Description copied from interface: IPipelineStep

Cancel processing on this pipeline. Each IPipelineStep is responsible to implement a cancel method that will interrupt long running operations

Specified by:

cancel in interface IPipelineStep

Overrides:

cancel in class BasePipelineStep