Regain 1.7.7-STABLE API

net.sf.regain.crawler.config
Class WhiteListEntry

java.lang.Object
  extended by net.sf.regain.crawler.config.WhiteListEntry

public class WhiteListEntry
extends Object

Ein Eintrag in der Weißen Liste.

Die Wei�e Liste enthält Präfixe, von denen eine URL einen haben mu�, um bearbeitet zu werden.

Des weiteren wird durch die Wei�e Liste festgelegt, welche Teile des Index vom Crawler bearbeitet werden sollen.

Author:
Til Schneider, www.murfman.de

Field Summary
private  String mName
          The name of the white list entry.
private  boolean mShouldBeUpdated
          Specifies whether the crawler should update URLs that match to this entry.
private  UrlMatcher mUrlMatcher
          The UrlMatcher a URL must match to in order to be processed.
 
Constructor Summary
WhiteListEntry(UrlMatcher urlMatcher, String name)
          Creates a new instance of WhiteListEntry.
 
Method Summary
 String getName()
          Gets the name of the white list entry.
 UrlMatcher getUrlMatcher()
          Gets the UrlMatcher a URL must match to in order to be processed.
 void setShouldBeUpdated(boolean shouldBeUpdated)
          Sets whether the crawler should update URLs that match to this entry.
 boolean shouldBeUpdated()
          Gets whether the crawler should update URLs that match to this entry.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mUrlMatcher

private UrlMatcher mUrlMatcher
The UrlMatcher a URL must match to in order to be processed.


mName

private String mName
The name of the white list entry. May be null.


mShouldBeUpdated

private boolean mShouldBeUpdated
Specifies whether the crawler should update URLs that match to this entry.

Constructor Detail

WhiteListEntry

public WhiteListEntry(UrlMatcher urlMatcher,
                      String name)
Creates a new instance of WhiteListEntry.

Parameters:
urlMatcher - The UrlMatcher a URL must match to in order to be processed.
name - The name of the white list entry. May be null.
Method Detail

getUrlMatcher

public UrlMatcher getUrlMatcher()
Gets the UrlMatcher a URL must match to in order to be processed.

Returns:
The UrlMatcher a URL must match to in order to be processed..

getName

public String getName()
Gets the name of the white list entry. May be null.

Returns:
The name. May be null.

shouldBeUpdated

public boolean shouldBeUpdated()
Gets whether the crawler should update URLs that match to this entry.

Returns:
Whether the crawler should update URLs that match to this entry.

setShouldBeUpdated

public void setShouldBeUpdated(boolean shouldBeUpdated)
Sets whether the crawler should update URLs that match to this entry.

Parameters:
shouldBeUpdated - Whether the crawler should update URLs that match to this entry.

Regain 1.7.7-STABLE API

Regain 1.7.7-STABLE, Copyright (C) 2004-2010 Til Schneider, www.murfman.de, Thomas Tesche, www.clustersystems.info