net.sf.okapi.steps.imagemodification

Class ImageModificationStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.imagemodification.ImageModificationStep

All Implemented Interfaces:

IPipelineStep

public class ImageModificationStep
extends BasePipelineStep

Constructor Summary

Constructors

Constructor and Description
ImageModificationStep()

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.
Event	handleRawDocument(Event event) Handles the EventType.RAW_DOCUMENT event.
protected Event	handleStartBatchItem(Event event) Handles the EventType.START_BATCH_ITEM event.
boolean	isDone() Steps that can generate Events such as IFilters return false until no more events can be created.
void	setOutputURI(URI outputURI)
void	setParameters(IParameters params) Sets new parameters for this step.

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

cancel, destroy, getHelpLocation, handleCustom, handleDocumentPart, handleEndBatch, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleStartBatch, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, handleTextUnit, isLastOutputStep, setLastOutputStep

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageModificationStep

public ImageModificationStep()

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.

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.

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.

setOutputURI

public void setOutputURI(URI outputURI)

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

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