ParagraphAlignerStep (Okapi Framework SDK 1.41.0 API)

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

All Implemented Interfaces:

IPipelineStep
```
public class ParagraphAlignerStep
extends BasePipelineStep
```
Align paragraphs (TextUnits) between a source and target document. Uses inter-paragraph formatting and other heuristics to align paragraphs. TextUnits from this step can be sent the the SentenceAlignerStep for more fine grained alignment. TextUnits should not be segmented.

Author:

HARGRAVEJE

Constructor Summary

Constructors
Constructor and Description

ParagraphAlignerStep()

Constructors
Constructor and Description
`ParagraphAlignerStep()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`handleDocumentPart(Event event)` Handles the `EventType.DOCUMENT_PART` event.
`protected Event`	`handleEndBatch(Event event)` Handles the `EventType.END_BATCH` event.
`protected Event`	`handleEndDocument(Event event)` Handles the `EventType.END_DOCUMENT` event.
`protected Event`	`handleEndGroup(Event event)` Handles the `EventType.END_GROUP` event.
`protected Event`	`handleEndSubDocument(Event event)` Handles the `EventType.END_SUBDOCUMENT` event.
`protected Event`	`handleStartBatch(Event event)` Handles the `EventType.START_BATCH` event.
`protected Event`	`handleStartDocument(Event event)` Handles the `EventType.START_DOCUMENT` event.
`protected Event`	`handleStartGroup(Event event)` Handles the `EventType.START_GROUP` event.
`protected Event`	`handleStartSubDocument(Event event)` Handles the `EventType.START_SUBDOCUMENT` event.
`protected Event`	`handleTextUnit(Event sourceEvent)` Handles the `EventType.TEXT_UNIT` event.
`void`	`setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)`
`void`	`setParameters(IParameters params)` Sets new parameters for this step.
`void`	`setSecondInput(RawDocument secondInput)`
`void`	`setSourceLocale(LocaleId sourceLocale)`
`void`	`setTargetLocale(LocaleId targetLocale)`

Methods inherited from class net.sf.okapi.common.pipeline.BasePipelineStep
cancel, destroy, getHelpLocation, handleCustom, handleEndBatchItem, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleRawDocument, handleStartBatchItem, handleStartSubfilter, isDone, isLastOutputStep, setLastOutputStep

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

- Constructor Detail
  - ParagraphAlignerStep
```
public ParagraphAlignerStep()
```
- Method Detail
  - setFilterConfigurationMapper
```
public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
```
  - setSourceLocale
```
public void setSourceLocale(LocaleId sourceLocale)
```
  - setTargetLocale
```
public void setTargetLocale(LocaleId targetLocale)
```
  - setSecondInput
```
public void setSecondInput(RawDocument secondInput)
```
  - getName
```
public String getName()
```
    Description copied from interface: IPipelineStep
    
    Gets the localizable name of this step.
    
    Returns:
    
    the localizable name of this step.
  - 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.
  - 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.
  - 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.
  - handleEndDocument
```
protected Event handleEndDocument(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.END_DOCUMENT event.
    
    Overrides:
    
    handleEndDocument in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleDocumentPart
```
protected Event handleDocumentPart(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.DOCUMENT_PART event.
    
    Overrides:
    
    handleDocumentPart in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleStartSubDocument
```
protected Event handleStartSubDocument(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.START_SUBDOCUMENT event.
    
    Overrides:
    
    handleStartSubDocument in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleEndSubDocument
```
protected Event handleEndSubDocument(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.END_SUBDOCUMENT event.
    
    Overrides:
    
    handleEndSubDocument in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleStartGroup
```
protected Event handleStartGroup(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.START_GROUP event.
    
    Overrides:
    
    handleStartGroup in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleEndGroup
```
protected Event handleEndGroup(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.END_GROUP event.
    
    Overrides:
    
    handleEndGroup in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleTextUnit
```
protected Event handleTextUnit(Event sourceEvent)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.TEXT_UNIT event.
    
    Overrides:
    
    handleTextUnit in class BasePipelineStep
    
    Parameters:
    
    sourceEvent - event to handle.
    
    Returns:
    
    the event returned.

Class ParagraphAlignerStep

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ParagraphAlignerStep

Method Detail

setFilterConfigurationMapper

setSourceLocale

setTargetLocale

setSecondInput

getName

getDescription

getParameters

setParameters

handleStartBatch

handleEndBatch

handleStartDocument

handleEndDocument

handleDocumentPart

handleStartSubDocument

handleEndSubDocument

handleStartGroup

handleEndGroup

handleTextUnit