WordCountStep (Okapi Step for Word Count 1.46.0 API)

java.lang.Object
- net.sf.okapi.common.pipeline.BasePipelineStep
- - net.sf.okapi.steps.wordcount.common.BaseCountStep
  - - net.sf.okapi.steps.wordcount.common.TokenCountStep
    - - net.sf.okapi.steps.wordcount.WordCountStep

All Implemented Interfaces:

AutoCloseable, Function<Stream<Event>,Stream<Event>>, IPipelineStep
```
public class WordCountStep
extends TokenCountStep
```
Word Counter pipeline step. The counter counts a number of words in translatable text units. The count results are placed in a MetricsAnnotation structure (with the GMX TotalWordCount metric set), attached to the respective event's resource (TEXT_UNIT, END_DOCUMENT, END_BATCH, END_BATCH_ITEM, END_SUBDOCUMENT, END_GROUP).

Version:

0.1 06.07.2009

Field Summary

Fields
Modifier and Type Field Description

static String METRIC

Constructor Summary

Constructors
Constructor Description

WordCountStep()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected long`	`count(Segment segment, LocaleId locale)`
`protected long`	`count(TextContainer textContainer, LocaleId locale)`
`protected boolean`	`countOnlyTranslatable()`
`String`	`getDescription()`
`String`	`getMetric()`
`String`	`getName()`
`protected String[]`	`getTokenNames()`

Methods inherited from class net.sf.okapi.steps.wordcount.common.TokenCountStep
countInTextUnit, filterTokens, getTokens, getTokens

Methods inherited from class net.sf.okapi.steps.wordcount.common.BaseCountStep
getBatchCount, getBatchItemCount, getDocumentCount, getGroupCount, getSource, getSubDocumentCount, handleEndBatch, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleStartBatch, handleStartBatchItem, handleStartDocument, handleStartGroup, handleStartSubDocument, handleTextUnit, removeFromMetrics, removeFromMetrics, removeFromMetrics, saveCount, saveToMetrics, saveToMetrics, saveToMetrics

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

Methods inherited from interface java.util.function.Function
andThen, compose

Methods inherited from interface net.sf.okapi.common.pipeline.IPipelineStep
apply, close, handleStream

- Field Detail
  - METRIC
```
public static final String METRIC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WordCountStep
```
public WordCountStep()
```
- Method Detail
  - getMetric
```
public String getMetric()
```
    Specified by:
    
    getMetric in class BaseCountStep
  - getTokenNames
```
protected String[] getTokenNames()
```
    Specified by:
    
    getTokenNames in class TokenCountStep
  - countOnlyTranslatable
```
protected boolean countOnlyTranslatable()
```
    Specified by:
    
    countOnlyTranslatable in class BaseCountStep
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface IPipelineStep
    
    Specified by:
    
    getDescription in class BaseCountStep
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface IPipelineStep
    
    Specified by:
    
    getName in class BaseCountStep
  - count
```
protected long count(Segment segment,
                     LocaleId locale)
```
    Overrides:
    
    count in class TokenCountStep
  - count
```
protected long count(TextContainer textContainer,
                     LocaleId locale)
```
    Overrides:
    
    count in class TokenCountStep