Package org.apache.nutch.indexer.subcollection

Class SubcollectionIndexingFilter

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.nutch.indexer.subcollection.SubcollectionIndexingFilter

All Implemented Interfaces:

Configurable, IndexingFilter, Pluggable

public class SubcollectionIndexingFilter
extends Configured
implements IndexingFilter

Field Summary

Fields

Modifier and Type	Field	Description
static String	fieldName	Doc field name
static String	metadataSource	Metadata source field name

Fields inherited from interface org.apache.nutch.indexer.IndexingFilter

X_POINT_ID

Constructor Summary

Constructors

Constructor	Description
SubcollectionIndexingFilter()
SubcollectionIndexingFilter(Configuration conf)

Method Summary

Modifier and Type	Method	Description
NutchDocument	filter(NutchDocument doc, Parse parse, Text url, CrawlDatum datum, Inlinks inlinks)	Adds fields or otherwise modifies the document that will be indexed for a parse.
Configuration	getConf()
void	setConf(Configuration conf)

Methods inherited from class java.lang.Object

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

Field Details

fieldName

public static String fieldName

Doc field name

metadataSource

public static String metadataSource

Metadata source field name

Constructor Details

SubcollectionIndexingFilter

public SubcollectionIndexingFilter()

SubcollectionIndexingFilter

public SubcollectionIndexingFilter(Configuration conf)

Method Details

setConf

public void setConf(Configuration conf)

Specified by:

setConf in interface Configurable

Overrides:

setConf in class Configured

Parameters:

conf - A populated Configuration

getConf

public Configuration getConf()

Specified by:

getConf in interface Configurable

Overrides:

getConf in class Configured

Returns:

Configuration

filter

public NutchDocument filter(NutchDocument doc,
 Parse parse,
 Text url,
 CrawlDatum datum,
 Inlinks inlinks)
                     throws IndexingException

Description copied from interface: IndexingFilter

Adds fields or otherwise modifies the document that will be indexed for a parse. Unwanted documents can be removed from indexing by returning a null value.

Specified by:

filter in interface IndexingFilter

Parameters:

doc - document instance for collecting fields

parse - parse data instance

url - page url

datum - crawl datum for the page (fetch datum from segment containing fetch status and fetch time)

inlinks - page inlinks

Returns:

modified (or a new) document instance, or null (meaning the document should be discarded)

Throws:

IndexingException - if an error occurs during during filtering