com.screenscraper.model

Class ModelScrapingSession

java.lang.Object

com.screenscraper.hmvc.AbstractModel

com.screenscraper.model.ModelScrapingSession

All Implemented Interfaces:

Notifiable, ScrapingSessionNotifiable

public class ModelScrapingSession
extends AbstractModel
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
ModelScrapingSession() An empty constructor.

Method Summary

Modifier and Type	Method and Description
ScrapingSession	getCurrentScrapingSession() Gets a reference to the current ScrapingSession.
int	getLoggingLevel() Gets the current logging level.
void	handleAppEvent(AppEvent ape) Allows the class to handle AppEvents.
void	log(java.lang.String message) Sends an app event off to the view to be logged.
void	log(java.lang.String message, int loggingLevel) Sends an app event off to the view to be logged.
void	logDebug(java.lang.String message) Logs a message with LEVEL_DEBUG.
void	logError(java.lang.String message) Logs a message with LEVEL_ERROR.
void	logInfo(java.lang.String message) Logs a message with LEVEL_INFO.
void	logWarn(java.lang.String message) Logs a message with LEVEL_WARN.
void	scrapingSessionCompleted() Indicates that the scraping session has ended.
void	setLoggingLevel(int loggingLevel) Sets the current logging level.

Methods inherited from class com.screenscraper.hmvc.AbstractModel

getController, setController

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

Used for logging.

Constructor Detail

ModelScrapingSession

public ModelScrapingSession()

An empty constructor.

Method Detail

log

public void log(java.lang.String message)

Sends an app event off to the view to be logged.

Specified by:

log in interface Notifiable

Specified by:

log in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

logDebug

public void logDebug(java.lang.String message)

Logs a message with LEVEL_DEBUG.

Specified by:

logDebug in interface Notifiable

Specified by:

logDebug in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

logInfo

public void logInfo(java.lang.String message)

Logs a message with LEVEL_INFO.

Specified by:

logInfo in interface Notifiable

Specified by:

logInfo in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

logWarn

public void logWarn(java.lang.String message)

Logs a message with LEVEL_WARN.

Specified by:

logWarn in interface Notifiable

Specified by:

logWarn in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

logError

public void logError(java.lang.String message)

Logs a message with LEVEL_ERROR.

Specified by:

logError in interface Notifiable

Specified by:

logError in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

log

public void log(java.lang.String message,
                int loggingLevel)

Sends an app event off to the view to be logged.

Parameters:

message - The message to be logged.

loggingLevel - The logging level of the message.

scrapingSessionCompleted

public void scrapingSessionCompleted()

Indicates that the scraping session has ended.

Specified by:

scrapingSessionCompleted in interface ScrapingSessionNotifiable

getLoggingLevel

public int getLoggingLevel()

Gets the current logging level.

Specified by:

getLoggingLevel in interface Notifiable

Specified by:

getLoggingLevel in interface ScrapingSessionNotifiable

Returns:

The logging level, as defined by one of the "LOGGING" constants.

setLoggingLevel

public void setLoggingLevel(int loggingLevel)

Sets the current logging level.

Specified by:

setLoggingLevel in interface Notifiable

Specified by:

setLoggingLevel in interface ScrapingSessionNotifiable

Parameters:

loggingLevel - The logging level, as defined by one of the "LOGGING" constants.

getCurrentScrapingSession

@InternalOnly
public ScrapingSession getCurrentScrapingSession()

Gets a reference to the current ScrapingSession.

Returns:

The ScrapingSession.

handleAppEvent

public void handleAppEvent(AppEvent ape)

Allows the class to handle AppEvents.

Specified by:

handleAppEvent in class AbstractModel

Parameters:

ape - An AppEvent.