com.screenscraper

Class CommandLineScriptHandler

java.lang.Object

com.screenscraper.CommandLineScriptHandler

All Implemented Interfaces:

Notifiable, ScrapingSessionNotifiable

public class CommandLineScriptHandler
extends java.lang.Object
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
CommandLineScriptHandler(java.lang.String scriptOrScrapingSessionName, java.lang.String commandLineParameters) Initiates the handler to run the given script with the given session variables.

Method Summary

Modifier and Type	Method and Description
int	getLoggingLevel() Gets the current logging level.
void	log(java.lang.String message) Logs a message.
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	outputLogMessage(java.lang.String message) Logs a message to stdout.
void	scrapingSessionCompleted() Indicates that the scraping session has ended.
void	setLoggingLevel(int loggingLevel) Sets the current logging level.

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

CommandLineScriptHandler

public CommandLineScriptHandler(java.lang.String scriptOrScrapingSessionName,
                                java.lang.String commandLineParameters)

Initiates the handler to run the given script with the given session variables.

Parameters:

scriptOrScrapingSessionName - The name of the script to be run.

commandLineParameters - A URL-encoded string of command-line parameters.

Method Detail

outputLogMessage

public void outputLogMessage(java.lang.String message)

Logs a message to stdout.

Parameters:

message - The message to be logged.

log

public void log(java.lang.String message)

Logs a message. Required by ScrapingSessionNotifiable.

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.

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.

scrapingSessionCompleted

public void scrapingSessionCompleted()

Indicates that the scraping session has ended. Required by ScrapingSessionNotifiable.

Specified by:

scrapingSessionCompleted in interface ScrapingSessionNotifiable