net.sf.okapi.lib.extra.steps

Class AbstractPipelineStep

java.lang.Object

net.sf.okapi.lib.extra.Component

net.sf.okapi.lib.extra.OkapiComponent

net.sf.okapi.lib.extra.steps.AbstractPipelineStep

All Implemented Interfaces:

IPipelineStep, IComponent, IConfigurable, INotifiable

Direct Known Subclasses:

CompoundStep

public abstract class AbstractPipelineStep
extends OkapiComponent
implements IPipelineStep

Abstract implementation of the IPipelineStep interface.

Constructor Summary

Constructors

Constructor and Description
AbstractPipelineStep()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel()
void	destroy()
String	getHelpLocation()
protected LocaleId	getSourceLocale()
protected LocaleId	getTargetLocale()
protected Event	handleCustom(Event event) Handles the EventType.CUSTOM event.
protected Event	handleDocumentPart(Event event) Handles the EventType.DOCUMENT_PART event.
protected Event	handleEndBatch(Event event) Handles the EventType.END_BATCH event.
protected Event	handleEndBatchItem(Event event) Handles the EventType.END_BATCH_ITEM event.
protected Event	handleEndDocument(Event event) Handles the EventType.END_DOCUMENT event.
protected Event	handleEndGroup(Event event) Handles the EventType.END_GROUP event.
protected Event	handleEndSubDocument(Event event) Handles the EventType.END_SUBDOCUMENT event.
protected Event	handleEndSubfilter(Event event) Handles the EventType.END_SUBFILTER event.
Event	handleEvent(Event event)
protected Event	handleMultiEvent(Event event) Handles the EventType.MULTI_EVENT event.
protected Event	handlePipelineParameters(Event event) Handles the EventType.PIPELINE_PARAMETERS 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	handleStartGroup(Event event) Handles the EventType.START_GROUP event.
protected Event	handleStartSubDocument(Event event) Handles the EventType.START_SUBDOCUMENT event.
protected Event	handleStartSubfilter(Event event) Handles the EventType.START_SUBFILTER event.
protected Event	handleTextUnit(Event event) Handles the EventType.TEXT_UNIT event.
boolean	isDone()
boolean	isLastOutputStep()
void	setLastOutputStep(boolean isLastStep)
void	setSourceLocale(LocaleId sourceLocale)
void	setTargetLocale(LocaleId targetLocale)

Methods inherited from class net.sf.okapi.lib.extra.OkapiComponent

component_done, component_init, getParameters, getParameters, getParametersClassName, setParameters

Methods inherited from class net.sf.okapi.lib.extra.Component

exec, getDescription, getName, setDescription, setName, toString

Methods inherited from class java.lang.Object

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

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

getDescription, getName, getParameters, setParameters

Constructor Detail

AbstractPipelineStep

public AbstractPipelineStep()

Method Detail

getSourceLocale

protected LocaleId getSourceLocale()

getTargetLocale

protected LocaleId getTargetLocale()

cancel

public void cancel()

Specified by:

cancel in interface IPipelineStep

destroy

public void destroy()

Specified by:

destroy in interface IPipelineStep

getHelpLocation

public String getHelpLocation()

Specified by:

getHelpLocation in interface IPipelineStep

handleEvent

public Event handleEvent(Event event)

Specified by:

handleEvent in interface IPipelineStep

isDone

public boolean isDone()

Specified by:

isDone in interface IPipelineStep

isLastOutputStep

public boolean isLastOutputStep()

Specified by:

isLastOutputStep in interface IPipelineStep

setLastOutputStep

public void setLastOutputStep(boolean isLastStep)

Specified by:

setLastOutputStep in interface IPipelineStep

handleStartBatch

protected Event handleStartBatch(Event event)

Handles the EventType.START_BATCH event.

Parameters:

event - the event itself.

handleEndBatch

protected Event handleEndBatch(Event event)

Handles the EventType.END_BATCH event.

Parameters:

event - the event itself.

handleStartBatchItem

protected Event handleStartBatchItem(Event event)

Handles the EventType.START_BATCH_ITEM event.

Parameters:

event - the event itself.

handleEndBatchItem

protected Event handleEndBatchItem(Event event)

Handles the EventType.END_BATCH_ITEM event.

Parameters:

event - the event itself.

handleRawDocument

protected Event handleRawDocument(Event event)

Handles the EventType.RAW_DOCUMENT event.

Parameters:

event - the event itself.

handleMultiEvent

protected Event handleMultiEvent(Event event)

Handles the EventType.MULTI_EVENT event.

Parameters:

event - event to handle.

Returns:

the event returned.

handlePipelineParameters

protected Event handlePipelineParameters(Event event)

Handles the EventType.PIPELINE_PARAMETERS event. This method relies on the configuration parameters set in each step to set the corresponding values.

Parameters:

event - event to handle.

Returns:

the event returned.

handleStartDocument

protected Event handleStartDocument(Event event)

Handles the EventType.START_DOCUMENT event.

Parameters:

event - the event itself.

setSourceLocale

public void setSourceLocale(LocaleId sourceLocale)

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

handleEndDocument

protected Event handleEndDocument(Event event)

Handles the EventType.END_DOCUMENT event.

Parameters:

event - the event itself.

handleStartSubDocument

protected Event handleStartSubDocument(Event event)

Handles the EventType.START_SUBDOCUMENT event.

Parameters:

event - the event itself.

handleEndSubDocument

protected Event handleEndSubDocument(Event event)

Handles the EventType.END_SUBDOCUMENT event.

Parameters:

event - the event itself.

handleStartGroup

protected Event handleStartGroup(Event event)

Handles the EventType.START_GROUP event.

Parameters:

event - the event itself.

handleEndGroup

protected Event handleEndGroup(Event event)

Handles the EventType.END_GROUP event.

Parameters:

event - the event itself.

handleStartSubfilter

protected Event handleStartSubfilter(Event event)

Handles the EventType.START_SUBFILTER event.

Parameters:

event - the event itself.

handleEndSubfilter

protected Event handleEndSubfilter(Event event)

Handles the EventType.END_SUBFILTER event.

Parameters:

event - the event itself.

handleTextUnit

protected Event handleTextUnit(Event event)

Handles the EventType.TEXT_UNIT event.

Parameters:

event - the event itself.

handleDocumentPart

protected Event handleDocumentPart(Event event)

Handles the EventType.DOCUMENT_PART event.

Parameters:

event - the event itself.

handleCustom

protected Event handleCustom(Event event)

Handles the EventType.CUSTOM event.

Parameters:

event - the event itself.