com.raritantechnologies.endeca.pipeline
Class OutputProcessorAdapter

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

All Implemented Interfaces:

IConfigurable, IJavaManipulator

public class OutputProcessorAdapter

extends java.lang.Object

implements IJavaManipulator

Endeca Java Manipulator that enables data flowing in an Endeca Pipeline to be processed and output to an RTI IGatewayOutputProcessor.

XML Configuration Template:

  <SystemObject configurableClass="com.raritantechnologies.endeca.pipeline.OutputProcessorAdapter"
                name="[ name of Java Adapter ]" 
                type="EndecaJavaAdapter"
                batchSize="[ size of record batch to accumulate before sending to OutputProcessor (default = 50) ]"
                asynchronous="[ true|false( default ) ]"
                debug="[ true | false (default) | one or more of code|timing|memory; Optional debug flag, code and true both turn code debugging on]"
                queueSize="[ maximum size of aynchronous queue buffer - (default = 1000) ]"
                debugFields="[ optional list of fields that will print debug output ]" >

    <!-- Describes how Endeca properties map to Result fields -->
    <EndecaInputProperties>
      <!-- One or more Property tags: -->
      <Property name="[ name of Property in Endeca Index ]" fieldID="[ output field ID for RTI OutputProcessor ]" />
      <!-- etc ... -->
    </EndecaInputProperties>

    <!-- Optional IResultSetFilter -->
    <ResultSetFilter class="[ class of com.raritantechnologies.searchApp.IResultSetFilter ]" >

    </ResultSetFilter>

    <OutputProcessor class="[ class of com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor ]" >

    </OutputProcessor>

  </SystemObject>
 

Constructor Summary

OutputProcessorAdapter()

Method Summary

void	execute(AdapterConfig config, AdapterHandler handler) execute the Endeca Pipeline Manipulator method: Converts each Endeca Record into an RTI IResult instance.
protected void	finalize()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	pipelineDone()
Record	process(Record rec) Processes an Endeca Record by converting it to an RTI IResult and submitting it to the OutputProcessor
void	setDEBUG(java.lang.String debugSt)

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputProcessorAdapter

public OutputProcessorAdapter()

Method Detail

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. sends collected results to an IGatewayOutputProcessor...

Specified by:

execute in interface IJavaManipulator

Throws:

AdapterException

process

public Record process(Record rec)

Processes an Endeca Record by converting it to an RTI IResult and submitting it to the OutputProcessor

Specified by:

process in interface IJavaManipulator

pipelineDone

public void pipelineDone()

Specified by:

pipelineDone in interface IJavaManipulator

finalize

protected void finalize()

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

setDEBUG

public void setDEBUG(java.lang.String debugSt)