org.webharvest.runtime.processors

Class WebHarvestPlugin

java.lang.Object

org.webharvest.runtime.processors.BaseProcessor

org.webharvest.runtime.processors.WebHarvestPlugin

Direct Known Subclasses:

DatabasePlugin, DbParamPlugin, FtpDelPlugin, FtpGetPlugin, FtpListPlugin, FtpMkdirPlugin, FtpPlugin, FtpPutPlugin, FtpRmdirPlugin, JsonToXmlPlugin, MailAttachPlugin, MailPlugin, TokenizePlugin, XmlToJsonPlugin, ZipEntryPlugin, ZipPlugin

public abstract class WebHarvestPlugin
extends BaseProcessor

Base for all user-defined plugins.

Field Summary

Fields inherited from class org.webharvest.runtime.processors.BaseProcessor

elementDef

Constructor Summary

Constructors

Constructor and Description
WebHarvestPlugin()

Method Summary

Modifier and Type	Method and Description
protected String	evaluateAttribute(String attName, Scraper scraper)
protected boolean	evaluateAttributeAsBoolean(String attName, boolean defaultValue, Scraper scraper)
protected double	evaluateAttributeAsDouble(String attName, double defaultValue, Scraper scraper)
protected int	evaluateAttributeAsInteger(String attName, int defaultValue, Scraper scraper)
Variable	execute(Scraper scraper, ScraperContext context)
protected Variable	executeBody(Scraper scraper, ScraperContext context) Executes body of plugin processor
abstract Variable	executePlugin(Scraper scraper, ScraperContext context) Mathod that actually executes processor.
String	getAttributeDesc()
protected Map	getAttributes()
String[]	getAttributeValueSuggestions(String attributeName)
Class[]	getDependantProcessors() Defines dependant subprocessors that are used inside this plugin and that will automatically be registered with this plugin.
abstract String	getName() Defines name of the processor.
String[]	getRequiredAttributes() This method should return all mandatory attribute names for the plugin processor.
String[]	getRequiredSubprocessors() This method should return all mandatory subprocessor names, or in other words all mandatory subtags that must be present in the body of this processor plugin.
String	getTagDesc()
String[]	getValidAttributes() This method should return all possible attribute names for the plugin processor.
String[]	getValidSubprocessors() This method should return all names of all allowed processors inside the body of this processor plugin.
boolean	hasBody()
void	setDef(WebHarvestPluginDef def)

Methods inherited from class org.webharvest.runtime.processors.BaseProcessor

debug, getBodyTextContent, getBodyTextContent, getBodyTextContent, getElementDef, getSubprocessors, run, setProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

WebHarvestPlugin

public WebHarvestPlugin()

Method Detail

getName

public abstract String getName()

Defines name of the processor. Should be valid identifier. Processor's tag will use this name. For example, if this name is "myprocessor" in config file it will be used as <myprocessor...>...</myprocessor>

Returns:

Name of the processor

getValidAttributes

public String[] getValidAttributes()

This method should return all possible attribute names for the plugin processor.

Returns:

Array of attribute names (case insensitive)

getRequiredAttributes

public String[] getRequiredAttributes()

This method should return all mandatory attribute names for the plugin processor.

Returns:

Array of attribute names (case insensitive)

getValidSubprocessors

public String[] getValidSubprocessors()

This method should return all names of all allowed processors inside the body of this processor plugin. If null is returned, then all subprocessors are allowed.

Returns:

Array of allowed subprocessor names (case insensitive)

getRequiredSubprocessors

public String[] getRequiredSubprocessors()

This method should return all mandatory subprocessor names, or in other words all mandatory subtags that must be present in the body of this processor plugin.

Returns:

Array of mandatory subprocessor names (case insensitive)

getDependantProcessors

public Class[] getDependantProcessors()

Defines dependant subprocessors that are used inside this plugin and that will automatically be registered with this plugin.

Returns:

Array of subprocessor classes

getAttributeValueSuggestions

public String[] getAttributeValueSuggestions(String attributeName)

Parameters:

attributeName - Name of plugin attribute

Returns:

Array of valuee suggestions for specified attribute (this is used for auto-complete feature in IDE). null means nothing to suggest.

hasBody

public boolean hasBody()

execute

public final Variable execute(Scraper scraper,
                              ScraperContext context)

Specified by:

execute in class BaseProcessor

executePlugin

public abstract Variable executePlugin(Scraper scraper,
                                       ScraperContext context)

Mathod that actually executes processor. Since one instance of this class may be used for multiple executions, creator of plugin is responsible for initiating local variables at the beginning of this method.

Parameters:

scraper -

context -

Returns:

Instance of variable as result of xecution.

getTagDesc

public String getTagDesc()

getAttributeDesc

public String getAttributeDesc()

setDef

public void setDef(WebHarvestPluginDef def)

getAttributes

protected Map getAttributes()

Returns:

Map of attributes of this plugin

evaluateAttribute

protected String evaluateAttribute(String attName,
                                   Scraper scraper)

Parameters:

attName - Name of attrubte

scraper -

Returns:

Value of specified attribute, or null if attribute doesn't exist

evaluateAttributeAsBoolean

protected boolean evaluateAttributeAsBoolean(String attName,
                                             boolean defaultValue,
                                             Scraper scraper)

Parameters:

attName - Name of attrubte

defaultValue -

scraper -

Returns:

Value of specified attribute as boolean, or default value if it cannot be recognized as valid boolean

evaluateAttributeAsInteger

protected int evaluateAttributeAsInteger(String attName,
                                         int defaultValue,
                                         Scraper scraper)

Parameters:

attName - Name of attrubte

defaultValue -

scraper -

Returns:

Value of specified attribute as integer, or default value if it cannot be recognized as valid integer

evaluateAttributeAsDouble

protected double evaluateAttributeAsDouble(String attName,
                                           double defaultValue,
                                           Scraper scraper)

Parameters:

attName - Name of attrubte

defaultValue -

scraper -

Returns:

Value of specified attribute as double, or default value if it cannot be recognized as valid double

executeBody

protected Variable executeBody(Scraper scraper,
                               ScraperContext context)

Executes body of plugin processor

Parameters:

scraper -

context -

Returns:

Instance of Variable