CharacterCountStep (Okapi Framework SDK 1.42.0 API)

java.lang.Object
- net.sf.okapi.common.pipeline.BasePipelineStep
- - net.sf.okapi.steps.wordcount.CharacterCountStep

All Implemented Interfaces:

IPipelineStep
```
public class CharacterCountStep
extends BasePipelineStep
```
Character Counter pipeline step. The counter counts a number of characters in translatable text units. The count results are placed in a MetricsAnnotation structure (with the GMX TotalCharacterCount, WhiteSpaceCharacterCount, and PunctuationCharacterCount metrics set), attached to the respective event's resource (TEXT_UNIT, END_DOCUMENT, END_BATCH, END_BATCH_ITEM, END_SUBDOCUMENT, END_GROUP).

Constructor Summary

Constructors
Constructor and Description

CharacterCountStep()

Constructors
Constructor and Description
`CharacterCountStep()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CharacterCounter.Counts`	`getBatchCount()`
`CharacterCounter.Counts`	`getBatchItemCount()`
`String`	`getDescription()` Gets a short localizable description of what this step does.
`CharacterCounter.Counts`	`getDocumentCount()`
`CharacterCounter.Counts`	`getGroupCount()`
`String`	`getName()` Gets the localizable name of this step.
`protected TextContainer`	`getSource()`
`CharacterCounter.Counts`	`getSubDocumentCount()`
`protected Event`	`handleEndBatch(Event event)` Handles the `EventType.END_BATCH` event.
`protected Event`	`handleEndBatchItem(Event event)` Handles the `EventType.END_BATCH_ITEM` 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`	`handleStartBatchItem(Event event)` Handles the `EventType.START_BATCH_ITEM` 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 event)` Handles the `EventType.TEXT_UNIT` event.
`protected void`	`removeFromMetrics(IWithAnnotations res, String metricName)`
`protected void`	`removeFromMetrics(Segment seg, String metricName)`
`protected void`	`removeFromMetrics(TextContainer textContainer, String metricName)`
`protected void`	`saveCount(Metrics metrics, CharacterCounter.Counts count)`
`protected void`	`saveToMetrics(Event event, CharacterCounter.Counts count)`
`protected void`	`saveToMetrics(Segment seg, CharacterCounter.Counts count)`
`protected void`	`saveToMetrics(TextContainer textContainer, CharacterCounter.Counts count)`

Methods inherited from class net.sf.okapi.common.pipeline.BasePipelineStep
cancel, destroy, getHelpLocation, getParameters, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleRawDocument, handleStartSubfilter, isDone, isLastOutputStep, setLastOutputStep, setParameters, setSourceLocale, setTargetLocale

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

- Constructor Detail
  - CharacterCountStep
```
public CharacterCountStep()
```
- 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.
  - saveCount
```
protected void saveCount(Metrics metrics,
                         CharacterCounter.Counts count)
```
  - getBatchCount
```
public CharacterCounter.Counts getBatchCount()
```
  - getBatchItemCount
```
public CharacterCounter.Counts getBatchItemCount()
```
  - getDocumentCount
```
public CharacterCounter.Counts getDocumentCount()
```
  - getSubDocumentCount
```
public CharacterCounter.Counts getSubDocumentCount()
```
  - getGroupCount
```
public CharacterCounter.Counts getGroupCount()
```
  - saveToMetrics
```
protected void saveToMetrics(Event event,
                             CharacterCounter.Counts count)
```
  - removeFromMetrics
```
protected void removeFromMetrics(IWithAnnotations res,
                                 String metricName)
```
  - removeFromMetrics
```
protected void removeFromMetrics(TextContainer textContainer,
                                 String metricName)
```
  - removeFromMetrics
```
protected void removeFromMetrics(Segment seg,
                                 String metricName)
```
  - saveToMetrics
```
protected void saveToMetrics(TextContainer textContainer,
                             CharacterCounter.Counts count)
```
  - saveToMetrics
```
protected void saveToMetrics(Segment seg,
                             CharacterCounter.Counts count)
```
  - 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.
  - handleStartBatchItem
```
protected Event handleStartBatchItem(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.START_BATCH_ITEM event.
    
    Overrides:
    
    handleStartBatchItem in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleEndBatchItem
```
protected Event handleEndBatchItem(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.END_BATCH_ITEM event.
    
    Overrides:
    
    handleEndBatchItem 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.
  - 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.
  - getSource
```
protected TextContainer getSource()
```
  - 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.

Class CharacterCountStep

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CharacterCountStep

Method Detail

getDescription

getName

saveCount

getBatchCount

getBatchItemCount

getDocumentCount

getSubDocumentCount

getGroupCount

saveToMetrics

removeFromMetrics

removeFromMetrics

removeFromMetrics

saveToMetrics

saveToMetrics

handleStartBatch

handleEndBatch

handleStartBatchItem

handleEndBatchItem

handleStartDocument

handleEndDocument

handleStartSubDocument

handleEndSubDocument

handleStartGroup

handleEndGroup

getSource

handleTextUnit