ExtractionStep (Okapi Steps for Creating and Reading Rainbow T-Kits 1.42.0 API)

java.lang.Object
- net.sf.okapi.common.pipeline.BasePipelineStep
- - net.sf.okapi.steps.rainbowkit.creation.ExtractionStep

All Implemented Interfaces:: IPipelineStep

public class ExtractionStep
extends BasePipelineStep

Constructor Summary

Constructors
Constructor and Description

ExtractionStep()

Constructors
Constructor and Description
`ExtractionStep()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescription()`
`String`	`getFilterConfigurationId()`
`String`	`getInputRootDirectory()`
`URI`	`getInputURI()`
`String`	`getName()`
`String`	`getOutputEncoding()`
`URI`	`getOutputURI()`
`protected IPackageWriter`	`getPackageWriter()`
`Parameters`	`getParameters()`
`String`	`getRootDir()`
`LocaleId`	`getSourceLocale()`
`LocaleId`	`getTargetLocale()`
`protected Event`	`handleEndBatch(Event event)`
`Event`	`handleEvent(Event event)`
`protected Event`	`handleRawDocument(Event event)`
`protected Event`	`handleStartBatch(Event event)`
`protected Event`	`handleStartDocument(Event event)`
`void`	`setContext(ExecutionContext context)`
`void`	`setFilterConfigurationId(String filterConfigId)`
`void`	`setInputRootDirectory(String inputRootDir)`
`void`	`setInputURI(URI inputURI)`
`void`	`setOutputEncoding(String outputEncoding)`
`void`	`setOutputRootDirectory(String outputRootDir)`
`void`	`setOutputURI(URI outputURI)`
`void`	`setParameters(IParameters params)`
`void`	`setRootDirectory(String rootDir)`
`void`	`setSourceLocale(LocaleId sourceLocale)`
`void`	`setTargetLocale(LocaleId targetLocale)`

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

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

- Constructor Detail
  - ExtractionStep
```
public ExtractionStep()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
  - getName
```
public String getName()
```
  - setSourceLocale
```
public void setSourceLocale(LocaleId sourceLocale)
```
    Specified by:
    
    setSourceLocale in interface IPipelineStep
    
    Overrides:
    
    setSourceLocale in class BasePipelineStep
  - getSourceLocale
```
public LocaleId getSourceLocale()
```
    Specified by:
    
    getSourceLocale in interface IPipelineStep
    
    Overrides:
    
    getSourceLocale in class BasePipelineStep
  - setTargetLocale
```
public void setTargetLocale(LocaleId targetLocale)
```
    Specified by:
    
    setTargetLocale in interface IPipelineStep
    
    Overrides:
    
    setTargetLocale in class BasePipelineStep
  - getTargetLocale
```
public LocaleId getTargetLocale()
```
    Specified by:
    
    getTargetLocale in interface IPipelineStep
    
    Overrides:
    
    getTargetLocale in class BasePipelineStep
  - setInputURI
```
public void setInputURI(URI inputURI)
```
  - getInputURI
```
public URI getInputURI()
```
  - setOutputURI
```
public void setOutputURI(URI outputURI)
```
  - getOutputURI
```
public URI getOutputURI()
```
  - setOutputEncoding
```
public void setOutputEncoding(String outputEncoding)
```
  - getOutputEncoding
```
public String getOutputEncoding()
```
  - setFilterConfigurationId
```
public void setFilterConfigurationId(String filterConfigId)
```
  - getFilterConfigurationId
```
public String getFilterConfigurationId()
```
  - setRootDirectory
```
public void setRootDirectory(String rootDir)
```
  - getRootDir
```
public String getRootDir()
```
  - setInputRootDirectory
```
public void setInputRootDirectory(String inputRootDir)
```
  - setOutputRootDirectory
```
public void setOutputRootDirectory(String outputRootDir)
```
  - getInputRootDirectory
```
public String getInputRootDirectory()
```
  - setContext
```
public void setContext(ExecutionContext context)
```
  - handleEvent
```
public Event handleEvent(Event event)
```
    Specified by:
    
    handleEvent in interface IPipelineStep
    
    Overrides:
    
    handleEvent in class BasePipelineStep
  - handleStartBatch
```
protected Event handleStartBatch(Event event)
```
    Overrides:
    
    handleStartBatch in class BasePipelineStep
  - handleEndBatch
```
protected Event handleEndBatch(Event event)
```
    Overrides:
    
    handleEndBatch in class BasePipelineStep
  - handleRawDocument
```
protected Event handleRawDocument(Event event)
```
    Overrides:
    
    handleRawDocument in class BasePipelineStep
  - handleStartDocument
```
protected Event handleStartDocument(Event event)
```
    Overrides:
    
    handleStartDocument in class BasePipelineStep
  - setParameters
```
public void setParameters(IParameters params)
```
    Specified by:
    
    setParameters in interface IPipelineStep
    
    Overrides:
    
    setParameters in class BasePipelineStep
  - getParameters
```
public Parameters getParameters()
```
    Specified by:
    
    getParameters in interface IPipelineStep
    
    Overrides:
    
    getParameters in class BasePipelineStep
  - getPackageWriter
```
protected IPackageWriter getPackageWriter()
```

Class ExtractionStep

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ExtractionStep

Method Detail

getDescription

getName

setSourceLocale

getSourceLocale

setTargetLocale

getTargetLocale

setInputURI

getInputURI

setOutputURI

getOutputURI

setOutputEncoding

getOutputEncoding

setFilterConfigurationId

getFilterConfigurationId

setRootDirectory

getRootDir

setInputRootDirectory

setOutputRootDirectory

getInputRootDirectory

setContext

handleEvent

handleStartBatch

handleEndBatch

handleRawDocument

handleStartDocument

setParameters

getParameters

getPackageWriter