Package net.sf.okapi.steps.inconsistencycheck

Class InconsistencyCheckStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.inconsistencycheck.InconsistencyCheckStep

All Implemented Interfaces:

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

public class InconsistencyCheckStep
extends BasePipelineStep

Constructor Summary

Constructors

Constructor	Description
InconsistencyCheckStep()

Method Summary

Modifier and Type	Method	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.
Event	handleEndBatch(Event event)	Handles the EventType.END_BATCH event.
Event	handleEndDocument(Event event)	Handles the EventType.END_DOCUMENT event.
Event	handleStartBatch(Event event)	Handles the EventType.START_BATCH event.
Event	handleStartDocument(Event event)	Handles the EventType.START_DOCUMENT event.
Event	handleStartSubDocument(Event event)	Handles the EventType.START_SUBDOCUMENT event.
Event	handleTextUnit(Event event)	Handles the EventType.TEXT_UNIT event.
void	setInputRootDirectory(String inputRootDir)
void	setParameters(IParameters params)	Sets new parameters for this step.
void	setRootDirectory(String rootDir)
void	setTargetLocale(LocaleId targetLocale)

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

cancel, destroy, getHelpLocation, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatchItem, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleRawDocument, handleStartBatchItem, handleStartGroup, handleStartSubfilter, isDone, isLastOutputStep, setLastOutputStep, setSourceLocale

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, close, handleStream

Constructor Detail

InconsistencyCheckStep

public InconsistencyCheckStep()

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)

setInputRootDirectory

public void setInputRootDirectory(String inputRootDir)

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

Specified by:

setTargetLocale in interface IPipelineStep

Overrides:

setTargetLocale in class BasePipelineStep

handleStartBatch

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

handleStartDocument

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

handleStartSubDocument

public Event handleStartSubDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_SUBDOCUMENT event.

Overrides:

handleStartSubDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleTextUnit

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

handleEndDocument

public Event handleEndDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.END_DOCUMENT event.

Overrides:

handleEndDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleEndBatch

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