com.raritantechnologies.searchApp.dataCollection
Class LinkVerifierGatewayFilter

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

All Implemented Interfaces:

ICollectionIndexer, IConfigurable, IGatewayOutputProcessor, IResultSetProcessor

Direct Known Subclasses:

ECommerceLinkVerifier

public class LinkVerifierGatewayFilter

extends GatewayProcessorFilter

'404' Checker as links are generated by Collection buildware - check for correctness (i.e. existence).

XML Configuration Template:

  <GatewayOutputProcessor class="com.raritantechnologies.verity.collection.LinkVerifierGatewayFilter"
                             userName="[userName to use for validation]"
                             password="[password to use for validation]"
                             logFile="[ where to log errors]"  
                             removeIfFail="[ true(default)|false ]" >

    <OutputProcessor class="[ class of com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor ]" >

        <!-- The Real output processor stuff . . . -->

    </OutputProcessor>

    <URLValidator class="[some implementation of IURLValidator]" >

    <!-- Defines the set of result fields to be checked for valid URLs -->
    <LinkFields>
      <LinkField fieldID="[regular fieldID]" statusField="[result field to put link status]" />

      <!-- XML type that uses result getXML( ) -->
      <LinkField >
         <!-- XMResultProcessor for links -->
         <XMLProcessorMap>

         </XMLProcessorMap>
      </LinkField>

      <!-- XML type that uses a result field for XML source -->
      <LinkField fieldID="[a fieldID]" xmlType="true" xmlField="[xmlField from Source]" statusField="[field for status]">
         <!-- XMResultProcessor for links -->
         <XMLProcessorMap>

         </XMLProcessorMap>
      </LinkField>
    </LinkFields>

    <LogFields delimiter="|">  <!-- Fields to put in log file for failed links -->
      <Field ID="an ID" />
      <Field ID="another ID" />
      <Field value="A fixed value" />
    </LogFields>
  </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

LinkVerifierGatewayFilter()

Method Summary

protected IResultSet	filterData(IResultSet data)
void	initialize(org.w3c.dom.Element outputProcElem, ISearchFieldMap sfMap) Initialize the GatewayOutputProcessor from XML Configuration Element.
protected boolean	resultOK(IResult res)

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

addOutputProcessor, addPostProcessor, dataComplete, 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

LinkVerifierGatewayFilter

public LinkVerifierGatewayFilter()

Method Detail

filterData

protected IResultSet filterData(IResultSet data)

Overrides:

filterData in class GatewayProcessorFilter

resultOK

protected boolean resultOK(IResult res)

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