com.raritantechnologies.clearforest
Class ClearForestResultFieldFormatter

java.lang.Object
  com.raritantechnologies.clearforest.ClearForestResultFieldFormatter

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class ClearForestResultFieldFormatter

extends java.lang.Object

implements IFieldFormatter

Applies ClearForest tags to another result field using an ITagWriter.

XML Configuration Template:

   <FieldFormatter class="com.raritantechnologies.clearforest.ClearForestResultFieldFormatter"
                      clfTagsField="[ result field with ClearForest tags ]"
                      sourceField="[ result field with document source ]" >
  
        <EntityMap>
            <Entity name="[ entity name ]" 
                       baseURL="[ the URL ]" 
                       param="[ name of entity parameter ]" 
                       class="[ entity type ]"
                       matchPartialPhrase="[ true|false ]" />
        </EntityMap>

       <TagWriter class="[ class of com.raritantechnologies.utils.tagging.ITagWriter ]" >

       </TagWriter>

   </FieldFormatter>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

ClearForestResultFieldFormatter()

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	getClearForestTagsField()
ClearForestTermExtractor	getClearForestTermExtractor()
java.lang.String	getConfigurationXML()
void	getConfigurationXML(java.io.Writer writer)
java.lang.String	getFieldName() Returns the name of the result field that this formatter can reformat.
java.lang.String	getSourceField()
ITagWriter	getTagWriter()
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.
void	setClearForestTagsField(java.lang.String cfTagsField)
void	setClearForestTermExtractor(ClearForestTermExtractor cfTermExtractor)
void	setSourceField(java.lang.String sourceField)
void	setTagWriter(ITagWriter tagWriter)

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

Constructor Detail

ClearForestResultFieldFormatter

public ClearForestResultFieldFormatter()

Method Detail

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

setClearForestTermExtractor

public void setClearForestTermExtractor(ClearForestTermExtractor cfTermExtractor)

getClearForestTermExtractor

public ClearForestTermExtractor getClearForestTermExtractor()

setTagWriter

public void setTagWriter(ITagWriter tagWriter)

getTagWriter

public ITagWriter getTagWriter()

setClearForestTagsField

public void setClearForestTagsField(java.lang.String cfTagsField)

getClearForestTagsField

public java.lang.String getClearForestTagsField()

setSourceField

public void setSourceField(java.lang.String sourceField)

getSourceField

public java.lang.String getSourceField()

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IFieldFormatter