com.raritantechnologies.endeca.pipeline
Class FieldFormatterManipulator

java.lang.Object
  com.raritantechnologies.endeca.pipeline.FieldFormatterManipulator

All Implemented Interfaces:

IConfigurable, IJavaManipulator

public class FieldFormatterManipulator

extends java.lang.Object

implements IJavaManipulator

Uses an RTI IFieldFormatter to modify records in an Endeca Pipeline.

Uses an IFieldFormatter configured as a System Object:

  <SystemObject configurableClass="com.raritantechnologies.endeca.pipeline.FieldFormatterManipulator"
                name="[ name of Java Manipulator ]" 
                type="EndecaJavaAdapter"
                debugFields="[ optional list of fields that will print debug output ]" >

     <!-- The set of Endeca properties that will be used by the Raritan FieldFormatter -->
     <EndecaInputProperties>
       <Property name="[ name of Endeca Record Property ]" fieldID="[ optional field name of IResult ]" />
       <!--  etc. . . -->
     </EndecaInputProperties>

     <!-- The RTI IFieldFormatter to use to manipulate the Record -->
     <FieldFormatter class="[ class of com.raritantechnologies.searchApp.IFieldFormatter ]" >

     </FieldFormatter>

     <!-- Properties to put into the record after formatting -->
     <EndecaOutputProperties>
       <Property fieldID="[ name of IResult field ]" name="[ name of Record property to add to the Record ]" />
     </EndecaOutputProperties>

  </SystemObject>
 

This Java Manipulator uses a Raritan IFieldFormatter to add properties to Endeca records.

Developed by Raritan Technologies Inc..

Author:

Pat Crabtree

Constructor Summary

FieldFormatterManipulator()

Method Summary

void	execute(AdapterConfig config, AdapterHandler handler) execute the Endeca Pipeline Manipulator method: Converts each Endeca Record into an RTI IResult instance, formats the record using an IFieldFormatter and adds any new fields to the Endeca Record.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	pipelineDone()
Record	process(Record rec)

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldFormatterManipulator

public FieldFormatterManipulator()

Method Detail

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

execute

public void execute(AdapterConfig config,
                    AdapterHandler handler)
             throws AdapterException

execute the Endeca Pipeline Manipulator method: Converts each Endeca Record into an RTI IResult instance, formats the record using an IFieldFormatter and adds any new fields to the Endeca Record.

Specified by:

execute in interface IJavaManipulator

Throws:

AdapterException

process

public Record process(Record rec)

Specified by:

process in interface IJavaManipulator

pipelineDone

public void pipelineDone()

Specified by:

pipelineDone in interface IJavaManipulator