com.screenscraper.scraper

Class FileScrapingSessionNotifiable

java.lang.Object

com.screenscraper.common.FileNotifiable

com.screenscraper.scraper.FileScrapingSessionNotifiable

All Implemented Interfaces:

Notifiable, ScrapingSessionNotifiable

public class FileScrapingSessionNotifiable
extends FileNotifiable
implements ScrapingSessionNotifiable

Field Summary

Fields

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

Fields inherited from interface com.screenscraper.common.Notifiable

LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO, LEVEL_WARN, STR_LEVEL_DEBUG, STR_LEVEL_ERROR, STR_LEVEL_INFO, STR_LEVEL_WARN

Constructor Summary

Constructors

Constructor and Description
FileScrapingSessionNotifiable(java.lang.String scrapingSessionName, java.lang.String characterSet, java.lang.String rand) Constructs a DefaultScrapingSessionNotifiable to be used with the named scraping session.

Method Summary

Modifier and Type	Method and Description
boolean	getCloseLogFileOnCompletion() Indicates whether or not the log file should be closed when the scraping session completes.
void	scrapingSessionCompleted() Indicates that the scraping session has ended.
void	setCloseLogFileOnCompletion(boolean closeLogFileOnCompletion) Sets whether or not the log file should be closed when the scraping session completes.
void	setParentScrapingSessionNotifiable(ScrapingSessionNotifiable parentScrapingSessionNotifiable) Holds a parent ScrapingSessionNotifiable that messages should be propagated to.

Methods inherited from class com.screenscraper.common.FileNotifiable

closeLog, getLogFileName, getLoggingLevel, log, logDebug, logError, logInfo, logWarn, setLogFile, setLoggingLevel, writeLogLine

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.screenscraper.scraper.ScrapingSessionNotifiable

getLoggingLevel, log, logDebug, logError, logInfo, logWarn, setLoggingLevel

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

FileScrapingSessionNotifiable

public FileScrapingSessionNotifiable(java.lang.String scrapingSessionName,
                                     java.lang.String characterSet,
                                     java.lang.String rand)

Constructs a DefaultScrapingSessionNotifiable to be used with the named scraping session.

Parameters:

scrapingSessionName - The name of the ScrapingSession.

characterSet - The character set to use for the log file.

rand - A random string, just in case the system time is the same as another (yes, it does happen).

Method Detail

scrapingSessionCompleted

public void scrapingSessionCompleted()

Indicates that the scraping session has ended.

Specified by:

scrapingSessionCompleted in interface ScrapingSessionNotifiable

setParentScrapingSessionNotifiable

public void setParentScrapingSessionNotifiable(ScrapingSessionNotifiable parentScrapingSessionNotifiable)

Holds a parent ScrapingSessionNotifiable that messages should be propagated to. Note that at present only the scrapingSessionCompleted message gets propagated.

Parameters:

parentScrapingSessionNotifiable - A ScrapingSessionNotifiable.

getCloseLogFileOnCompletion

public boolean getCloseLogFileOnCompletion()

Indicates whether or not the log file should be closed when the scraping session completes.

Returns:

A boolean.

setCloseLogFileOnCompletion

public void setCloseLogFileOnCompletion(boolean closeLogFileOnCompletion)

Sets whether or not the log file should be closed when the scraping session completes.