com.raritantechnologies.endeca.pipeline
Class GatewayRecordAdapter

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

All Implemented Interfaces:

IConfigurable, IJavaManipulator

public class GatewayRecordAdapter

extends java.lang.Object

implements IJavaManipulator

RecordAdapter that uses a Raritan ICollectionGateway object to acquire data to be processed by the Endeca engine.

XML Configuration Template

  <SystemObject configurableClass="com.raritantechnologies.endeca.pipeline.GatewayRecordAdapter"
                name="[ name of Java Adapter ]" 
                type="EndecaJavaAdapter" > 

    <CollectionGateway class="[ class of com.raritantechnologies.searchApp.ICollectionGateway ]"
                          username="[ optional user name for collection gateway ]"
                          password="[ optional password ]" >

    </CollectionGateway>

    <!-- (optional) Properties map -->
    <EndecaRecordProperties>
      <Property name="[ Endeca record property ]" fieldID="[ optional RTI IResult field name ]" />
      <!-- etc... -->
    </EndecaRecordProperties>

  </SystemObject>
 

Constructor Summary

GatewayRecordAdapter()

Method Summary

void	execute(AdapterConfig config, AdapterHandler handler)
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

GatewayRecordAdapter

public GatewayRecordAdapter()

Method Detail

execute

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

Specified by:

execute in interface IJavaManipulator

Throws:

AdapterException

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

process

public Record process(Record rec)

Specified by:

process in interface IJavaManipulator

pipelineDone

public void pipelineDone()

Specified by:

pipelineDone in interface IJavaManipulator