CharacterCountStep (Okapi Framework SDK 1.41.0 API)

java.lang.Object
- net.sf.okapi.lib.extra.Component
- - net.sf.okapi.lib.extra.OkapiComponent
  - - net.sf.okapi.lib.extra.steps.AbstractPipelineStep
    - - net.sf.okapi.steps.wordcount.CharacterCountStep

All Implemented Interfaces:

IPipelineStep, IComponent, IConfigurable, INotifiable
```
public class CharacterCountStep
extends AbstractPipelineStep
```
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
`protected void`	`component_init()`
`CharacterCounter.Counts`	`getBatchCount()`
`CharacterCounter.Counts`	`getBatchItemCount()`
`String`	`getDescription()` Gets the description of this component.
`CharacterCounter.Counts`	`getDocumentCount()`
`CharacterCounter.Counts`	`getGroupCount()`
`String`	`getName()` Gets the name of this component.
`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.lib.extra.steps.AbstractPipelineStep
cancel, destroy, getHelpLocation, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleRawDocument, handleStartSubfilter, isDone, isLastOutputStep, setLastOutputStep, setSourceLocale, setTargetLocale

Methods inherited from class net.sf.okapi.lib.extra.OkapiComponent
component_done, getParameters, getParameters, getParametersClassName, setParameters

Methods inherited from class net.sf.okapi.lib.extra.Component
exec, setDescription, setName, toString

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

Methods inherited from interface net.sf.okapi.common.pipeline.IPipelineStep
getParameters, setParameters

- Constructor Detail
  - CharacterCountStep
```
public CharacterCountStep()
```
- Method Detail
  - component_init
```
protected void component_init()
```
    Specified by:
    
    component_init in class OkapiComponent
  - getDescription
```
public String getDescription()
```
    Description copied from interface: IComponent
    
    Gets the description of this component.
    
    Specified by:
    
    getDescription in interface IPipelineStep
    
    Specified by:
    
    getDescription in interface IComponent
    
    Overrides:
    
    getDescription in class Component
    
    Returns:
    
    The description of this component.
  - getName
```
public String getName()
```
    Description copied from interface: IComponent
    
    Gets the name of this component.
    
    Specified by:
    
    getName in interface IPipelineStep
    
    Specified by:
    
    getName in interface IComponent
    
    Overrides:
    
    getName in class Component
    
    Returns:
    
    The name of this component.
  - 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: AbstractPipelineStep
    
    Handles the EventType.START_BATCH event.
    
    Overrides:
    
    handleStartBatch in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - handleEndBatch
```
protected Event handleEndBatch(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.END_BATCH event.
    
    Overrides:
    
    handleEndBatch in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - handleStartBatchItem
```
protected Event handleStartBatchItem(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.START_BATCH_ITEM event.
    
    Overrides:
    
    handleStartBatchItem in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - handleEndBatchItem
```
protected Event handleEndBatchItem(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.END_BATCH_ITEM event.
    
    Overrides:
    
    handleEndBatchItem in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - handleStartDocument
```
protected Event handleStartDocument(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.START_DOCUMENT event.
    
    Overrides:
    
    handleStartDocument in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - handleEndDocument
```
protected Event handleEndDocument(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.END_DOCUMENT event.
    
    Overrides:
    
    handleEndDocument in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - handleStartSubDocument
```
protected Event handleStartSubDocument(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.START_SUBDOCUMENT event.
    
    Overrides:
    
    handleStartSubDocument in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - handleEndSubDocument
```
protected Event handleEndSubDocument(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.END_SUBDOCUMENT event.
    
    Overrides:
    
    handleEndSubDocument in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - handleStartGroup
```
protected Event handleStartGroup(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.START_GROUP event.
    
    Overrides:
    
    handleStartGroup in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - handleEndGroup
```
protected Event handleEndGroup(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.END_GROUP event.
    
    Overrides:
    
    handleEndGroup in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.
  - getSource
```
protected TextContainer getSource()
```
  - handleTextUnit
```
protected Event handleTextUnit(Event event)
```
    Description copied from class: AbstractPipelineStep
    
    Handles the EventType.TEXT_UNIT event.
    
    Overrides:
    
    handleTextUnit in class AbstractPipelineStep
    
    Parameters:
    
    event - the event itself.

Class CharacterCountStep

Constructor Summary

Method Summary

Methods inherited from class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

Methods inherited from class net.sf.okapi.lib.extra.OkapiComponent

Methods inherited from class net.sf.okapi.lib.extra.Component

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterCountStep

Method Detail

component_init

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