org.webharvest.runtime.processors

Class BaseProcessor

java.lang.Object

org.webharvest.runtime.processors.BaseProcessor

Direct Known Subclasses:

BodyProcessor, CallParamProcessor, CallProcessor, CaseProcessor, ConstantProcessor, EmptyProcessor, ExitProcessor, FileProcessor, FunctionProcessor, HtmlToXmlProcessor, HttpHeaderProcessor, HttpParamProcessor, HttpProcessor, IncludeProcessor, LoopProcessor, RegexpProcessor, ReturnProcessor, ScriptProcessor, TemplateProcessor, TextProcessor, TryProcessor, VarDefProcessor, VarProcessor, WebHarvestPlugin, WhileProcessor, XPathProcessor, XQueryProcessor, XsltProcessor

public abstract class BaseProcessor
extends Object

Base processor that contains common processor logic. All other processors extend this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseElementDef	elementDef

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseProcessor()
protected	BaseProcessor(BaseElementDef elementDef) Base constructor - assigns element definition to the processor.

Method Summary

Modifier and Type	Method and Description
protected void	debug(BaseElementDef elementDef, Scraper scraper, Variable variable)
abstract Variable	execute(Scraper scraper, ScraperContext context)
protected Variable	getBodyTextContent(BaseElementDef elementDef, Scraper scraper, ScraperContext context)
protected Variable	getBodyTextContent(BaseElementDef elementDef, Scraper scraper, ScraperContext context, boolean registerExecution)
protected Variable	getBodyTextContent(BaseElementDef elementDef, Scraper scraper, ScraperContext context, boolean registerExecution, KeyValuePair[] properties)
BaseElementDef	getElementDef()
protected BaseProcessor[]	getSubprocessors(Scraper scraper)
Variable	run(Scraper scraper, ScraperContext context) Wrapper for the execute method.
protected void	setProperty(String name, Object value) Defines processor runtime property with specified name and value.

Methods inherited from class java.lang.Object

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

Field Detail

elementDef

protected BaseElementDef elementDef

Constructor Detail

BaseProcessor

protected BaseProcessor()

BaseProcessor

protected BaseProcessor(BaseElementDef elementDef)

Base constructor - assigns element definition to the processor.

Parameters:

elementDef -

Method Detail

execute

public abstract Variable execute(Scraper scraper,
                                 ScraperContext context)

run

public Variable run(Scraper scraper,
                    ScraperContext context)

Wrapper for the execute method. Adds controling and logging logic.

setProperty

protected void setProperty(String name,
                           Object value)

Defines processor runtime property with specified name and value.

Parameters:

name -

value -

debug

protected void debug(BaseElementDef elementDef,
                     Scraper scraper,
                     Variable variable)

getBodyTextContent

protected Variable getBodyTextContent(BaseElementDef elementDef,
                                      Scraper scraper,
                                      ScraperContext context,
                                      boolean registerExecution,
                                      KeyValuePair[] properties)

getBodyTextContent

protected Variable getBodyTextContent(BaseElementDef elementDef,
                                      Scraper scraper,
                                      ScraperContext context,
                                      boolean registerExecution)

getBodyTextContent

protected Variable getBodyTextContent(BaseElementDef elementDef,
                                      Scraper scraper,
                                      ScraperContext context)

getSubprocessors

protected BaseProcessor[] getSubprocessors(Scraper scraper)

getElementDef

public BaseElementDef getElementDef()