com.raritantechnologies.concept.classifier
Class ClassifierWebServiceClient

java.lang.Object
  com.raritantechnologies.concept.classifier.ClassifierWebServiceClient

All Implemented Interfaces:

IConfigurable, IFieldFormatter, IResultSetFilter, IResultSetProcessor

public class ClassifierWebServiceClient

extends java.lang.Object

implements IFieldFormatter, IResultSetProcessor, IResultSetFilter

Uses the ClassifierWebService to add classification metadata to an IResult object.

XML Configuration Template:

  <FieldFormatter class="com.raritantechnologies.classifier.ClassifierWebServiceClient"
                     targetURI="[ SOAP source ]"
                     resultXMLField="[ optional field in source result that has XML data to be classified ]"
                     nestedClassificationField="[ optional field that gets nested classifier results ]" >

    <Fields>
      <!-- One or more Field elements: -->
      <Field classifierField="[ field in classifier result ]"  fieldID="[ field in formatted result output ]" 
                multiple="[true|false( default ) ]" />
    </Fields>

  </FieldFormatter>
 

Creates the following SOAP request format:

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Fields inherited from interface com.raritantechnologies.searchApp.IResultSetFilter

TEMPLATE

Constructor Summary

ClassifierWebServiceClient()

Method Summary

void	dataComplete() Data feed is complete.
IResultSet	filterResultSet(java.lang.String sessionID, IResultSet data) Filters the IResultSet by adding classification fields.
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	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
java.lang.String	getFieldName() Returns the name of the result field that this formatter can reformat.
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.
void	initialize(java.util.Map initParams) Dynamic initialization.
void	processResultSet(java.lang.String sessionID, IResultSet data) processes the IResultSet (somehow)
void	setSessionID(java.lang.String sessionID)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassifierWebServiceClient

public ClassifierWebServiceClient()

Method Detail

filterResultSet

public IResultSet filterResultSet(java.lang.String sessionID,
                                  IResultSet data)

Filters the IResultSet by adding classification fields.

Specified by:

filterResultSet in interface IResultSetFilter

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

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.

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.

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.

dataComplete

public void dataComplete()

Description copied from interface: IResultSetProcessor

Data feed is complete.

Specified by:

dataComplete in interface IResultSetProcessor

setSessionID

public void setSessionID(java.lang.String sessionID)

initialize

public void initialize(java.util.Map initParams)

Description copied from interface: IResultSetProcessor

Dynamic initialization.

Specified by:

initialize in interface IResultSetProcessor

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

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IFieldFormatter

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)

Specified by:

getConfigurationXML in interface IFieldFormatter