Package net.sf.okapi.steps.wordcount

Class CharacterCountStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.wordcount.CharacterCountStep

All Implemented Interfaces:

AutoCloseable, Function<Stream<Event>,Stream<Event>>, 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	Description
CharacterCountStep()

Method Summary

Modifier and Type	Method	Description
CharacterCounter.Counts	getBatchCount()
CharacterCounter.Counts	getBatchItemCount()
String	getDescription()
CharacterCounter.Counts	getDocumentCount()
CharacterCounter.Counts	getGroupCount()
String	getName()
protected TextContainer	getSource()
CharacterCounter.Counts	getSubDocumentCount()
protected Event	handleEndBatch(Event event)
protected Event	handleEndBatchItem(Event event)
protected Event	handleEndDocument(Event event)
protected Event	handleEndGroup(Event event)
protected Event	handleEndSubDocument(Event event)
protected Event	handleStartBatch(Event event)
protected Event	handleStartBatchItem(Event event)
protected Event	handleStartDocument(Event event)
protected Event	handleStartGroup(Event event)
protected Event	handleStartSubDocument(Event event)
protected Event	handleTextUnit(Event 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

Methods inherited from interface java.util.function.Function

andThen, compose

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

apply, close, handleStream

Constructor Detail

CharacterCountStep

public CharacterCountStep()

Method Detail

getDescription

public String getDescription()

getName

public String getName()

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)

Overrides:

handleStartBatch in class BasePipelineStep

handleEndBatch

protected Event handleEndBatch(Event event)

Overrides:

handleEndBatch in class BasePipelineStep

handleStartBatchItem

protected Event handleStartBatchItem(Event event)

Overrides:

handleStartBatchItem in class BasePipelineStep

handleEndBatchItem

protected Event handleEndBatchItem(Event event)

Overrides:

handleEndBatchItem in class BasePipelineStep

handleStartDocument

protected Event handleStartDocument(Event event)

Overrides:

handleStartDocument in class BasePipelineStep

handleEndDocument

protected Event handleEndDocument(Event event)

Overrides:

handleEndDocument in class BasePipelineStep

handleStartSubDocument

protected Event handleStartSubDocument(Event event)

Overrides:

handleStartSubDocument in class BasePipelineStep

handleEndSubDocument

protected Event handleEndSubDocument(Event event)

Overrides:

handleEndSubDocument in class BasePipelineStep

handleStartGroup

protected Event handleStartGroup(Event event)

Overrides:

handleStartGroup in class BasePipelineStep

handleEndGroup

protected Event handleEndGroup(Event event)

Overrides:

handleEndGroup in class BasePipelineStep

getSource

protected TextContainer getSource()

handleTextUnit

protected Event handleTextUnit(Event event)

Overrides:

handleTextUnit in class BasePipelineStep