BasePipelineStep

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.okapi.common.pipeline
Class BasePipelineStep

java.lang.Object
  net.sf.okapi.common.pipeline.BasePipelineStep

All Implemented Interfaces:: IPipelineStep

public abstract class BasePipelineStep
extends java.lang.Object
implements IPipelineStep
extends java.lang.Object
implements IPipelineStep

Abstract implementation of the IPipelineStep interface.

Constructor Summary
`BasePipelineStep()`

Method Summary
`void`	`cancel()` Cancel processing on this pipeline.
`void`	`destroy()` Executes any cleanup code for this step.
`java.lang.String`	`getHelpLocation()` Gets the relative directory location for the help of this step.
`IParameters`	`getParameters()` Gets the current parameters for this step.
`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.
`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`	`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`	`setParameters(IParameters params)` Sets new parameters for this step.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface net.sf.okapi.common.pipeline.IPipelineStep
`getDescription, getName`

Constructor Detail

BasePipelineStep

public BasePipelineStep()

Method Detail