net.sf.okapi.steps.wordcount

Class WordCountStep

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.common.BaseCountStep

net.sf.okapi.steps.wordcount.common.TokenCountStep

net.sf.okapi.steps.wordcount.WordCountStep

All Implemented Interfaces:

IPipelineStep, IComponent, IConfigurable, INotifiable

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 and Description
static String	METRIC

Constructor Summary

Constructors

Constructor and Description
WordCountStep()

Method Summary

Modifier and Type	Method and Description
protected long	count(Segment segment, LocaleId locale)
protected long	count(TextContainer textContainer, LocaleId locale)
protected boolean	countOnlyTranslatable()
String	getDescription() Gets the description of this component.
String	getMetric()
String	getName() Gets the name of this component.
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

component_init, 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.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

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()

Description copied from interface: IComponent

Gets the description of this component.

Specified by:

getDescription in interface IPipelineStep

Specified by:

getDescription in interface IComponent

Specified by:

getDescription in class BaseCountStep

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

Specified by:

getName in class BaseCountStep

Returns:

The name of this component.

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