com.raritantechnologies.searchApp.dataCollection
Class CollectionStatisticsCollector

java.lang.Object
  com.raritantechnologies.searchApp.dataCollection.GatewayProcessorFilter
      com.raritantechnologies.searchApp.dataCollection.CollectionStatisticsCollector

All Implemented Interfaces:

ICollectionIndexer, IConfigurable, IGatewayOutputProcessor, IResultSetProcessor

public class CollectionStatisticsCollector

extends GatewayProcessorFilter

Produces a flat file output of collection statistics. Can be used to collect a set of unique values

XML Configuration Template:

 <GatewayOutputProcessor class="com.raritantechnologies.searchApp.dataCollection.CollectionStatisticsCollector"
                            fileName="[ full path to output file ]" >

    <!-- One or more simple stat counters - count the number of occurrences of a matched result -->
    <Counter displayName="[ name of field for this statistic for true counts ]"
             falseName="[ name of field for this statistic for false counts ]" >
      <ResultMatcher class="[IResultMatcher class]" >

      </ResultMatcher>
    </Counter>

    <!-- One or more field counters: count number of occurrenes of field value for matched result -->
    <FieldCounter fieldName="[ name of field where values are associated with counts ]"
                     displayName="[ display name of field counter ]"
                     delimiter="[ delimter for multiple values ]" >

      <!-- Optional StringFilter to filter field values for normalizing before counting -->
      <FieldFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

      </FieldFilter>
 
      <Count name="[ display name of count ]" >
          <ResultMatcher class="[IResultMatcher class]" >

          </ResultMatcher>
      </Count>

      <OutputStatistic name="[ name of a count ]" criterion="[ZERO|EQUALS |GREATER THAN |LESS THAN  ]"
                          description="[ description of this statistic ]" />
    </FieldCounter>

    <!-- Proxy output processor -->
    <OutputProcessor class="[IGatewayOutputProcessor class]" >
      <!-- OutputProcessor details -->
    </OutputProcessor>

 </GatewayOutputProcessor>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.dataCollection.GatewayProcessorFilter

postProcessorFilters

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

ADD, CREATE, DELETE, UPDATE

Constructor Summary

CollectionStatisticsCollector()

Method Summary

void	dataComplete() Data feed is complete.
protected IResultSet	filterData(IResultSet data)
void	initialize(org.w3c.dom.Element outputProcElem, ISearchFieldMap sfMap) Initialize the GatewayOutputProcessor from XML Configuration Element.

Methods inherited from class com.raritantechnologies.searchApp.dataCollection.GatewayProcessorFilter

addOutputProcessor, addPostProcessor, filterResultSet, getConfigurationXML, initialize, initialize, processData, processResultSet, sendToOutput, setIndexMode, setResultMatcher, setUserMatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionStatisticsCollector

public CollectionStatisticsCollector()

Method Detail

filterData

protected IResultSet filterData(IResultSet data)

Overrides:

filterData in class GatewayProcessorFilter

dataComplete

public void dataComplete()

Description copied from class: GatewayProcessorFilter

Data feed is complete.

Specified by:

dataComplete in interface IGatewayOutputProcessor

Overrides:

dataComplete in class GatewayProcessorFilter

initialize

public void initialize(org.w3c.dom.Element outputProcElem,
                       ISearchFieldMap sfMap)

Description copied from interface: IGatewayOutputProcessor

Initialize the GatewayOutputProcessor from XML Configuration Element.

Specified by:

initialize in interface IGatewayOutputProcessor

Overrides:

initialize in class GatewayProcessorFilter