com.raritantechnologies.dieselpoint.collection
Class DieselpointOutputProcessor

java.lang.Object
  extended bycom.raritantechnologies.dieselpoint.collection.DieselpointOutputProcessor
All Implemented Interfaces:
IGatewayOutputProcessor

public class DieselpointOutputProcessor
extends java.lang.Object
implements IGatewayOutputProcessor

Implementation of Raritan IGatewayOutputProcessor that indexes IResultSets into a Dieselpoint collection.

XML Collection Schema:
   <OutputProcessor class="com.raritantechnologies.dieselpoint.collection.DieselpointOutputProcessor" 
                       indexPath="[ file path to Dieselpoint collection ]"
                       newIndex="true(default)|false"
                       saveEachSet="true(default)|false" >

    <!-- Optional Param tags enable mapping of IResult fields to Dieselpoint fields -->
    <!-- Example 1 uses IResult field -->
    <Param name="[ field name in result ]" 
              fieldID="[ dieselpoint field name ]" 
              dataType="[ dieselpoint dataType ]" /> 

    <!-- Example 2 uses path in IResult XML rendering to get the field value-->
    <Param path="[ XML path to data in IResult ]" 
              fieldID="[ dieselpoint field name ]" 
              dataType="[ dieselpoint dataType ]" /> 

    <!-- Example 3 uses a filePath to import file data into a field -->
    <Param filePath="[ file path to data ]" 
              fileNameField="[ incoming resultID with fileName ]"
              fieldID="[ dieselpoint field name ]" 
              dataType="[ dieselpoint dataType ]" /> 

    <!-- Taxonomy fields require special treatment -->
    <Taxonomy fieldID="[ taxonomy field name ]"  
                 path="[ path within IResult XML to taxonomy path value]" 
                 startsWith="[ starting path for this taxonomy]" 
                 multiple="true|false" 
                 nested="true|false" 
                 startAfter="true|false ( determines if 'startsWith' should be part of path)" />

  </OutputProcessor>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Constructor Summary
DieselpointOutputProcessor()
           
 
Method Summary
 void addNameParameter(java.lang.String name, java.lang.String fieldID, java.lang.String dataType)
           
 void addPathParameter(java.lang.String path, java.lang.String fieldID, java.lang.String dataType)
           
 void addTaxonomyParameter(java.lang.String fieldID, java.lang.String path, java.lang.String startsWith, boolean multiple, boolean nested, boolean startAfter)
           
 void dataComplete()
          Data feed is complete.
 java.lang.String getConfigurationXML()
           
 void getConfigurationXML(java.io.Writer writer)
           
 java.lang.String getIndexPath()
           
 void initialize(org.w3c.dom.Element outputProcElem, ISearchFieldMap sfMap)
          Initialize the GatewayOutputProcessor from XML Element.
 void initialize(java.util.Map initParams)
          Used for dynamic initialization (connection, collection name, file name, etc.)
 java.lang.String processData(IResultSet data)
          returns name of XML File created/appended.
 void setIndexPath(java.lang.String indexPath)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DieselpointOutputProcessor

public DieselpointOutputProcessor()
Method Detail

processData

public java.lang.String processData(IResultSet data)
Description copied from interface: IGatewayOutputProcessor
returns name of XML File created/appended.

Specified by:
processData in interface IGatewayOutputProcessor

dataComplete

public void dataComplete()
Description copied from interface: IGatewayOutputProcessor
Data feed is complete.

Specified by:
dataComplete in interface IGatewayOutputProcessor

initialize

public void initialize(java.util.Map initParams)
Description copied from interface: IGatewayOutputProcessor
Used for dynamic initialization (connection, collection name, file name, etc.)

Specified by:
initialize in interface IGatewayOutputProcessor

initialize

public void initialize(org.w3c.dom.Element outputProcElem,
                       ISearchFieldMap sfMap)
Initialize the GatewayOutputProcessor from XML Element.

Specified by:
initialize in interface IGatewayOutputProcessor

setIndexPath

public void setIndexPath(java.lang.String indexPath)

getIndexPath

public java.lang.String getIndexPath()

addNameParameter

public void addNameParameter(java.lang.String name,
                             java.lang.String fieldID,
                             java.lang.String dataType)

addPathParameter

public void addPathParameter(java.lang.String path,
                             java.lang.String fieldID,
                             java.lang.String dataType)

addTaxonomyParameter

public void addTaxonomyParameter(java.lang.String fieldID,
                                 java.lang.String path,
                                 java.lang.String startsWith,
                                 boolean multiple,
                                 boolean nested,
                                 boolean startAfter)

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException
Throws:
java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()
Specified by:
getConfigurationXML in interface IGatewayOutputProcessor