com.screenscraper.scraper

Class ScriptInstance

java.lang.Object

com.screenscraper.scraper.ScriptInstance

All Implemented Interfaces:

java.lang.Comparable

public class ScriptInstance
extends java.lang.Object
implements java.lang.Comparable

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.
static int	WHENTORUN_AFTER_EACH_PATTERN_APPLICATION
static int	WHENTORUN_AFTER_FILE_IS_SCRAPED
static int	WHENTORUN_AFTER_HTTPREQUEST
static int	WHENTORUN_AFTER_HTTPRESPONSE
static int	WHENTORUN_AFTER_PATTERN_IS_APPLIED
static int	WHENTORUN_AFTER_SCRAPINGSESSION_ENDS
static int	WHENTORUN_ALWAYS_AT_THE_END
static int	WHENTORUN_BEFORE_ALL_HTTPTRANSACTIONS
static int	WHENTORUN_BEFORE_EACH_PATTERN_APPLICATION
static int	WHENTORUN_BEFORE_FILE_IS_SCRAPED
static int	WHENTORUN_BEFORE_HTTPREQUEST
static int	WHENTORUN_BEFORE_HTTPRESPONSE
static int	WHENTORUN_BEFORE_PATTERN_IS_APPLIED
static int	WHENTORUN_BEFORE_SCRAPINGSESSION_BEGINS Possible values for the whenToRun variable.
static int	WHENTORUN_ONCE_IF_NO_MATCHES
static int	WHENTORUN_ONCE_IF_PATTERN_MATCHES

Constructor Summary

Constructors

Constructor and Description
ScriptInstance() Required by castor.
ScriptInstance(ScriptInstance scriptInstance) Makes a script instance by copying another.
ScriptInstance(Script script, int whenToRun, int sequence, boolean enabled) Generates a new ScriptInstance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object sInstance) Allows these things to be sorted.
void	delete() Deletes this specific instance from the database.
void	deleteByContainerObject() Deletes the script instance from the database.
void	dumpToLog() Dumps the script instance to the log.
boolean	equals(java.lang.Object obj) We override this so that we can check for dupes.
int	getExtractorPatternID() Gets the ID of the extractor pattern associated with this script instance.
int	getHTTPSessionID() Gets the ID of the HTTP session associated with this script instance.
static java.lang.String	getHumanReadableFormOfWhenToRunValue(int whenToRun) Gets a human-friendly description of the given "WHENTORUN" value.
int	getScrapeableFileID() Gets the ID of the scrapeable file associated with this script instance.
int	getScrapingSessionID() Gets the ID of the scraping session associated with this script instance.
Script	getScript() Gets the script.
int	getSequence() Gets the sequence in which the script should be run.
int	getWhenToRun() Indicates when the script should be run.
boolean	isEnabled() Indicates whether or not this script instance is enabled.
void	save() Saves the script instance to the database.
void	setEnabled(boolean enabled) Determines whether or not this script instance is enabled.
void	setExtractorPatternID(int extractorPatternID) Sets the ID of the extractor pattern associated with this script instance.
void	setHTTPSessionID(int httpSessionID) Sets the ID of the HTTP session associated with this script instance.
void	setScrapeableFileID(int scrapeableFileID) Sets the ID of the scrapeable file associated with this script instance.
void	setScrapingSessionID(int scrapingSessionID) Sets the ID of the scraping session associated with this script instance.
void	setScript(Script script) Sets the script.
void	setSequence(int sequence) Sets the sequence in which the script should be run.
void	setWhenToRun(int whenToRun) Sets when the script should be run.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

WHENTORUN_BEFORE_SCRAPINGSESSION_BEGINS

public static final int WHENTORUN_BEFORE_SCRAPINGSESSION_BEGINS

Possible values for the whenToRun variable.

See Also:

Constant Field Values

WHENTORUN_AFTER_SCRAPINGSESSION_ENDS

public static final int WHENTORUN_AFTER_SCRAPINGSESSION_ENDS

See Also:

Constant Field Values

WHENTORUN_ALWAYS_AT_THE_END

public static final int WHENTORUN_ALWAYS_AT_THE_END

See Also:

Constant Field Values

WHENTORUN_BEFORE_FILE_IS_SCRAPED

public static final int WHENTORUN_BEFORE_FILE_IS_SCRAPED

See Also:

Constant Field Values

WHENTORUN_AFTER_FILE_IS_SCRAPED

public static final int WHENTORUN_AFTER_FILE_IS_SCRAPED

See Also:

Constant Field Values

WHENTORUN_BEFORE_PATTERN_IS_APPLIED

public static final int WHENTORUN_BEFORE_PATTERN_IS_APPLIED

See Also:

Constant Field Values

WHENTORUN_AFTER_PATTERN_IS_APPLIED

public static final int WHENTORUN_AFTER_PATTERN_IS_APPLIED

See Also:

Constant Field Values

WHENTORUN_BEFORE_EACH_PATTERN_APPLICATION

public static final int WHENTORUN_BEFORE_EACH_PATTERN_APPLICATION

See Also:

Constant Field Values

WHENTORUN_AFTER_EACH_PATTERN_APPLICATION

public static final int WHENTORUN_AFTER_EACH_PATTERN_APPLICATION

See Also:

Constant Field Values

WHENTORUN_ONCE_IF_PATTERN_MATCHES

public static final int WHENTORUN_ONCE_IF_PATTERN_MATCHES

See Also:

Constant Field Values

WHENTORUN_ONCE_IF_NO_MATCHES

public static final int WHENTORUN_ONCE_IF_NO_MATCHES

See Also:

Constant Field Values

WHENTORUN_BEFORE_ALL_HTTPTRANSACTIONS

public static final int WHENTORUN_BEFORE_ALL_HTTPTRANSACTIONS

See Also:

Constant Field Values

WHENTORUN_BEFORE_HTTPREQUEST

public static final int WHENTORUN_BEFORE_HTTPREQUEST

See Also:

Constant Field Values

WHENTORUN_AFTER_HTTPREQUEST

public static final int WHENTORUN_AFTER_HTTPREQUEST

See Also:

Constant Field Values

WHENTORUN_BEFORE_HTTPRESPONSE

public static final int WHENTORUN_BEFORE_HTTPRESPONSE

See Also:

Constant Field Values

WHENTORUN_AFTER_HTTPRESPONSE

public static final int WHENTORUN_AFTER_HTTPRESPONSE

See Also:

Constant Field Values

Constructor Detail

ScriptInstance

public ScriptInstance()

Required by castor.

ScriptInstance

public ScriptInstance(Script script,
                      int whenToRun,
                      int sequence,
                      boolean enabled)

Generates a new ScriptInstance.

Parameters:

script - The associated script.

whenToRun - When the script should be run.

sequence - The sequence in which the script should be run.

enabled - Indicates whether or not the script instance is enabled.

ScriptInstance

public ScriptInstance(@NotNull
                      ScriptInstance scriptInstance)

Makes a script instance by copying another.

Parameters:

scriptInstance - The ScriptInstance to copy.

Method Detail

getScript

@Nullable
public Script getScript()

Gets the script.

Returns:

The script.

setScript

public void setScript(Script script)

Sets the script.

Parameters:

script - The script.

getWhenToRun

public int getWhenToRun()

Indicates when the script should be run.

Returns:

A value defined by one of the "WHENTORUN" constants.

setWhenToRun

public void setWhenToRun(int whenToRun)

Sets when the script should be run.

Parameters:

whenToRun - A value as defined by one of the "WHENTORUN" scripts in this class..

getSequence

public int getSequence()

Gets the sequence in which the script should be run.

Returns:

The sequence.

setSequence

public void setSequence(int sequence)

Sets the sequence in which the script should be run.

Parameters:

sequence - The sequence.

isEnabled

public boolean isEnabled()

Indicates whether or not this script instance is enabled.

Returns:

A boolean.

setEnabled

public void setEnabled(boolean enabled)

Determines whether or not this script instance is enabled.

Parameters:

enabled - A boolean.

getScrapingSessionID

public int getScrapingSessionID()

Gets the ID of the scraping session associated with this script instance.

Returns:

The ID of the scraping session.

setScrapingSessionID

public void setScrapingSessionID(int scrapingSessionID)

Sets the ID of the scraping session associated with this script instance.

Parameters:

scrapingSessionID - The ID of the scraping session.

getScrapeableFileID

public int getScrapeableFileID()

Gets the ID of the scrapeable file associated with this script instance.

Returns:

The ID of the scrapeable file.

setScrapeableFileID

public void setScrapeableFileID(int scrapeableFileID)

Sets the ID of the scrapeable file associated with this script instance.

Parameters:

scrapeableFileID - The ID of the scrapeable file.

getExtractorPatternID

public int getExtractorPatternID()

Gets the ID of the extractor pattern associated with this script instance.

Returns:

The ID of the extractor pattern.

setExtractorPatternID

public void setExtractorPatternID(int extractorPatternID)

Sets the ID of the extractor pattern associated with this script instance.

Parameters:

extractorPatternID - The ID of the extractor pattern.

getHTTPSessionID

public int getHTTPSessionID()

Gets the ID of the HTTP session associated with this script instance.

Returns:

The ID of the HTTP session.

setHTTPSessionID

public void setHTTPSessionID(int httpSessionID)

Sets the ID of the HTTP session associated with this script instance.

Parameters:

httpSessionID - The ID of the HTTP session.

getHumanReadableFormOfWhenToRunValue

public static java.lang.String getHumanReadableFormOfWhenToRunValue(int whenToRun)

Gets a human-friendly description of the given "WHENTORUN" value.

Parameters:

whenToRun - When the script instance should be run.

Returns:

A String.

save

public void save()

Saves the script instance to the database.

deleteByContainerObject

public void deleteByContainerObject()

Deletes the script instance from the database.

delete

public void delete()

Deletes this specific instance from the database.

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

We override this so that we can check for dupes.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare.

compareTo

public int compareTo(java.lang.Object sInstance)

Allows these things to be sorted.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

sInstance - The ScriptInstance with which we want to compare.

dumpToLog

public void dumpToLog()

Dumps the script instance to the log.