BaseCountStep (Okapi Framework SDK 1.42.0 API)

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

All Implemented Interfaces:

IPipelineStep

Direct Known Subclasses:

AltAnnotationBasedCountStep, GMXProtectedWordCountStep, TokenCountStep
```
public abstract class BaseCountStep
extends BasePipelineStep
```
Base abstract class for different counter steps (word count step, character count step, etc.).

Constructor Summary

Constructors
Constructor and Description

BaseCountStep()

Constructors
Constructor and Description
`BaseCountStep()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`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()` Gets a short localizable description of what this step does.
`long`	`getDocumentCount()`
`long`	`getGroupCount()`
`abstract String`	`getMetric()`
`abstract String`	`getName()` Gets the localizable name of this step.
`protected TextContainer`	`getSource()`
`long`	`getSubDocumentCount()`
`protected Event`	`handleEndBatch(Event event)` Handles the `EventType.END_BATCH` event.
`protected Event`	`handleEndBatchItem(Event event)` Handles the `EventType.END_BATCH_ITEM` event.
`protected Event`	`handleEndDocument(Event event)` Handles the `EventType.END_DOCUMENT` event.
`protected Event`	`handleEndGroup(Event event)` Handles the `EventType.END_GROUP` event.
`protected Event`	`handleEndSubDocument(Event event)` Handles the `EventType.END_SUBDOCUMENT` event.
`protected Event`	`handleStartBatch(Event event)` Handles the `EventType.START_BATCH` event.
`protected Event`	`handleStartBatchItem(Event event)` Handles the `EventType.START_BATCH_ITEM` event.
`protected Event`	`handleStartDocument(Event event)` Handles the `EventType.START_DOCUMENT` event.
`protected Event`	`handleStartGroup(Event event)` Handles the `EventType.START_GROUP` event.
`protected Event`	`handleStartSubDocument(Event event)` Handles the `EventType.START_SUBDOCUMENT` event.
`protected Event`	`handleTextUnit(Event event)` Handles the `EventType.TEXT_UNIT` 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.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

- Constructor Detail
  - BaseCountStep
```
public BaseCountStep()
```
- Method Detail
  - getName
```
public abstract String getName()
```
    Description copied from interface: IPipelineStep
    
    Gets the localizable name of this step.
    
    Returns:
    
    the localizable name of this step.
  - getDescription
```
public abstract String getDescription()
```
    Description copied from interface: IPipelineStep
    
    Gets a short localizable description of what this step does.
    
    Returns:
    
    the text of a short description of what this step does.
  - 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)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.START_BATCH event.
    
    Overrides:
    
    handleStartBatch in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleEndBatch
```
protected Event handleEndBatch(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.END_BATCH event.
    
    Overrides:
    
    handleEndBatch in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleStartBatchItem
```
protected Event handleStartBatchItem(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.START_BATCH_ITEM event.
    
    Overrides:
    
    handleStartBatchItem in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleEndBatchItem
```
protected Event handleEndBatchItem(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.END_BATCH_ITEM event.
    
    Overrides:
    
    handleEndBatchItem in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleStartDocument
```
protected Event handleStartDocument(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.START_DOCUMENT event.
    
    Overrides:
    
    handleStartDocument in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleEndDocument
```
protected Event handleEndDocument(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.END_DOCUMENT event.
    
    Overrides:
    
    handleEndDocument in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleStartSubDocument
```
protected Event handleStartSubDocument(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.START_SUBDOCUMENT event.
    
    Overrides:
    
    handleStartSubDocument in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleEndSubDocument
```
protected Event handleEndSubDocument(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.END_SUBDOCUMENT event.
    
    Overrides:
    
    handleEndSubDocument in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleStartGroup
```
protected Event handleStartGroup(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.START_GROUP event.
    
    Overrides:
    
    handleStartGroup in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - handleEndGroup
```
protected Event handleEndGroup(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.END_GROUP event.
    
    Overrides:
    
    handleEndGroup in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.
  - getSource
```
protected TextContainer getSource()
```
  - handleTextUnit
```
protected Event handleTextUnit(Event event)
```
    Description copied from class: BasePipelineStep
    
    Handles the EventType.TEXT_UNIT event.
    
    Overrides:
    
    handleTextUnit in class BasePipelineStep
    
    Parameters:
    
    event - event to handle.
    
    Returns:
    
    the event returned.

Class BaseCountStep

Constructor Summary

Method Summary

Methods inherited from class net.sf.okapi.common.pipeline.BasePipelineStep

Methods inherited from class java.lang.Object

Constructor Detail

BaseCountStep

Method Detail

getName

getDescription

getMetric

count

count

countInTextUnit

countOnlyTranslatable

saveCount

getBatchCount

getBatchItemCount

getDocumentCount

getSubDocumentCount

getGroupCount

saveToMetrics

removeFromMetrics

removeFromMetrics

removeFromMetrics

saveToMetrics

saveToMetrics

handleStartBatch

handleEndBatch

handleStartBatchItem

handleEndBatchItem

handleStartDocument

handleEndDocument

handleStartSubDocument

handleEndSubDocument

handleStartGroup

handleEndGroup

getSource

handleTextUnit