net.sf.okapi.steps.common

Class RawDocumentWriterStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.common.RawDocumentWriterStep

All Implemented Interfaces:

IPipelineStep

public class RawDocumentWriterStep
extends BasePipelineStep

Writes a RawDocument to an output file.

WARNING: This step eats the RawDocument Event after writing its contents. This step should normally be used as the last step in a pipeline when an output file is needed.

This class implements the IPipelineStep interface for a step that takes a RawDocument and creates an output file from it. The generated file is passed on through a new RawDocument.

Constructor Summary

Constructors

Constructor and Description
RawDocumentWriterStep() Creates a new RawDocumentWriterStep object.

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.
Event	handleRawDocument(Event event) Handles the EventType.RAW_DOCUMENT event.
void	setOutputURI(URI outputURI)

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

cancel, destroy, getHelpLocation, getParameters, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatch, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleStartBatch, handleStartBatchItem, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, handleTextUnit, isDone, isLastOutputStep, setLastOutputStep, setParameters, setSourceLocale, setTargetLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

RawDocumentWriterStep

public RawDocumentWriterStep()

Creates a new RawDocumentWriterStep object. This constructor is needed to be able to instantiate an object from newInstance()

Method Detail

setOutputURI

public void setOutputURI(URI outputURI)

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.

getName

public String getName()

Description copied from interface: IPipelineStep

Gets the localizable name of this step.

Returns:

the localizable name of this step.

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.