net.sf.okapi.steps.qualitycheck

Class QualityCheckStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.qualitycheck.QualityCheckStep

All Implemented Interfaces:

IPipelineStep

public class QualityCheckStep
extends BasePipelineStep

Constructor Summary

Constructors

Constructor and Description
QualityCheckStep()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets a short localizable description of what this step does.
String	getName() Gets the localizable name of this step.
Parameters	getParameters() Gets the current parameters for this step.
protected Event	handleEndBatch(Event event) Handles the EventType.END_BATCH event.
protected Event	handleRawDocument(Event event) Handles the EventType.RAW_DOCUMENT event.
protected Event	handleStartBatch(Event event) Handles the EventType.START_BATCH event.
protected Event	handleStartBatchItem(Event event) Handles the EventType.START_BATCH_ITEM event.
protected Event	handleStartDocument(Event event) Handles the EventType.START_DOCUMENT event.
protected Event	handleTextUnit(Event event) Handles the EventType.TEXT_UNIT event.
boolean	isDone() Steps that can generate Events such as IFilters return false until no more events can be created.
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
void	setParameters(IParameters params) Sets new parameters for this step.
void	setRootDirectory(String rootDir)
void	setSourceLocale(LocaleId sourceLocale) Delegate to concrete class
void	setTargetLocale(LocaleId targetLocale)
void	setUIParent(Object uiParent)

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

cancel, destroy, getHelpLocation, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleStartGroup, handleStartSubDocument, handleStartSubfilter, isLastOutputStep, setLastOutputStep

Methods inherited from class java.lang.Object

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

Constructor Detail

QualityCheckStep

public QualityCheckStep()

Method Detail

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.

getParameters

public Parameters 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.

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.

setRootDirectory

public void setRootDirectory(String rootDir)

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

Specified by:

setTargetLocale in interface IPipelineStep

Overrides:

setTargetLocale in class BasePipelineStep

setSourceLocale

public void setSourceLocale(LocaleId sourceLocale)

Description copied from interface: IPipelineStep

Delegate to concrete class

Specified by:

setSourceLocale in interface IPipelineStep

Overrides:

setSourceLocale in class BasePipelineStep

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

setUIParent

public void setUIParent(Object uiParent)

isDone

public boolean isDone()

Description copied from interface: IPipelineStep

Steps that can generate Events such as IFilters return false until no more events can be created. Steps which do not create Events always return true.

Specified by:

isDone in interface IPipelineStep

Overrides:

isDone in class BasePipelineStep

Returns:

false if can generate more events, true otherwise.

handleStartBatch

protected Event handleStartBatch(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_BATCH event.

Overrides:

handleStartBatch in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleStartBatchItem

protected Event handleStartBatchItem(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_BATCH_ITEM event.

Overrides:

handleStartBatchItem in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

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.

handleStartDocument

protected Event handleStartDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_DOCUMENT event.

Overrides:

handleStartDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleTextUnit

protected Event handleTextUnit(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.TEXT_UNIT event.

Overrides:

handleTextUnit in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleEndBatch

protected Event handleEndBatch(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.END_BATCH event.

Overrides:

handleEndBatch in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.