com.raritantechnologies.searchApp.formatters
Class PowerpointSlideFormatter

java.lang.Object
  com.raritantechnologies.searchApp.formatters.PowerpointSlideFormatter

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class PowerpointSlideFormatter

extends java.lang.Object

implements IFieldFormatter

Extracts individual slides from a Microsoft Powerpoint file. Adds them as a nested IResult field set.

XML Configuration Template:

    <Formatter 
        formatterClass="com.raritantechnologies.searchApp.formatters.PowerpointSlideFormatter" 
        fileNameField="[ name of field that contains PowerPoint slide file ]"  
        nestedResultField="[ name of field that gets the set of Slides as nested results ]"  
        slideFilePath="[ base path where individual slide images are written to ]"
        processSlides="[ true(default)|false - if true will process the files as a nested result set ]"
        concatenateSlideText="[ true(default) | false ]" >

    <-- Mapping of fields from POI field to IResult field -->
    <Fields>
      <Field ID="[ nested Result Field ]"    PoiField="[ POI Slide fields: notes | title | documentid | slideNumber | slideText ]" />
    </Fields>

    </Formatter>
 

Developed by Raritan Technologies .

Author:

Pat Crabtree

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

PowerpointSlideFormatter()

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 res) Formats a result field "in place".
void	formatResultField(java.lang.String sessionID, IResult res) 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.
static void	writeImageFile(java.lang.String pFileName, java.awt.image.BufferedImage content, boolean createDirectory)

Methods inherited from class java.lang.Object

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

Constructor Detail

PowerpointSlideFormatter

public PowerpointSlideFormatter()

Method Detail

formatResultField

public void formatResultField(IResult res)

Description copied from interface: IFieldFormatter

Formats a result field "in place".

Specified by:

formatResultField in interface IFieldFormatter

Parameters:

res - The result object that is to be formatted.

formatResultField

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

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.

res - The result object that is to be formatted.

writeImageFile

public static void writeImageFile(java.lang.String pFileName,
                                  java.awt.image.BufferedImage content,
                                  boolean createDirectory)

formatField

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

Reformats a field value.

Specified by:

formatField in interface IFieldFormatter

Parameters:

fieldVal - The field value to be reformatted.

Returns:

The reformatted field value.

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.

initialize

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

Initializes the formatter from configuration XML element.

Specified by:

initialize in interface IFieldFormatter

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

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