Package net.sf.okapi.steps.rainbowkit.creation

Class ExtractionStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.rainbowkit.creation.ExtractionStep

All Implemented Interfaces:

AutoCloseable, Function<Stream<Event>,Stream<Event>>, IPipelineStep

public class ExtractionStep
extends BasePipelineStep

Constructor Summary

Constructors

Constructor	Description
ExtractionStep()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets a short localizable description of what this step does.
String	getFilterConfigurationId()
String	getInputRootDirectory()
URI	getInputURI()
String	getName()	Gets the localizable name of this step.
String	getOutputEncoding()
URI	getOutputURI()
protected IPackageWriter	getPackageWriter()
Parameters	getParameters()	Gets the current parameters for this step.
String	getRootDir()
LocaleId	getSourceLocale()	Delegate to concrete class
LocaleId	getTargetLocale()	Delegate to concrete class
protected Event	handleEndBatch(Event event)	Handles the EventType.END_BATCH event.
Event	handleEvent(Event event)	Processes each event sent though the pipeline.
protected Event	handleRawDocument(Event event)	Handles the EventType.RAW_DOCUMENT event.
protected Event	handleStartBatch(Event event)	Handles the EventType.START_BATCH event.
protected Event	handleStartDocument(Event event)	Handles the EventType.START_DOCUMENT 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)	Sets new parameters for this step.
void	setRootDirectory(String rootDir)
void	setSourceLocale(LocaleId sourceLocale)	Delegate to concrete class
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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface net.sf.okapi.common.pipeline.IPipelineStep

apply, close, handleStream

Constructor Detail

ExtractionStep

public ExtractionStep()

Method Detail

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.

setSourceLocale

public void setSourceLocale(LocaleId sourceLocale)

Description copied from interface: IPipelineStep

Delegate to concrete class

Specified by:

setSourceLocale in interface IPipelineStep

Overrides:

setSourceLocale in class BasePipelineStep

getSourceLocale

public LocaleId getSourceLocale()

Description copied from interface: IPipelineStep

Delegate to concrete class

Specified by:

getSourceLocale in interface IPipelineStep

Overrides:

getSourceLocale in class BasePipelineStep

Returns:

LocaleId

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

Specified by:

setTargetLocale in interface IPipelineStep

Overrides:

setTargetLocale in class BasePipelineStep

getTargetLocale

public LocaleId getTargetLocale()

Description copied from interface: IPipelineStep

Delegate to concrete class

Specified by:

getTargetLocale in interface IPipelineStep

Overrides:

getTargetLocale in class BasePipelineStep

Returns:

LocaleId

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)

Description copied from interface: IPipelineStep

Processes each event sent though the pipeline.

Specified by:

handleEvent in interface IPipelineStep

Overrides:

handleEvent in class BasePipelineStep

Parameters:

event - the event to process.

Returns:

the event to pass down the pipeline.

handleStartBatch

protected Event handleStartBatch(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_BATCH event.

Overrides:

handleStartBatch in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleEndBatch

protected Event handleEndBatch(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.END_BATCH event.

Overrides:

handleEndBatch in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleRawDocument

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

handleStartDocument

protected Event handleStartDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_DOCUMENT event.

Overrides:

handleStartDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

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.

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.

getPackageWriter

protected IPackageWriter getPackageWriter()