com.raritantechnologies.concept
Class RelatedKeywordProcessor

java.lang.Object
  extended bycom.raritantechnologies.concept.RelatedKeywordProcessor
All Implemented Interfaces:
IConfigurable, IGatewayOutputProcessor, IResultSetProcessor

public class RelatedKeywordProcessor
extends java.lang.Object
implements IGatewayOutputProcessor, IResultSetProcessor

Uses clustering to compute related keywords based on co-occurrence of keywords within IResult text fields. Uses a nested IDocumentKeywordProcessor to handle related keyword extraction. The related keywords can be determined by proximity within the document text, and a threshold of minimum number of associations can be set.

Creates an output IResultSet with one result per keyword from the input result sets. Each output result contains a nested result set with the set of related keywords as well as metrics on the strength of the association.

XML Configuration Template:
  <OutputProcessor class="com.raritantechnologies.concept.RelatedKeywordProcessor"
                      keywordField="[ result field that gets main keyword ]"
                      associatedKeywordsField="[ result field that gets list of associated keywords ]"
                      minAssociationDistance="[ minimum word distance for association ]"
                      minNumberAssociations="[ minimum number of associations needed ]" >

    <DocumentProcessor class="[ class of com.raritantechnologies.concept.IDocumentKeywordProcessor ]" >

    </DocumentProcessor>

    <!-- Gateway Output Processor to handle related document results -->
    <OutputProcessor class="[ class of com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor ]" >

    </OutputProcessor>

  </OutputProcessor>
 

Developed by Raritan Technologies .

Author:
Ted Sullivan

Constructor Summary
RelatedKeywordProcessor()
           
 
Method Summary
 void dataComplete()
          Data feed is complete.
 java.lang.String getConfigurationXML()
           
 void initialize(org.w3c.dom.Element outputProcElem)
          Initialize the GatewayOutputProcessor from XML Element.
 void initialize(org.w3c.dom.Element outputProcElem, ISearchFieldMap sfMap)
          Initialize the GatewayOutputProcessor from XML Configuration Element.
 void initialize(java.util.Map initParams)
          Used for dynamic initialization (connection, collection name, file name, etc.)
 java.lang.String processData(IResultSet data)
          returns name of XML File created/appended.
 void processResultSet(java.lang.String sessionID, IResultSet data)
          processes the IResultSet (somehow)
 void setOutputProcessor(IGatewayOutputProcessor outputProc)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RelatedKeywordProcessor

public RelatedKeywordProcessor()
Method Detail

processData

public java.lang.String processData(IResultSet data)
Description copied from interface: IGatewayOutputProcessor
returns name of XML File created/appended.

Specified by:
processData in interface IGatewayOutputProcessor

processResultSet

public void processResultSet(java.lang.String sessionID,
                             IResultSet data)
Description copied from interface: IResultSetProcessor
processes the IResultSet (somehow)

Specified by:
processResultSet in interface IResultSetProcessor

dataComplete

public void dataComplete()
Data feed is complete.

Specified by:
dataComplete in interface IGatewayOutputProcessor

initialize

public void initialize(java.util.Map initParams)
Description copied from interface: IGatewayOutputProcessor
Used for dynamic initialization (connection, collection name, file name, etc.)

Specified by:
initialize in interface IGatewayOutputProcessor

initialize

public void initialize(org.w3c.dom.Element outputProcElem)
Initialize the GatewayOutputProcessor from XML Element.

Specified by:
initialize in interface IResultSetProcessor

initialize

public void initialize(org.w3c.dom.Element outputProcElem,
                       ISearchFieldMap sfMap)
Description copied from interface: IGatewayOutputProcessor
Initialize the GatewayOutputProcessor from XML Configuration Element.

Specified by:
initialize in interface IGatewayOutputProcessor

getConfigurationXML

public java.lang.String getConfigurationXML()
Specified by:
getConfigurationXML in interface IGatewayOutputProcessor

setOutputProcessor

public void setOutputProcessor(IGatewayOutputProcessor outputProc)