org.webharvest.runtime.processors.plugins

Class FtpListPlugin

java.lang.Object

org.webharvest.runtime.processors.BaseProcessor

org.webharvest.runtime.processors.WebHarvestPlugin

org.webharvest.runtime.processors.plugins.FtpListPlugin

public class FtpListPlugin
extends WebHarvestPlugin

Ftp List plugin - can be used only inside ftp plugin for listing file in working remote directory.

Field Summary

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

elementDef

Constructor Summary

Constructors

Constructor and Description
FtpListPlugin()

Method Summary

Modifier and Type	Method and Description
Variable	executePlugin(Scraper scraper, ScraperContext context) Mathod that actually executes processor.
String[]	getAttributeValueSuggestions(String attributeName)
String	getName() Defines name of the processor.
String[]	getRequiredAttributes() This method should return all mandatory attribute names for the plugin processor.
String[]	getValidAttributes() This method should return all possible attribute names for the plugin processor.
boolean	hasBody()

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

evaluateAttribute, evaluateAttributeAsBoolean, evaluateAttributeAsDouble, evaluateAttributeAsInteger, execute, executeBody, getAttributeDesc, getAttributes, getDependantProcessors, getRequiredSubprocessors, getTagDesc, getValidSubprocessors, setDef

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

FtpListPlugin

public FtpListPlugin()

Method Detail

getName

public String getName()

Description copied from class: WebHarvestPlugin

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>

Specified by:

getName in class WebHarvestPlugin

Returns:

Name of the processor

executePlugin

public Variable executePlugin(Scraper scraper,
                              ScraperContext context)

Description copied from class: WebHarvestPlugin

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.

Specified by:

executePlugin in class WebHarvestPlugin

Returns:

Instance of variable as result of xecution.

getValidAttributes

public String[] getValidAttributes()

Description copied from class: WebHarvestPlugin

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

Overrides:

getValidAttributes in class WebHarvestPlugin

Returns:

Array of attribute names (case insensitive)

getRequiredAttributes

public String[] getRequiredAttributes()

Description copied from class: WebHarvestPlugin

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

Overrides:

getRequiredAttributes in class WebHarvestPlugin

Returns:

Array of attribute names (case insensitive)

hasBody

public boolean hasBody()

Overrides:

hasBody in class WebHarvestPlugin

getAttributeValueSuggestions

public String[] getAttributeValueSuggestions(String attributeName)

Overrides:

getAttributeValueSuggestions in class WebHarvestPlugin

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.