com.screenscraper.scraper

Class ScheduledScrapingSessionManager

java.lang.Object

com.screenscraper.scraper.ScheduledScrapingSessionManager

public class ScheduledScrapingSessionManager
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
ScheduledScrapingSessionManager()

Method Summary

Modifier and Type	Method and Description
static boolean	addScheduledScrapingSession(ScheduledScrapingSession scheduledScrapingSession) Adds a ScheduledScrapingSession to the manager.
static void	dumpToLog() Dumps all of the scheduled scraping sessions to the log.
static int	getNumScheduledScrapingSessions() Gets the number of scheduled scraping sessions held by the manager.
static ScheduledScrapingSession	getScheduledScrapingSessionByID(int id) Gets a ScheduledScrapingSession based on its database ID.
static java.util.ArrayList	getScheduledScrapingSessionsAsArrayListOfHashMaps() Gets the ScheduledScrapingSession objects in an ArrayList of HashMap objects so that they can be used on the client side.
static java.util.Iterator	getScheduledScrapingSessionsIterator() Gets an Iterator over which the various ScheduledScrapingSession objects can be cycled.
static boolean	isLoaded() Indicates whether or not the manager has been loaded.
static void	reload() Reloads all objects from the database.
static void	removeScheduledScrapingSession(java.lang.String id) Removes a ScheduledScrapingSession from the manager, and deletes it from the database.
static void	replaceScrapingSession(ScrapingSession existingScrapingSession, ScrapingSession newScrapingSession) Replaces any references to the existing scraping session with the new scraping session.
static void	runScheduledScrapingSessions() Run any ScheduledScrapingSession objects that have reached the time to run.
static boolean	scheduledScrapingSessionExists(ScheduledScrapingSession scheduledScrapingSession) Determines whether or not a ScheduledScrapingSession matching this one already exists.

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

ScheduledScrapingSessionManager

public ScheduledScrapingSessionManager()

Method Detail

reload

public static void reload()

Reloads all objects from the database.

isLoaded

public static boolean isLoaded()

Indicates whether or not the manager has been loaded.

Returns:

A boolean.

getNumScheduledScrapingSessions

public static int getNumScheduledScrapingSessions()

Gets the number of scheduled scraping sessions held by the manager.

Returns:

The number.

scheduledScrapingSessionExists

public static boolean scheduledScrapingSessionExists(@Nullable
                                                     ScheduledScrapingSession scheduledScrapingSession)

Determines whether or not a ScheduledScrapingSession matching this one already exists.

Parameters:

scheduledScrapingSession - The ScheduledScrapingSession to compare.

Returns:

True if a dupe is found.

replaceScrapingSession

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

Replaces any references to the existing scraping session with the new scraping session.

Parameters:

existingScrapingSession - The existing ScrapingSession.

newScrapingSession - The new ScrapingSession.

addScheduledScrapingSession

public static boolean addScheduledScrapingSession(@Nullable
                                                  ScheduledScrapingSession scheduledScrapingSession)

Adds a ScheduledScrapingSession to the manager.

Parameters:

scheduledScrapingSession - A ScheduledScrapingSession.

Returns:

Whether or not it was actually added.

getScheduledScrapingSessionsIterator

public static java.util.Iterator getScheduledScrapingSessionsIterator()

Gets an Iterator over which the various ScheduledScrapingSession objects can be cycled.

Returns:

An Iterator containnig ScheduledScrapingSession objects.

getScheduledScrapingSessionsAsArrayListOfHashMaps

@NotNull
public static java.util.ArrayList getScheduledScrapingSessionsAsArrayListOfHashMaps()

Gets the ScheduledScrapingSession objects in an ArrayList of HashMap objects so that they can be used on the client side.

Returns:

The data.

getScheduledScrapingSessionByID

public static ScheduledScrapingSession getScheduledScrapingSessionByID(int id)

Gets a ScheduledScrapingSession based on its database ID.

Parameters:

id - The ID to match.

Returns:

The ScheduledScrapingSession if found; null, otherwise.

removeScheduledScrapingSession

public static void removeScheduledScrapingSession(@Nullable
                                                  java.lang.String id)
                                           throws java.lang.Exception

Removes a ScheduledScrapingSession from the manager, and deletes it from the database.

Parameters:

id - The ID to match.

Throws:

java.lang.Exception

runScheduledScrapingSessions

public static void runScheduledScrapingSessions()

Run any ScheduledScrapingSession objects that have reached the time to run.

dumpToLog

public static void dumpToLog()

Dumps all of the scheduled scraping sessions to the log.