com.raritantechnologies.verity.profiler
Class ResultProfilerFilter

java.lang.Object
  com.raritantechnologies.verity.profiler.ResultProfilerFilter

All Implemented Interfaces:

IConfigurable

public class ResultProfilerFilter

extends java.lang.Object

implements IConfigurable

Uses Verity Profiler to add classification information to search results.

Used by both the ProfilerQueryProcessorFilter and the ProfilerGatewayOutputProcessor).

XML Configuration Template:

    <ProfilerFilter serverSpec="[profiler server spec ]" 
                       serverAlias="[ K2 Server Alias ]"
                       profileAlias="[alias of profile]" 
                       queryIDField="[result field ID for profileNet query ID]"
                       queryTextField="[result field ID for query Text]"
                       queryScoreField="[result field ID for Query Score]"
                       nestedResultField="[OPTIONAL - name for nested result]" >

    </ProfilerFilter>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

ResultProfilerFilter()

ResultProfilerFilter(java.lang.String serverSpec, java.lang.String profileAlias)

ResultProfilerFilter(java.lang.String serverSpec, java.lang.String profileAlias, java.lang.String queryIDField, java.lang.String queryTextField, java.lang.String queryScoreField)

Method Summary

protected java.lang.String	getDocument(IResult result, ILoginInfo user)
java.lang.String	getNestedResultField()
java.lang.String	getProfileAlias()
java.lang.String	getQueryCategoryField()
java.lang.String	getQueryIDField()
java.lang.String	getQueryScoreField()
java.lang.String	getQueryTaxonomyField()
java.lang.String	getQueryTextField()
java.lang.String	getServerAlias()
java.lang.String	getServerSpec()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	profileResult(ILoginInfo user, IResult result)
void	profileResultSet(ILoginInfo user, IResultSet resultSet)
void	setDebugTiming(boolean debugTiming)
void	setNestedResultField(java.lang.String nestedResultField)
void	setProfileAlias(java.lang.String profileAlias)
void	setQueryCategoryField(java.lang.String queryCategoryField)
void	setQueryIDField(java.lang.String queryIDField)
void	setQueryScoreField(java.lang.String queryScoreField)
void	setQueryTaxonomyField(java.lang.String queryTaxonomyField)
void	setQueryTextField(java.lang.String queryTextField)
void	setServerAlias(java.lang.String serverAlias)
void	setServerSpec(java.lang.String serverSpec)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultProfilerFilter

public ResultProfilerFilter()

ResultProfilerFilter

public ResultProfilerFilter(java.lang.String serverSpec,
                            java.lang.String profileAlias)

ResultProfilerFilter

public ResultProfilerFilter(java.lang.String serverSpec,
                            java.lang.String profileAlias,
                            java.lang.String queryIDField,
                            java.lang.String queryTextField,
                            java.lang.String queryScoreField)

Method Detail

profileResult

public void profileResult(ILoginInfo user,
                          IResult result)

profileResultSet

public void profileResultSet(ILoginInfo user,
                             IResultSet resultSet)

getDocument

protected java.lang.String getDocument(IResult result,
                                       ILoginInfo user)

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

setServerSpec

public void setServerSpec(java.lang.String serverSpec)

getServerSpec

public java.lang.String getServerSpec()

setServerAlias

public void setServerAlias(java.lang.String serverAlias)

getServerAlias

public java.lang.String getServerAlias()

setProfileAlias

public void setProfileAlias(java.lang.String profileAlias)

getProfileAlias

public java.lang.String getProfileAlias()

setNestedResultField

public void setNestedResultField(java.lang.String nestedResultField)

getNestedResultField

public java.lang.String getNestedResultField()

setQueryIDField

public void setQueryIDField(java.lang.String queryIDField)

getQueryIDField

public java.lang.String getQueryIDField()

setQueryTextField

public void setQueryTextField(java.lang.String queryTextField)

getQueryTextField

public java.lang.String getQueryTextField()

setQueryScoreField

public void setQueryScoreField(java.lang.String queryScoreField)

getQueryScoreField

public java.lang.String getQueryScoreField()

setQueryCategoryField

public void setQueryCategoryField(java.lang.String queryCategoryField)

getQueryCategoryField

public java.lang.String getQueryCategoryField()

setQueryTaxonomyField

public void setQueryTaxonomyField(java.lang.String queryTaxonomyField)

getQueryTaxonomyField

public java.lang.String getQueryTaxonomyField()

setDebugTiming

public void setDebugTiming(boolean debugTiming)