com.raritantechnologies.concept
Class KeywordFieldsDocumentKeywordProcessor

java.lang.Object
  com.raritantechnologies.concept.AbstractDocumentKeywordProcessor
      com.raritantechnologies.concept.KeywordFieldsDocumentKeywordProcessor

All Implemented Interfaces:

IConfigurable, IDocumentKeywordProcessor, IGatewayOutputProcessor, IResultSetProcessor

public class KeywordFieldsDocumentKeywordProcessor

extends AbstractDocumentKeywordProcessor

implements IDocumentKeywordProcessor

DocumentKeywordProcessor that gets keywords from IResult fields.

XML Configuration Template:

  <DocumentProcessor class="com.raritantechnologies.concept.KeywordFieldsDocumentKeywordProcessor"
                        keywordFields="[ comma separated list of keyword fields ]"
                        resultKeyField="[ field with unique key for result ]"  />
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.concept.AbstractDocumentKeywordProcessor

documents, resKeyField

Constructor Summary

KeywordFieldsDocumentKeywordProcessor()

Method Summary

java.lang.String	getConfigurationXML()
protected void	getWords(IResult result, java.lang.String text, java.lang.String resultKey) Subclasses must implement this method: extract keywords from the text for the document given by resultKey.
void	initialize(org.w3c.dom.Element elem) Initialize the from XML Element.
boolean	isKeyword(WordCount wordCount)
protected void	processResult(IResult result)
void	reset()

Methods inherited from class com.raritantechnologies.concept.AbstractDocumentKeywordProcessor

addWord, addWord, dataComplete, dataComplete, getDocuments, getDocuments, getKeywordAssociations, getKeywords, getWordCounts, getWordDocumentMap, getWordDocumentMap, initialize, initialize, processData, processResultSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.concept.IDocumentKeywordProcessor

dataComplete, dataComplete, getDocuments, getKeywordAssociations, getKeywords, getWordDocumentMap, getWordDocumentMap, processResultSet

Methods inherited from interface com.raritantechnologies.searchApp.IResultSetProcessor

initialize

Methods inherited from interface com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor

initialize, initialize, processData

Constructor Detail

KeywordFieldsDocumentKeywordProcessor

public KeywordFieldsDocumentKeywordProcessor()

Method Detail

reset

public void reset()

Specified by:

reset in interface IDocumentKeywordProcessor

Overrides:

reset in class AbstractDocumentKeywordProcessor

processResult

protected void processResult(IResult result)

Overrides:

processResult in class AbstractDocumentKeywordProcessor

getWords

protected void getWords(IResult result,
                        java.lang.String text,
                        java.lang.String resultKey)

Description copied from class: AbstractDocumentKeywordProcessor

Subclasses must implement this method: extract keywords from the text for the document given by resultKey. The implemented method should call the addWord( ) method with each keyword or word.

Specified by:

getWords in class AbstractDocumentKeywordProcessor

isKeyword

public boolean isKeyword(WordCount wordCount)

Specified by:

isKeyword in class AbstractDocumentKeywordProcessor

initialize

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

Description copied from interface: IResultSetProcessor

Initialize the from XML Element.

Specified by:

initialize in interface IResultSetProcessor

Overrides:

initialize in class AbstractDocumentKeywordProcessor

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IGatewayOutputProcessor