com.norconex.collector.core.spoil.impl

Class GenericSpoiledReferenceStrategizer

java.lang.Object

com.norconex.collector.core.spoil.impl.GenericSpoiledReferenceStrategizer

All Implemented Interfaces:

ISpoiledReferenceStrategizer, IXMLConfigurable

public class GenericSpoiledReferenceStrategizer
extends Object
implements ISpoiledReferenceStrategizer, IXMLConfigurable

Generic implementation of ISpoiledReferenceStrategizer that offers a simple mapping between the crawl state of references that have turned "bad" and the strategy to adopt for each. Whenever a crawl state does not have a strategy associated, the fall-back strategy is used (default being DELETE).

The mappings defined by default are as follow:

Crawl state	Strategy
NOT_FOUND	DELETE
BAD_STATUS	GRACE_ONCE
ERROR	GRACE_ONCE

XML configuration usage:

  <spoiledReferenceStrategizer 
      class="com.norconex.collector.core.spoil.impl.GenericSpoiledReferenceStrategizer"
      fallbackStrategy="[DELETE|GRACE_ONCE|IGNORE]">
    <mapping state="(any crawl state)" strategy="[DELETE|GRACE_ONCE|IGNORE]" />
    (repeat mapping tag as needed)
  </spoiledReferenceStrategizer>
 

Usage example:

The following indicates we should ignore (do nothing) errors processing documents, and send a deletion request if they are not found or have resulted in a bad status.

  <spoiledReferenceStrategizer 
      class="com.norconex.collector.core.spoil.impl.GenericSpoiledReferenceStrategizer">
    <mapping state="NOT_FOUND" strategy="DELETE" />
    <mapping state="BAD_STATUS" strategy="DELETE" />
    <mapping state="ERROR" strategy="IGNORE" />
  </spoiledReferenceStrategizer>
 

Since:

1.2.0

Author:

Pascal Essiembre

Field Summary

Fields

Modifier and Type	Field and Description
static SpoiledReferenceStrategy	DEFAULT_FALLBACK_STRATEGY

Constructor Summary

Constructors

Constructor and Description
GenericSpoiledReferenceStrategizer()

Method Summary

Modifier and Type	Method and Description
void	addMapping(CrawlState state, SpoiledReferenceStrategy strategy)
boolean	equals(Object other)
SpoiledReferenceStrategy	getFallbackStrategy()
int	hashCode()
void	loadFromXML(Reader in)
SpoiledReferenceStrategy	resolveSpoiledReferenceStrategy(String reference, CrawlState state) Establish which spoiled reference strategy to adopt.
void	saveToXML(Writer out)
void	setFallbackStrategy(SpoiledReferenceStrategy fallbackStrategy)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_FALLBACK_STRATEGY

public static final SpoiledReferenceStrategy DEFAULT_FALLBACK_STRATEGY

Constructor Detail

GenericSpoiledReferenceStrategizer

public GenericSpoiledReferenceStrategizer()

Method Detail

resolveSpoiledReferenceStrategy

public SpoiledReferenceStrategy resolveSpoiledReferenceStrategy(String reference,
                                                                CrawlState state)

Description copied from interface: ISpoiledReferenceStrategizer

Establish which spoiled reference strategy to adopt.

Specified by:

resolveSpoiledReferenceStrategy in interface ISpoiledReferenceStrategizer

Parameters:

reference - a document reference

state - the reference crawl state to evaluate

Returns:

a spoiled reference strategy

getFallbackStrategy

public SpoiledReferenceStrategy getFallbackStrategy()

setFallbackStrategy

public void setFallbackStrategy(SpoiledReferenceStrategy fallbackStrategy)

addMapping

public void addMapping(CrawlState state,
                       SpoiledReferenceStrategy strategy)

loadFromXML

public void loadFromXML(Reader in)
                 throws IOException

Specified by:

loadFromXML in interface IXMLConfigurable

Throws:

IOException

saveToXML

public void saveToXML(Writer out)
               throws IOException

Specified by:

saveToXML in interface IXMLConfigurable

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object