net.sf.okapi.steps.wordcount.common

Class BaseCountStep

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

All Implemented Interfaces:

IPipelineStep, net.sf.okapi.lib.extra.IComponent, net.sf.okapi.lib.extra.IConfigurable, net.sf.okapi.lib.extra.INotifiable

Direct Known Subclasses:

AltAnnotationBasedCountStep, GMXProtectedWordCountStep, TokenCountStep

public abstract class BaseCountStep
extends net.sf.okapi.lib.extra.steps.AbstractPipelineStep

Base abstract class for different counter steps (word count step, character count step, etc.).

Version:

0.1 08.07.2009

Constructor Summary

Constructors

Constructor and Description
BaseCountStep()

Method Summary

Modifier and Type	Method and Description
protected void	component_init()
protected abstract long	count(Segment segment, LocaleId locale)
protected abstract long	count(TextContainer textContainer, LocaleId locale)
protected abstract long	countInTextUnit(ITextUnit textUnit)
protected abstract boolean	countOnlyTranslatable()
long	getBatchCount()
long	getBatchItemCount()
abstract String	getDescription()
long	getDocumentCount()
long	getGroupCount()
abstract String	getMetric()
abstract String	getName()
protected TextContainer	getSource()
long	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, long count)
protected void	saveToMetrics(Event event, long count)
protected void	saveToMetrics(Segment seg, long count)
protected void	saveToMetrics(TextContainer textContainer, long 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

BaseCountStep

public BaseCountStep()

Method Detail

component_init

protected void component_init()

Specified by:

component_init in class net.sf.okapi.lib.extra.OkapiComponent

getName

public abstract 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

getDescription

public abstract 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

getMetric

public abstract String getMetric()

count

protected abstract long count(TextContainer textContainer,
                              LocaleId locale)

count

protected abstract long count(Segment segment,
                              LocaleId locale)

countInTextUnit

protected abstract long countInTextUnit(ITextUnit textUnit)

countOnlyTranslatable

protected abstract boolean countOnlyTranslatable()

saveCount

protected void saveCount(Metrics metrics,
                         long count)

getBatchCount

public long getBatchCount()

getBatchItemCount

public long getBatchItemCount()

getDocumentCount

public long getDocumentCount()

getSubDocumentCount

public long getSubDocumentCount()

getGroupCount

public long getGroupCount()

saveToMetrics

protected void saveToMetrics(Event event,
                             long 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,
                             long count)

saveToMetrics

protected void saveToMetrics(Segment seg,
                             long 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