com.raritantechnologies.uima
Class UIMATermClusterAnalyzer

java.lang.Object
  CasConsumer_ImplBase
      com.raritantechnologies.uima.UIMATermClusterAnalyzer

All Implemented Interfaces:

IConfigurable, IUIMAResultProcessor

public class UIMATermClusterAnalyzer

extends CasConsumer_ImplBase

implements IUIMAResultProcessor

Creates keyword clusters. Relates terms based on frequency of term co-occurrence within documents.

XML Configuration Template:

   <ResultProcessor class="com.raritantechnologies.uima.UIMATermClusterAnalyzer"
                       keywordField="[ field in result that contains main keyword ]"
                       casDescriptorFile="[ location of UIMATermClusterDescriptor.xml ]"
                       minClusterDistance="[ minimum distance between keywords for clustering ]"
                       minDocumentCount="[ minimum number of documents / keyword for clustering ]"
                       minDocumentFraction="[ minimum fraction (0.0 to 1.0) for associated words ]"
                       useSentenceBoundaries="true|false(default)" >

     <ExcludeTerms>[ comma separated list of excluded terms ]

     <OutputProcessor class="[ class of com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor ]" >

     </OutputProcessor>

   </ResultProcessor>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

See Also:

Serialized Form

Constructor Summary

UIMATermClusterAnalyzer()

Method Summary

void	addResult(java.lang.String resKey, IResult result)
void	dataComplete() Generates a ResultSet.
ProcessingResourceMetaData	getProcessingResourceMetaData()
UimaContext	getUimaContext()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	processCas(CAS aCAS) Retrieves all of the annotations added to the CAS, builds term - relationship clusters.
void	setUimaContext(UimaContext uimaContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

UIMATermClusterAnalyzer

public UIMATermClusterAnalyzer()

Method Detail

processCas

public void processCas(CAS aCAS)
                throws ResourceProcessException

Retrieves all of the annotations added to the CAS, builds term - relationship clusters.

Throws:

ResourceProcessException

addResult

public void addResult(java.lang.String resKey,
                      IResult result)

Specified by:

addResult in interface IUIMAResultProcessor

dataComplete

public void dataComplete()

Generates a ResultSet. One Result for each keyword found. Creates Nested ResultSet in which each nested result has a keyword and association strength.

Specified by:

dataComplete in interface IUIMAResultProcessor

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

getProcessingResourceMetaData

public ProcessingResourceMetaData getProcessingResourceMetaData()

setUimaContext

public void setUimaContext(UimaContext uimaContext)

Specified by:

setUimaContext in interface IUIMAResultProcessor

getUimaContext

public UimaContext getUimaContext()