BIFOutputProcessor

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.raritantechnologies.verity.collection
Class BIFOutputProcessor

java.lang.Object
  com.raritantechnologies.verity.collection.BIFOutputProcessor

All Implemented Interfaces:: ICollectionIndexer, IConfigurable, IGatewayOutputProcessor, IResultSetProcessor

public class BIFOutputProcessor
extends java.lang.Object
implements IGatewayOutputProcessor, IResultSetProcessor, IConfigurable, ICollectionIndexer

Processes ICollectionGateway results. Creates XML file(s) with the records, Verity Bulk Insert Format BIF file(s) and a command file for the Verity mkvdk collection build shell program.

BIFOutputProcessor also generates a set of style files using a set of style templates. It generates new style.ufl, style.zon and style.xml files. It uses the StyleFileGenerator class to do this.

XML Configuration Template:

 <GatewayOutputProcessor class="com.raritantechnologies.verity.collection.BIFOutputProcessor"
        commandFile="BASE_PATH/BuildIt.bat"
        resultXMLField="documentXML"
        fullTextFieldID="[result field ID for full text URL]"
        maxRecords="5000"
        writeXMLFiles="true(default)|false"
        removeNewLines="true(default)|false"
        updateMode="true|false(default)"
        createCollection="true|false(default)"
        gatewayType="FILE|HTTP|..." >

   <VeritySourceType>[ name of the Verity Collection reference SourceType ]</VeritySourceType>

   <DestinationPath>[ location where BIF Data will be stored ]</DestinationPath>
   <XMLIndexPath>[(Optional) location where BIFs will be Indexed FROM (may be different if BIF files are copied before indexing )]</XMLIndexPath>

   <BIFTransform>[ path to BIF Transform XSLT ]</BIFTransform>

   <StyleFileSource>[ path to style file templates ]</StyleFileSource>
   <StyleFileDestination>[ path to destination style files ]</StyleFileDestination>

   <CollectionName>[ path to the Collection to be built ]</CollectionName>

   <!-- Optional String filter to filter XML before transforming -->
   <XMLFieldFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter]" >

   </XMLFieldFilter>

   <BifFields>
      <BifField name="name of field in BIF" >
         <SAXCallbackStringFilter callbackClass="[Programmable SAX Filter callback class]" >
           <!-- Callback filter fields -->
         </SAXCallbackFilter>
   </BifFields>

   <!-- Optional Dynamic Field Generators: -->
   <FieldGenerator class="[ class of com.raritantechnologies.verity.collection.IFieldGenerator]" >

   </FieldGenerator>

   <BIFProcessor class="[ class of com.raritantechnologies.verity.collection.IBIFProcessor ]" >

   </BIFProcessor>

 </GatewayOutputProcessor>

Developed by Raritan Technologies .

Author:: Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.dataCollection.ICollectionIndexer

ADD, CREATE, DELETE, UPDATE

Constructor Summary
`BIFOutputProcessor()`

Method Summary
`void`	`dataComplete()` Data feed is complete...
`java.lang.String`	`getConfigurationXML()`
`void`	`initialize(org.w3c.dom.Element outputProcElem)` Initialize the from XML Element.
`void`	`initialize(org.w3c.dom.Element outputProcElem, ISearchFieldMap sfMap)` Initialize the GatewayOutputProcessor from XML Configuration 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`	`processResultSet(java.lang.String sessionID, IResultSet data)` processes the IResultSet (somehow)
`void`	`setIndexMode(java.lang.String idxMode)`

Methods inherited from class java.lang.Object

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

Constructor Detail