com.screenscraper.scraper

Class ScriptContext

java.lang.Object

com.screenscraper.scraper.ScriptContext

public class ScriptContext
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ScriptContext.ScriptRunner

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
ScriptContext() Sets up a script context to be run standalone.
ScriptContext(RunningScrapingSession runningScrapingSession) Sets up a script context using the given running scraping session.

Method Summary

Modifier and Type	Method and Description
DataRecord	getDataRecord() Get the current data record.
DataSet	getDataSet() Gets the current data set.
java.lang.String	getExtractorPatternName()
bsh.Interpreter	getInterpreter() Gets a reference to the Interpreter used by BeanShell.
RunningScrapeableFile	getRunningScrapeableFile() Get the current ScrapeableFile.
RunningScrapingSession	getRunningScrapingSession() Gets the current RunningScrapingSession.
Script	getScript() Gets the script that should be executed.
void	process() Processes the script.
void	resetContextVariables() Rests context variables to null.
void	setCommandLineParams(CommandLineParams commandLineParams) Set the current command-line parameters.
void	setDataRecord(DataRecord dataRecord) Sets the current data set.
void	setDataSet(DataSet dataSet) Sets the current extracted data.
void	setExtractorPatternName(java.lang.String name) Sets the current extractorPatternName to the given String.
void	setHTTPSession(HTTPSession httpSession) Set the current HTTPSession.
void	setInterpreter(bsh.Interpreter interpreter) Sets a reference to the Interpreter used by BeanShell.
void	setRunningHTTPRequest(RunningHTTPRequest httpRequest) Set the current HTTPRequest.
void	setRunningHTTPResponse(RunningHTTPResponse httpResponse) Set the current HTTPResponse.
void	setRunningScrapeableFile(RunningScrapeableFile scrapeableFile) Set the current ScrapeableFile.
void	setScript(Script script) Sets the script that should be executed.
void	terminate() Ends the execution of this script pre-maturely.
void	unsetVariables() Unsets the current variables.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

ScriptContext

public ScriptContext()

Sets up a script context to be run standalone.

ScriptContext

public ScriptContext(RunningScrapingSession runningScrapingSession)

Sets up a script context using the given running scraping session.

Parameters:

runningScrapingSession - The current RunningScrapingSession.

Method Detail

getScript

@Nullable
public Script getScript()

Gets the script that should be executed.

Returns:

The script.

setScript

public void setScript(Script script)

Sets the script that should be executed.

Parameters:

script - The script.

getDataRecord

@Nullable
public DataRecord getDataRecord()

Get the current data record.

Returns:

The DataRecord.

setDataRecord

public void setDataRecord(DataRecord dataRecord)

Sets the current data set.

Parameters:

dataRecord - The data set.

getDataSet

@Nullable
public DataSet getDataSet()

Gets the current data set.

Returns:

The DataSet.

setDataSet

public void setDataSet(DataSet dataSet)

Sets the current extracted data.

Parameters:

dataSet - The extracted data.

getRunningScrapingSession

@Nullable
public RunningScrapingSession getRunningScrapingSession()

Gets the current RunningScrapingSession.

Returns:

A RunningScrapingSession.

getRunningScrapeableFile

@Nullable
public RunningScrapeableFile getRunningScrapeableFile()

Get the current ScrapeableFile.

Returns:

The ScrapeableFile.

setRunningScrapeableFile

public void setRunningScrapeableFile(RunningScrapeableFile scrapeableFile)

Set the current ScrapeableFile.

Parameters:

scrapeableFile - The ScrapeableFile.

setRunningHTTPRequest

public void setRunningHTTPRequest(RunningHTTPRequest httpRequest)

Set the current HTTPRequest.

Parameters:

httpRequest - The HTTPRequest.

setRunningHTTPResponse

public void setRunningHTTPResponse(RunningHTTPResponse httpResponse)

Set the current HTTPResponse.

Parameters:

httpResponse - The HTTPResponse.

setHTTPSession

public void setHTTPSession(HTTPSession httpSession)

Set the current HTTPSession.

Parameters:

httpSession - The HTTPSession.

setExtractorPatternName

public void setExtractorPatternName(java.lang.String name)

Sets the current extractorPatternName to the given String.

Parameters:

name - the name of the extractor pattern.

getExtractorPatternName

@Nullable
public java.lang.String getExtractorPatternName()

Returns:

The current extractorPatternName.

setCommandLineParams

public void setCommandLineParams(CommandLineParams commandLineParams)

Set the current command-line parameters. Note that this will only be used for the first script that gets executed when screen-scraper is run from the command-line using the runScript option.

Parameters:

commandLineParams - The command-line parameters.

getInterpreter

@Nullable
public bsh.Interpreter getInterpreter()

Gets a reference to the Interpreter used by BeanShell.

Returns:

An Interpreter object.

setInterpreter

public void setInterpreter(bsh.Interpreter interpreter)

Sets a reference to the Interpreter used by BeanShell.

Parameters:

interpreter - An Interpreter object.

resetContextVariables

public void resetContextVariables()

Rests context variables to null.

terminate

public void terminate()

Ends the execution of this script pre-maturely.

process

public void process()
             throws ScriptException

Processes the script.

Throws:

ScriptException

unsetVariables

public void unsetVariables()

Unsets the current variables.