net.sf.okapi.steps.wordcount

Class CharacterCountStep

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, net.sf.okapi.lib.extra.IComponent, net.sf.okapi.lib.extra.IConfigurable, net.sf.okapi.lib.extra.INotifiable

public class CharacterCountStep
extends net.sf.okapi.lib.extra.steps.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()

Method Summary

Modifier and Type	Method and Description
protected void	component_init()
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.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 net.sf.okapi.lib.extra.OkapiComponent

getDescription

public String getDescription()

Specified by:

getDescription in interface IPipelineStep

Specified by:

getDescription in interface net.sf.okapi.lib.extra.IComponent

Overrides:

getDescription in class net.sf.okapi.lib.extra.Component

getName

public String getName()

Specified by:

getName in interface IPipelineStep

Specified by:

getName in interface net.sf.okapi.lib.extra.IComponent

Overrides:

getName in class net.sf.okapi.lib.extra.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)

Overrides:

handleStartBatch in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

handleEndBatch

protected Event handleEndBatch(Event event)

Overrides:

handleEndBatch in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

handleStartBatchItem

protected Event handleStartBatchItem(Event event)

Overrides:

handleStartBatchItem in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

handleEndBatchItem

protected Event handleEndBatchItem(Event event)

Overrides:

handleEndBatchItem in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

handleStartDocument

protected Event handleStartDocument(Event event)

Overrides:

handleStartDocument in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

handleEndDocument

protected Event handleEndDocument(Event event)

Overrides:

handleEndDocument in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

handleStartSubDocument

protected Event handleStartSubDocument(Event event)

Overrides:

handleStartSubDocument in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

handleEndSubDocument

protected Event handleEndSubDocument(Event event)

Overrides:

handleEndSubDocument in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

handleStartGroup

protected Event handleStartGroup(Event event)

Overrides:

handleStartGroup in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

handleEndGroup

protected Event handleEndGroup(Event event)

Overrides:

handleEndGroup in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep

getSource

protected TextContainer getSource()

handleTextUnit

protected Event handleTextUnit(Event event)

Overrides:

handleTextUnit in class net.sf.okapi.lib.extra.steps.AbstractPipelineStep