com.raritantechnologies.webdav
Class WebDAVFormatter

java.lang.Object
  com.raritantechnologies.webdav.WebDAVFormatter

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class WebDAVFormatter

extends java.lang.Object

implements IFieldFormatter

Uses a WebDAV connection to retrieve WebDAV Properties to be added to a result's metadata field set.

XML Configuration Template:

   <FieldFormatter class="com.raritantechnologies.webdav.WebDAVFormatter"
                      baseWebDavURL="[ base URL for connecting to the WebDAV server ]" >

     <!-- Set of result field/values that will be used to construct the WebDAV URL -->
     <RequestFields>
       <!-- one or more Field elements: -->
       <Field ID="[ result field ID ]" webDavField="[ field to add to http request ]" />
     </RequestFields>

     <!-- Set of WebDav resource properties that will be added to the IResult field data -->
     <ResponseFields>
       <!-- one or more Field elements: -->
       <Field ID="[ result field ID ]" webDavField="[ WebDAV property name ]" />
     </ResponseFields>

   </FieldFormatter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

WebDAVFormatter()

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.
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.

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

WebDAVFormatter

public WebDAVFormatter()

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