Package net.sf.okapi.steps.searchandreplace

Class SearchAndReplaceStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.searchandreplace.SearchAndReplaceStep

All Implemented Interfaces:

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

public class SearchAndReplaceStep
extends BasePipelineStep

This step performs search and replace actions on either the text units or the full content of input documents. Source and/or target content can be searched and replaced. Takes: Raw document or Filter events. Sends: same as the input. The step provides a way to define a list of search entries and corresponding replacements. You can use regular expressions if needed. The step can take as input either a raw document or filter events. If the step receives filter events, the search and replace is done on the content of the text units, and the step sends updated filter events to the next step. If the step receives a raw document, the search and replace is done on the whole file, and the step sends an updated raw document to the next step. Note that in this case, the raw document must be in some text-based file format for the search and replace to work: The document is seen exactly like it would be in a text editor (no conversion of escaped characters is done for example).

Author:

Fredrik L., Yves S., HargraveJE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchAndReplaceStep.ProcType
static class	SearchAndReplaceStep.TargetType

Constructor Summary

Constructors

Constructor	Description
SearchAndReplaceStep()

Method Summary

Modifier and Type	Method	Description
static int	countMatches(String str, String sub)
static int	countRegExMatches(String str, Pattern p)
void	destroy()	Executes any cleanup code for this step.
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.
protected Event	handleEndBatch(Event event)	Handles the EventType.END_BATCH event.
protected Event	handleRawDocument(Event event)	Handles the EventType.RAW_DOCUMENT event.
protected Event	handleStartBatch(Event event)	Handles the EventType.START_BATCH event.
protected Event	handleTextUnit(Event event)	Handles the EventType.TEXT_UNIT event.
static boolean	isEmpty(String str)
void	setInputRootDirectory(String inputRootDir)
void	setOutputURI(URI outputURI)
void	setParameters(IParameters params)	Sets new parameters for this step.
void	setRootDirectory(String rootDir)
void	setTargetLocale(LocaleId targetLocale)

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

cancel, getHelpLocation, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleStartBatchItem, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, isDone, isLastOutputStep, setLastOutputStep, setSourceLocale

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

SearchAndReplaceStep

public SearchAndReplaceStep()

Method Detail

destroy

public void destroy()

Description copied from interface: IPipelineStep

Executes any cleanup code for this step. Called once at the end of the pipeline lifecycle.

Specified by:

destroy in interface IPipelineStep

Overrides:

destroy in class BasePipelineStep

setRootDirectory

public void setRootDirectory(String rootDir)

setInputRootDirectory

public void setInputRootDirectory(String inputRootDir)

setOutputURI

public void setOutputURI(URI outputURI)

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

Specified by:

setTargetLocale in interface IPipelineStep

Overrides:

setTargetLocale in class BasePipelineStep

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.

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.

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.

handleTextUnit

protected Event handleTextUnit(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.TEXT_UNIT event.

Overrides:

handleTextUnit in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

countRegExMatches

public static int countRegExMatches(String str,
                                    Pattern p)

countMatches

public static int countMatches(String str,
                               String sub)

isEmpty

public static boolean isEmpty(String str)