com.screenscraper.scraper

Class ScrapeableSessionManager

java.lang.Object

com.screenscraper.scraper.ScrapeableSessionManager

public class ScrapeableSessionManager
extends java.lang.Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ScrapeableSessionManager()

Method Summary

Modifier and Type	Method and Description
static void	addScrapeableSession(ScrapeableSession scrapeableSession) Adds a ScrapeableSession to the manager.
static void	completeScrapeableSession(ScrapingSession scrapingSession) Handles a ScrapeableSession whose corresponding ScrapingSession has completed.
static ScrapeableSession	getMostRecentScrapeableSession(java.lang.String scrapingSessionName) Gets the most recently run ScrapeableSession based on the given ScrapingSession.
static int	getNumScrapeableSessions() Gets the number of scrapeable sessions held by the manager.
static ScrapeableSession	getPriorScrapeableSession(ScrapeableSession scrapeableSession) Gets the ScrapeableSession that ran just prior to the given ScrapeableSession.
static ScrapeableSession	getScrapeableSession(int id) Gets the ScrapeableSession with the given ID.
static ScrapeableSession	getScrapeableSession(ScrapingSession scrapingSession) Gets a ScrapeableSession based on the given ScrapingSession.
static ScrapeableSession	getScrapeableSession(java.lang.String scrapingSessionName) Gets a ScrapeableSession based on the given ScrapingSession name.
static SynchronizedListAccessibleLock<ScrapeableSession>	getScrapeableSessions() Gets a direct reference to the object containing the various ScrapeableSessionManager objects.
static boolean	isLoaded() Indicates whether or not the manager has been loaded.
protected static void	load() Loads up any existing ScrapeableSession objects from the database.
static void	nullScrapingSessionReference(ScrapingSession scrapingSession) Nulls out the reference to the given ScrapingSession if a ScrapeableSession containing that ScrapingSession is found.
static void	reload() Reloads all objects from the database.
static void	removeScrapeableSession(int id) Removes the ScrapeableSession with the given ID.
static void	removeScrapeableSession(ScrapeableSession scrapeableSession) Removes the given ScrapeableSession.
static void	replaceScrapingSession(ScrapingSession oldScrapingSession, ScrapingSession newScrapingSession) Handles replacing one scraping session with another.
static void	save() Saves all of the constituent ScrapeableSession objects that are still in process.
static void	setPreviousValuesOnScrapeableSessions() Iterates through the current set of ScrapeableSession objects, setting the "previous" values on each.
static void	setScrapeableSessionStatus(ScrapingSession scrapingSession, java.lang.String status) Sets the status for a ScrapeableSession if one is found.
static void	sortScrapeableSessions() Sorts the existing set of ScrapeableSession objects.

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

Constructor Detail

ScrapeableSessionManager

public ScrapeableSessionManager()

Method Detail

load

protected static void load()

Loads up any existing ScrapeableSession objects from the database.

reload

public static void reload()

Reloads all objects from the database.

replaceScrapingSession

public static void replaceScrapingSession(@Nullable
                                          ScrapingSession oldScrapingSession,
                                          @Nullable
                                          ScrapingSession newScrapingSession)

Handles replacing one scraping session with another.

Parameters:

oldScrapingSession - The ScrapingSession to be replaced.

newScrapingSession - The ScrapingSession to replace.

isLoaded

public static boolean isLoaded()

Indicates whether or not the manager has been loaded.

Returns:

A boolean.

setPreviousValuesOnScrapeableSessions

public static void setPreviousValuesOnScrapeableSessions()

Iterates through the current set of ScrapeableSession objects, setting the "previous" values on each.

sortScrapeableSessions

public static void sortScrapeableSessions()

Sorts the existing set of ScrapeableSession objects.

getScrapeableSessions

@Nullable
 @InternalOnly
public static SynchronizedListAccessibleLock<ScrapeableSession> getScrapeableSessions()

Gets a direct reference to the object containing the various ScrapeableSessionManager objects.

Returns:

A TreeSet containing ScrapeableSession objects.

getNumScrapeableSessions

public static int getNumScrapeableSessions()

Gets the number of scrapeable sessions held by the manager.

Returns:

The number.

addScrapeableSession

public static void addScrapeableSession(@Nullable
                                        ScrapeableSession scrapeableSession)

Adds a ScrapeableSession to the manager.

Parameters:

scrapeableSession - A ScrapeableSession.

removeScrapeableSession

public static void removeScrapeableSession(int id)

Removes the ScrapeableSession with the given ID.

Parameters:

id - The ID of the ScrapeableSession.

removeScrapeableSession

public static void removeScrapeableSession(@Nullable
                                           ScrapeableSession scrapeableSession)

Removes the given ScrapeableSession.

Parameters:

scrapeableSession - The ScrapeableSession to remove.

getScrapeableSession

public static ScrapeableSession getScrapeableSession(int id)

Gets the ScrapeableSession with the given ID.

Parameters:

id - The ID of the ScrapeableSession.

Returns:

A ScrapeableSession, if found; null, otherwise.

getMostRecentScrapeableSession

@Nullable
public static ScrapeableSession getMostRecentScrapeableSession(@Nullable
                                                                          java.lang.String scrapingSessionName)

Gets the most recently run ScrapeableSession based on the given ScrapingSession.

Parameters:

scrapingSessionName - A ScrapingSession name.

Returns:

A ScrapeableSession, if found; null, otherwise.

getScrapeableSession

@Nullable
public static ScrapeableSession getScrapeableSession(@Nullable
                                                                ScrapingSession scrapingSession)

Gets a ScrapeableSession based on the given ScrapingSession.

Parameters:

scrapingSession - A ScrapingSession.

Returns:

A ScrapeableSession, if found; null, otherwise.

getScrapeableSession

@Nullable
public static ScrapeableSession getScrapeableSession(@Nullable
                                                                java.lang.String scrapingSessionName)

Gets a ScrapeableSession based on the given ScrapingSession name.

Parameters:

scrapingSessionName - A ScrapingSession name.

Returns:

A ScrapeableSession, if found; null, otherwise.

nullScrapingSessionReference

public static void nullScrapingSessionReference(@Nullable
                                                ScrapingSession scrapingSession)

Nulls out the reference to the given ScrapingSession if a ScrapeableSession containing that ScrapingSession is found.

Parameters:

scrapingSession - The ScrapingSession.

setScrapeableSessionStatus

public static void setScrapeableSessionStatus(@Nullable
                                              ScrapingSession scrapingSession,
                                              java.lang.String status)

Sets the status for a ScrapeableSession if one is found.

Parameters:

scrapingSession - The ScrapingSession corresponding to the ScrapeableSession.

status - The status to set.

completeScrapeableSession

public static void completeScrapeableSession(ScrapingSession scrapingSession)

Handles a ScrapeableSession whose corresponding ScrapingSession has completed.

Parameters:

scrapingSession - The ScrapingSession that was completed.

save

public static void save()

Saves all of the constituent ScrapeableSession objects that are still in process.

getPriorScrapeableSession

@Nullable
public static ScrapeableSession getPriorScrapeableSession(@Nullable
                                                                     ScrapeableSession scrapeableSession)

Gets the ScrapeableSession that ran just prior to the given ScrapeableSession.

Parameters:

scrapeableSession - The ScrapeableSession to compare.

Returns:

The closest ScrapeableSession, if found; null, otherwise.