TfidfConsumer (DKPro Core - Master Aggregator 1.7.0 API)

java.lang.Object
- org.apache.uima.analysis_component.AnalysisComponent_ImplBase
- - org.apache.uima.analysis_component.Annotator_ImplBase
  - - org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    - - org.apache.uima.fit.component.JCasAnnotator_ImplBase
      - de.tudarmstadt.ukp.dkpro.core.frequency.tfidf.TfidfConsumer

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent
```
public class TfidfConsumer
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase
```
This consumer builds a DfModel. It collects the df (document frequency) counts for the processed collection. The counts are serialized as a DfModel-object.

Author:

zesch, n_erbs, parzonka

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PARAM_FEATURE_PATH` This annotator is type agnostic, so it is mandatory to specify the type of the working annotation and how to obtain the string representation with the feature path.
`static String`	`PARAM_LOWERCASE` If set to true, the whole text is handled in lower case.
`static String`	`PARAM_OUTPUT_PATH` Deprecated.
`static String`	`PARAM_TARGET_LOCATION` Specifies the path and filename where the model file is written.

Constructor Summary

Constructors
Constructor and Description

TfidfConsumer()

Constructors
Constructor and Description
`TfidfConsumer()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`collectionProcessComplete()` When this method is called by the framework, the dfModel is serialized.
`void`	`initialize(org.apache.uima.UimaContext context)`
`void`	`process(org.apache.uima.jcas.JCas jcas)`

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase
getLogger

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase
getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
batchProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAM_OUTPUT_PATH
```
@Deprecated
public static final String PARAM_OUTPUT_PATH
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - PARAM_TARGET_LOCATION
```
public static final String PARAM_TARGET_LOCATION
```
    Specifies the path and filename where the model file is written.
    
    See Also:
    Constant Field Values
  - PARAM_LOWERCASE
```
public static final String PARAM_LOWERCASE
```
    If set to true, the whole text is handled in lower case.
    
    See Also:
    Constant Field Values
  - PARAM_FEATURE_PATH
```
public static final String PARAM_FEATURE_PATH
```
    This annotator is type agnostic, so it is mandatory to specify the type of the working annotation and how to obtain the string representation with the feature path.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - TfidfConsumer
```
public TfidfConsumer()
```
- Method Detail
  - initialize
```
public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException
```
    Specified by:
    
    initialize in interface org.apache.uima.analysis_component.AnalysisComponent
    
    Overrides:
    
    initialize in class org.apache.uima.fit.component.JCasAnnotator_ImplBase
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - process
```
public void process(org.apache.uima.jcas.JCas jcas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
```
    Specified by:
    
    process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    
    Throws:
    
    org.apache.uima.analysis_engine.AnalysisEngineProcessException
  - collectionProcessComplete
```
public void collectionProcessComplete()
                               throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
```
    When this method is called by the framework, the dfModel is serialized.
    
    Specified by:
    
    collectionProcessComplete in interface org.apache.uima.analysis_component.AnalysisComponent
    
    Overrides:
    
    collectionProcessComplete in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
    
    Throws:
    
    org.apache.uima.analysis_engine.AnalysisEngineProcessException

Class TfidfConsumer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

Methods inherited from class java.lang.Object

Field Detail

PARAM_OUTPUT_PATH

PARAM_TARGET_LOCATION

PARAM_LOWERCASE

PARAM_FEATURE_PATH

Constructor Detail

TfidfConsumer

Method Detail

initialize

process

collectionProcessComplete