AbstractPipelineStep (Okapi Framework SDK 1.41.0 API)

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:

BaseCountStep, CharacterCountStep, CompoundStep, TokenizationStep
```
public abstract class AbstractPipelineStep
extends OkapiComponent
implements IPipelineStep
```
Abstract implementation of the IPipelineStep interface.

Constructor Summary

Constructors
Constructor and Description

AbstractPipelineStep()

Constructors
Constructor and Description
`AbstractPipelineStep()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` Cancel processing on this pipeline.
`void`	`destroy()` Executes any cleanup code for this step.
`String`	`getHelpLocation()` Gets the relative directory location for the help of this step.
`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)` Processes each event sent though the pipeline.
`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()` Steps that can generate `Event`s such as `IFilter`s return false until no more events can be created.
`boolean`	`isLastOutputStep()` Is this step the last step with output in the pipeline?
`void`	`setLastOutputStep(boolean isLastStep)` Tell the step if it is the last one on the pipeline with output.
`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()
```
    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
  - 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
  - getHelpLocation
```
public String getHelpLocation()
```
    Description copied from interface: IPipelineStep
    
    Gets the relative directory location for the help of this step. The main help file for the step must be at that location and its name must be the name of the class implementing the step in lowercase with a .html extension.
    
    Specified by:
    
    getHelpLocation in interface IPipelineStep
    
    Returns:
    
    the relative directory location for the help of this step.
  - handleEvent
```
public Event handleEvent(Event event)
```
    Description copied from interface: IPipelineStep
    
    Processes each event sent though the pipeline.
    
    Specified by:
    
    handleEvent in interface IPipelineStep
    
    Parameters:
    
    event - the event to process.
    
    Returns:
    
    the event to pass down the pipeline.
  - 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
    
    Returns:
    
    false if can generate more events, true otherwise.
  - isLastOutputStep
```
public boolean isLastOutputStep()
```
    Description copied from interface: IPipelineStep
    
    Is this step the last step with output in the pipeline?
    
    Specified by:
    
    isLastOutputStep in interface IPipelineStep
    
    Returns:
    
    true if last step with output, false otherwise.
  - setLastOutputStep
```
public void setLastOutputStep(boolean isLastStep)
```
    Description copied from interface: IPipelineStep
    
    Tell the step if it is the last one on the pipeline with output.
    
    Specified by:
    
    setLastOutputStep in interface IPipelineStep
    
    Parameters:
    
    isLastStep - true if last step with output, false otherwise.
  - 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.

Class AbstractPipelineStep

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPipelineStep

Method Detail

getSourceLocale

getTargetLocale

cancel

destroy

getHelpLocation

handleEvent

isDone

isLastOutputStep

setLastOutputStep

handleStartBatch

handleEndBatch

handleStartBatchItem

handleEndBatchItem

handleRawDocument

handleMultiEvent

handlePipelineParameters

handleStartDocument

setSourceLocale

setTargetLocale

handleEndDocument

handleStartSubDocument

handleEndSubDocument

handleStartGroup

handleEndGroup

handleStartSubfilter

handleEndSubfilter

handleTextUnit

handleDocumentPart

handleCustom