FilterEventsToRawDocumentStep (Okapi Common Steps 1.45.0 API)

java.lang.Object
- net.sf.okapi.common.pipeline.BasePipelineStep
- - net.sf.okapi.steps.common.FilterEventsToRawDocumentStep

All Implemented Interfaces:

IPipelineStep
```
public class FilterEventsToRawDocumentStep
extends BasePipelineStep
```
Converts filters events into a RawDocument. This class implements the IPipelineStep interface for a step that takes filter events and creates an output document using the IFilterWriter implementation provided by the filter through the START_DOCUMENT event. When the document is completed, a RawDocument is generated.

See Also:

RawDocumentToFilterEventsStep, FilterEventsWriterStep

Constructor Summary

Constructors
Constructor Description

FilterEventsToRawDocumentStep()
Create a new FilterEventsToRawDocumentStep object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDescription()`
`String`	`getName()`
`Event`	`handleEvent(Event event)`	Catch all incoming `Event`s and write them out to the output document.
`protected Event`	`handleStartDocument(Event event)`
`void`	`setOutputEncoding(String outputEncoding)`
`void`	`setOutputStream(OutputStream outputStream)`
`void`	`setOutputURI(URI outputURI)`
`void`	`setTargetLocale(LocaleId targetLocale)`

Methods inherited from class net.sf.okapi.common.pipeline.BasePipelineStep
cancel, destroy, getHelpLocation, getParameters, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatch, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleMultiEvent, handlePipelineParameters, handleRawDocument, handleStartBatch, handleStartBatchItem, handleStartGroup, handleStartSubDocument, handleStartSubfilter, handleTextUnit, isDone, isLastOutputStep, setLastOutputStep, setParameters, setSourceLocale

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

- Constructor Detail
  - FilterEventsToRawDocumentStep
```
public FilterEventsToRawDocumentStep()
```
    Create a new FilterEventsToRawDocumentStep object.
- Method Detail
  - setOutputURI
```
public void setOutputURI(URI outputURI)
```
  - setOutputStream
```
public void setOutputStream(OutputStream outputStream)
```
  - setTargetLocale
```
public void setTargetLocale(LocaleId targetLocale)
```
    Specified by:
    
    setTargetLocale in interface IPipelineStep
    
    Overrides:
    
    setTargetLocale in class BasePipelineStep
  - setOutputEncoding
```
public void setOutputEncoding(String outputEncoding)
```
  - getName
```
public String getName()
```
  - getDescription
```
public String getDescription()
```
  - handleEvent
```
public Event handleEvent(Event event)
```
    Catch all incoming Events and write them out to the output document. This step generates NO_OP events until the input events are exhausted, at which point a RawDocument event is sent.
    
    Specified by:
    
    handleEvent in interface IPipelineStep
    
    Overrides:
    
    handleEvent in class BasePipelineStep
  - handleStartDocument
```
protected Event handleStartDocument(Event event)
```
    Overrides:
    
    handleStartDocument in class BasePipelineStep