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:

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 and Description
static class	SearchAndReplaceStep.ProcType
static class	SearchAndReplaceStep.TargetType

Constructor Summary

Constructors

Constructor and Description
SearchAndReplaceStep()

Method Summary

Modifier and Type	Method and Description
static int	countMatches(String str, String sub)
static int	countRegExMatches(String str, Pattern p)
void	destroy()
String	getDescription()
String	getName()
IParameters	getParameters()
protected Event	handleEndBatch(Event event)
protected Event	handleRawDocument(Event event)
protected Event	handleStartBatch(Event event)
protected Event	handleTextUnit(Event event)
static boolean	isEmpty(String str)
void	setInputRootDirectory(String inputRootDir)
void	setOutputURI(URI outputURI)
void	setParameters(IParameters params)
void	setRootDirectory(String rootDir)
void	setTargetLocale(LocaleId targetLocale)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchAndReplaceStep

public SearchAndReplaceStep()

Method Detail

destroy

public void destroy()

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)

getDescription

public String getDescription()

getName

public String getName()

getParameters

public IParameters getParameters()

Specified by:

getParameters in interface IPipelineStep

Overrides:

getParameters in class BasePipelineStep

setParameters

public void setParameters(IParameters params)

Specified by:

setParameters in interface IPipelineStep

Overrides:

setParameters 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

handleTextUnit

protected Event handleTextUnit(Event event)

Overrides:

handleTextUnit in class BasePipelineStep

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)