org.apache.ctakes.core.cc

Class TokenFreqCasConsumer

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CasConsumer_ImplBase

org.apache.ctakes.core.cc.TokenFreqCasConsumer

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.CasObjectProcessor, org.apache.uima.collection.base_cpm.CasProcessor, org.apache.uima.collection.CasConsumer, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

@PipeBitInfo(name="Word Count Writer",
             description="Writes a two-column BSV file containing Words and their total counts in a document.",
             role=WRITER,
             dependencies=BASE_TOKEN)
public class TokenFreqCasConsumer
extends org.apache.uima.collection.CasConsumer_ImplBase

This class creates a file that contains the frequencies of the word tokens found in a set in a text collection. This cas consumer could potentially be used to create a frequency file for any kind of annotation but only counts Token annotations at the moment.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_WORD_FREQ_FILE The name of the parameter that is specifies the path of the output file in the descriptor file.

Fields inherited from interface org.apache.uima.resource.Resource

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

Constructors

Constructor and Description
TokenFreqCasConsumer()

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete(org.apache.uima.util.ProcessTrace arg0) This method sorts the frequency counts and prints out the resulting frequencies in descending order to the frequency file in 'word|count' format.
void	initialize() This method opens/creates the file specified by "TokenFreqFile" and initializes the data structure that will keep track of frequency counts.
void	processCas(org.apache.uima.cas.CAS cas) Iterates through all of the WordTokenAnnotation's, gets the covered text for each annotation and increments the frequency count for that text.

Methods inherited from class org.apache.uima.collection.CasConsumer_ImplBase

batchProcessComplete, destroy, getProcessingResourceMetaData, initialize, isReadOnly, isStateless, processCas, reconfigure, typeSystemInit

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

getCasManager, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.uima.resource.ConfigurableResource

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from interface org.apache.uima.resource.Resource

getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

PARAM_WORD_FREQ_FILE

public static final String PARAM_WORD_FREQ_FILE

The name of the parameter that is specifies the path of the output file in the descriptor file. The value is "TokenFreqFile" and should be set in the descriptor file.

See Also:

Constant Field Values

Constructor Detail

TokenFreqCasConsumer

public TokenFreqCasConsumer()

Method Detail

initialize

public void initialize()
                throws org.apache.uima.resource.ResourceInitializationException

This method opens/creates the file specified by "TokenFreqFile" and initializes the data structure that will keep track of frequency counts.

Overrides:

initialize in class org.apache.uima.collection.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

See Also:

CasConsumer_ImplBase.initialize()

processCas

public void processCas(org.apache.uima.cas.CAS cas)
                throws org.apache.uima.resource.ResourceProcessException

Iterates through all of the WordTokenAnnotation's, gets the covered text for each annotation and increments the frequency count for that text.

Throws:

org.apache.uima.resource.ResourceProcessException

See Also:

CasObjectProcessor.processCas(org.apache.uima.cas.CAS)

collectionProcessComplete

public void collectionProcessComplete(org.apache.uima.util.ProcessTrace arg0)
                               throws org.apache.uima.resource.ResourceProcessException,
                                      IOException

This method sorts the frequency counts and prints out the resulting frequencies in descending order to the frequency file in 'word|count' format.

Specified by:

collectionProcessComplete in interface org.apache.uima.collection.base_cpm.CasProcessor

Overrides:

collectionProcessComplete in class org.apache.uima.collection.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceProcessException

IOException