com.raritantechnologies.inxight
Class InxightSummarizer

java.lang.Object
  com.raritantechnologies.inxight.InxightSummarizer

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class InxightSummarizer

extends java.lang.Object

implements IFieldFormatter

Result summarizer that uses the Inxight SmartDiscovery Analysis Server.

XML Configuration Template:

   <FieldFormatter formatterClass="com.raritantechnologies.inxight.InxightSummarizer"
                      analysisServerHost="[ host name of SmartDiscovery Analysis server ]"
                      analysisServerPort="[ port that SmartDiscovery Analysis server is listening on ]"
                      fullTextField="[ result field that contains content text to analyze ]"
                      fullTextURLField="[ result field that URL to document content ]"
                      keyPhraseField="[ result field to put extracted key phrases ]"
                      sentenceField="[ result field to extracted sentences ]"
                      numKeyPhrases="[ maximum number of Key Phrases to extract ]"
                      numSentences="[ maximum number of Sentences to extract ]" />
 

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

InxightSummarizer()

Method Summary

java.lang.String	formatField(java.lang.String fieldVal) Reformats a field value.
java.lang.String	formatField(java.lang.String sessionID, java.lang.String fieldVal) Reformats a field value.
void	formatResultField(IResult result) Formats a result field "in place".
void	formatResultField(java.lang.String sessionID, IResult result) Formats a result field "in place", incorporating session context.
java.lang.String	getFieldName() Returns the name of the result field that this formatter can reformat.
java.lang.String	getFullTextField()
java.lang.String	getFullTextURLField()
java.lang.String	getKeyPhraseField()
java.lang.String	getSentenceField()
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.
void	setFullTextField(java.lang.String fullTextField)
void	setFullTextURLField(java.lang.String fullTextURLField)
void	setKeyPhraseField(java.lang.String keyPhraseField)
void	setSentenceField(java.lang.String sentenceField)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

getConfigurationXML, getConfigurationXML

Constructor Detail

InxightSummarizer

public InxightSummarizer()

Method Detail

getFullTextField

public java.lang.String getFullTextField()

setFullTextField

public void setFullTextField(java.lang.String fullTextField)

getFullTextURLField

public java.lang.String getFullTextURLField()

setFullTextURLField

public void setFullTextURLField(java.lang.String fullTextURLField)

getKeyPhraseField

public java.lang.String getKeyPhraseField()

setKeyPhraseField

public void setKeyPhraseField(java.lang.String keyPhraseField)

getSentenceField

public java.lang.String getSentenceField()

setSentenceField

public void setSentenceField(java.lang.String sentenceField)

formatResultField

public void formatResultField(java.lang.String sessionID,
                              IResult result)

Description copied from interface: IFieldFormatter

Formats a result field "in place", incorporating session context.

Specified by:

formatResultField in interface IFieldFormatter

Parameters:

sessionID - The session key needed to lookup any session content stored in the session data cache.

result - The result object that is to be formatted.

formatResultField

public void formatResultField(IResult result)

Description copied from interface: IFieldFormatter

Formats a result field "in place".

Specified by:

formatResultField in interface IFieldFormatter

Parameters:

result - The result object that is to be formatted.

getFieldName

public java.lang.String getFieldName()

Description copied from interface: IFieldFormatter

Returns the name of the result field that this formatter can reformat.

Specified by:

getFieldName in interface IFieldFormatter

formatField

public java.lang.String formatField(java.lang.String sessionID,
                                    java.lang.String fieldVal)

Description copied from interface: IFieldFormatter

Reformats a field value.

Specified by:

formatField in interface IFieldFormatter

Parameters:

sessionID - The session key needed to lookup any session content stored in the session data cache.

fieldVal - The field value to be reformatted.

Returns:

The reformatted field value.

formatField

public java.lang.String formatField(java.lang.String fieldVal)

Description copied from interface: IFieldFormatter

Reformats a field value.

Specified by:

formatField in interface IFieldFormatter

Parameters:

fieldVal - The field value to be reformatted.

Returns:

The reformatted field value.

initialize

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

Description copied from interface: IFieldFormatter

Initializes the formatter from configuration XML element.

Specified by:

initialize in interface IFieldFormatter