com.screenscraper.scraper

Class RunnableScrapingSession

java.lang.Object

com.screenscraper.scraper.RunnableScrapingSession

public class RunnableScrapingSession
extends java.lang.Object

Encapsulates the data necessary to start up a scraping session.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RunnableScrapingSession(java.lang.String name) Instantiates a new runnable scraping session that will use the scraping session identified by the name parameter to scrape data.
RunnableScrapingSession(java.lang.String name, ScrapingSession parentScrapingSession) Creates a new instance by inheriting the state and notifiable from the given ScrapingSession.
RunnableScrapingSession(java.lang.String name, ScrapingSession parentScrapingSession, boolean inheritHttpState) Creates a new instance by inheriting the state and notifiable from the given ScrapingSession.

Method Summary

Modifier and Type	Method and Description
void	addEndScrapeCallback(EventHandler<SessionEventData> handler) Adds a callback to be called after the scraping session runs.
boolean	getDoLazyScrape() Indicates whether or not a lazy scrape should be done on the session.
<T> T	getInternalVariable(java.lang.String key) Gets the value of an internal variable.
java.lang.String	getName() Gets the name of the scraping session.
ScrapingSession	getScrapingSession() Returns the scraping session that will be run (or is running).
ScrapingSessionNotifiable	getScrapingSessionNotifiable() Gets the object the scraping session will use to notify its progress of.
int	getTimeout() Gets the timeout, in minutes, for the scraping session.
java.lang.Object	getVariable(java.lang.String variable) Gets the value of a session variable.
boolean	isCompleted() Returns true if the scrape has been completed (and was therefore run)
void	loadVariables(java.lang.String fileToReadFrom) Reads in and loads the session variables that were previously saved to a file.
void	scrape() Indicates the the runnable scraping session should be queued up for scraping.
void	setDoLazyScrape(boolean doLazyScrape) Indicates whether or not a lazy scrape should be done on the session.
void	setInternalVariable(java.lang.String key, java.lang.Object value) Sets the value of an internal variable
void	setName(java.lang.String name) Sets the name of the scraping session.
void	setScrapingSessionNotifiable(ScrapingSessionNotifiable scrapingSessionNotifiable) Sets the object the scraping session will use to notify its progress of.
void	setTimeout(int timeout) Sets the timeout, in minutes, for the scraping session.
void	setVariable(java.lang.String variable, java.lang.Object value) Sets the value of a session variable
void	stopScraping() Tells the child to stop scraping.
void	stopScraping(boolean forceUpdate, StopScrapingCallType stopScrapingType, java.lang.String explanation) Tells the child to stop scraping.
java.lang.String	toString()
boolean	wasStopped() Returns true if the scrape was stopped (either by calling stopScraping or in the workbench by clicking the stop scraping button)

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

RunnableScrapingSession

public RunnableScrapingSession(java.lang.String name)
                        throws java.lang.Exception

Instantiates a new runnable scraping session that will use the scraping session identified by the name parameter to scrape data. Will throw an exception if an invalid scraping session name is designated.

Parameters:

name - The name of the scraping session. Note that this scraping session should already exist.

Throws:

java.lang.Exception - If the session doesn't exist

RunnableScrapingSession

public RunnableScrapingSession(java.lang.String name,
                               @NotNull
                               ScrapingSession parentScrapingSession)
                        throws java.lang.Exception

Creates a new instance by inheriting the state and notifiable from the given ScrapingSession.

Parameters:

name - The name of the scraping session this will run.

parentScrapingSession - The ScrapingSession this should inherit from.

Throws:

java.lang.Exception - If the session doesn't exist or a null parent session is given

RunnableScrapingSession

public RunnableScrapingSession(java.lang.String name,
                               @NotNull
                               ScrapingSession parentScrapingSession,
                               boolean inheritHttpState)
                        throws java.lang.Exception

Creates a new instance by inheriting the state and notifiable from the given ScrapingSession.

Parameters:

name - The name of the scraping session this will run.

parentScrapingSession - The ScrapingSession this should inherit from.

inheritHttpState - Whether or not the HttpState should be inherited from the passed in scraping session.

Throws:

java.lang.Exception - If the session doesn't exist or a null parent session is given

Method Detail

getName

@Nullable
public java.lang.String getName()

Gets the name of the scraping session.

Returns:

The name.

setName

public void setName(java.lang.String name)

Sets the name of the scraping session.

Parameters:

name - The name.

setVariable

public void setVariable(@NotNull
                        java.lang.String variable,
                        java.lang.Object value)

Sets the value of a session variable

Parameters:

variable - The variable.

value - The value of the variable.

setInternalVariable

@InternalOnly
public void setInternalVariable(@NotNull
                                               java.lang.String key,
                                               java.lang.Object value)

Sets the value of an internal variable

Parameters:

key - The variable.

value - The value of the variable.

getVariable

@Nullable
public java.lang.Object getVariable(@NotNull
                                               java.lang.String variable)

Gets the value of a session variable. Required by RunningScrapingSession.

Parameters:

variable - The name of the variable.

Returns:

The value of the variable.

getInternalVariable

@Nullable
public <T> T getInternalVariable(@NotNull
                                            java.lang.String key)

Gets the value of an internal variable. Required by RunningScrapingSession.

Parameters:

key - The name of the variable.

Returns:

The value of the variable.

getTimeout

public int getTimeout()

Gets the timeout, in minutes, for the scraping session.

Returns:

The timeout, in minutes.

setTimeout

public void setTimeout(int timeout)

Sets the timeout, in minutes, for the scraping session.

Parameters:

timeout - The timeout, in minutes.

getDoLazyScrape

public boolean getDoLazyScrape()

Indicates whether or not a lazy scrape should be done on the session. Defaults to true.

Returns:

A boolean.

setDoLazyScrape

public void setDoLazyScrape(boolean doLazyScrape)

Indicates whether or not a lazy scrape should be done on the session. Defaults to true.

Parameters:

doLazyScrape - A boolean.

loadVariables

public void loadVariables(@NotNull
                          java.lang.String fileToReadFrom)
                   throws java.lang.Exception

Reads in and loads the session variables that were previously saved to a file.

Parameters:

fileToReadFrom - The file to read the variables from.

Throws:

java.lang.Exception - On error loading the variables from file

getScrapingSessionNotifiable

@Nullable
 @InternalOnly
public ScrapingSessionNotifiable getScrapingSessionNotifiable()

Gets the object the scraping session will use to notify its progress of.

Returns:

The object.

setScrapingSessionNotifiable

@InternalOnly
public void setScrapingSessionNotifiable(ScrapingSessionNotifiable scrapingSessionNotifiable)

Sets the object the scraping session will use to notify its progress of.

Parameters:

scrapingSessionNotifiable - The object.

scrape

public void scrape()

Indicates the the runnable scraping session should be queued up for scraping.

getScrapingSession

@Nullable
 @InternalOnly
public ScrapingSession getScrapingSession()

Returns the scraping session that will be run (or is running). This can be used to get at the session data and methods. Be aware that session methods in general are not thread safe. While some are, if accessing them while the session is active synchronization should be used

Returns:

The scraping session that will be run (or is running)

addEndScrapeCallback

public void addEndScrapeCallback(@NotNull
                                 EventHandler<SessionEventData> handler)

Adds a callback to be called after the scraping session runs. Note this sets an SessionEventFireTime.AfterEndAndOtherCallbacks event, so if the session adds it's own those may not have fired yet. Generally only internal code should use that fire time unless you know what you're doing

Parameters:

handler - The handler to add

stopScraping

public void stopScraping()

Tells the child to stop scraping. This should only be called after the scrape has been started, otherwise it will cause the child to stop immediately after starting

stopScraping

public void stopScraping(boolean forceUpdate,
                         @NotNull
                         StopScrapingCallType stopScrapingType,
                         @Nullable
                         java.lang.String explanation)

Tells the child to stop scraping. This should only be called after the scrape has been started, otherwise it will cause the child to stop immediately after starting

Parameters:

forceUpdate - True iff this stop information should overwrite the stop information of a previous stop call (if one has occurred)

stopScrapingType - The type of the stop call to set

explanation - An explanation of the stop call

isCompleted

public boolean isCompleted()

Returns true if the scrape has been completed (and was therefore run)

Returns:

True if the scrape ran and has completed running

wasStopped

public boolean wasStopped()

Returns true if the scrape was stopped (either by calling stopScraping or in the workbench by clicking the stop scraping button)

Returns:

True if the scrape was stopped

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object