net.sf.regain.crawler.config
Class PreparatorSettings

java.lang.Object
  net.sf.regain.crawler.config.PreparatorSettings

public class PreparatorSettings
extends Object

The settings of a preparator

Author:

Til Schneider, www.murfman.de

See Also:

Preparator

Field Summary

static String	DEFAULT_PREPARATOR_PACKAGE The default preparator package.
private boolean	mIsEnabled Specifies whether the preparator is enabled.
private String	mPreparatorClassName The class name of the preparator.
private PreparatorConfig	mPreparatorConfig The configuration of the preparator.
private int	mPriority Specifies the priority of the preparator
private String	mUrlRegex The regular expression a URL must match to, to be prepared by this preparator.

Constructor Summary

PreparatorSettings(boolean isEnabled, int priority, String preparatorClassName, String urlRegex, PreparatorConfig preparatorConfig)
Creates a new instance of PreparatorSettings.

Method Summary

String	getPreparatorClassName() Gets the class name of the preparator.
PreparatorConfig	getPreparatorConfig() Gets the configuration of the preparator.
int	getPriority() Gets the priority of the preparator
String	getUrlRegex() Gets the regular expression a URL must match to, to be prepared this preparator.
boolean	isEnabled() Gets whether the preparator is enabled.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PREPARATOR_PACKAGE

public static final String DEFAULT_PREPARATOR_PACKAGE

The default preparator package.

See Also:

Constant Field Values

mIsEnabled

private boolean mIsEnabled

Specifies whether the preparator is enabled.

mPriority

private int mPriority

Specifies the priority of the preparator

mPreparatorClassName

private String mPreparatorClassName

The class name of the preparator. The class must implement Preparator.

mUrlRegex

private String mUrlRegex

The regular expression a URL must match to, to be prepared by this preparator.

mPreparatorConfig

private PreparatorConfig mPreparatorConfig

The configuration of the preparator.

Constructor Detail

PreparatorSettings

public PreparatorSettings(boolean isEnabled,
                          int priority,
                          String preparatorClassName,
                          String urlRegex,
                          PreparatorConfig preparatorConfig)

Creates a new instance of PreparatorSettings.

Parameters:

isEnabled - Specifies whether the preparator is enabled.

preparatorClassName - The class name of the preparator. The class must implement Preparator.

urlRegex - The regular expression a URL must match to, to be prepared by this preparator. If null the default regex of the preparator should be used.

preparatorConfig - The configuration of the preparator.

Method Detail

isEnabled

public boolean isEnabled()

Gets whether the preparator is enabled.

Returns:

Whether the preparator is enabled.

getPreparatorClassName

public String getPreparatorClassName()

Gets the class name of the preparator.

Returns:

The class name of the preparator.

getUrlRegex

public String getUrlRegex()

Gets the regular expression a URL must match to, to be prepared this preparator.

Returns:

The regular expression a URL must match to, to be prepared by this preparator. If null the default regex of the preparator should be used.

getPreparatorConfig

public PreparatorConfig getPreparatorConfig()

Gets the configuration of the preparator.

Returns:

The configuration of the preparator.

getPriority

public int getPriority()

Gets the priority of the preparator

Returns:

The priority as int. 0 is the default value