BrowseListOutputProcessor

Main

Javadoc

Example

Source

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.searchApp.browse
Class BrowseListOutputProcessor

java.lang.Object
  com.raritantechnologies.searchApp.browse.BrowseListOutputProcessor

All Implemented Interfaces:: IGatewayOutputProcessor

public class BrowseListOutputProcessor
extends java.lang.Object
implements IGatewayOutputProcessor

Creates a browse list from a set of RTI IResults as part of a ICollectionGateway initiated data collection / processing pipeline.

Includes a IBrowseListWriter to store the browse list output. Can contain a IResultMatcher to filter the results that generate browse list entries and a IStringFilter to filter the browse entries before adding them to the browse list and another string filter to transform the displayable format of the browse entry.

XML Configuration Template:

   <GatewayOutputProcessor class="com.raritantechnologies.searchApp.browse.BrowseListOutputProcessor"
                              resultField="[ result field that contains browse term(s) ]"
                              browseField="[ name of field in browse list (if omitted browseField == resultField ]"
                              searchSourceName="[ name of associated search source ]"
                              newBrowseList="true(default)|false"
                              oneCountPerRecord="true|false(default)" >

     <BrowseListWriter class="[ class of com.raritantechnologies.searchApp.browse.IBrowseListWriter ]" >

     </BrowseListWriter>

     <ResultMatcher class="[ class of com.raritantechnologies.searchApp.IResultMatcher" >

     </ResultMatcher>

     <!-- Optional String filter to transform the main term for sorting purposes -->
     <SortFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

     </SortFilter>

     <!-- Optional String filter to transform the main term -->
     <TermFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

     </TermFilter>

     <!-- Optional String filter to transform the term display -->
     <DisplayFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

     </DisplayFilter>

   </GatewayOutputProcessor>

Developed by Raritan Technologies .

Author:: Ted Sullivan

Constructor Summary
`BrowseListOutputProcessor()`

Method Summary
`void`	`dataComplete()` Data feed is complete.
`java.lang.String`	`getConfigurationXML()`
`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`	`setBrowseField(java.lang.String browseField)`
`void`	`setBrowseListWriter(IBrowseListWriter browseListWriter)`
`void`	`setResultField(java.lang.String resultField)`

Methods inherited from class java.lang.Object

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

Constructor Detail