ScrapeStateLogger

java.lang.Object
- com.screenscraper.util.ScrapeStateLogger

```
public class ScrapeStateLogger
extends java.lang.Object
```
Class used to format objects and output them to a log or the web interface. User: Mike Stillwell Date: 10/20/11 Time: 3:18 PM

Constructor Summary

Constructors
Constructor and Description
`ScrapeStateLogger(ScrapingSession scrapingSession)` Create a scrape logger for the given session
`ScrapeStateLogger(ScrapingSession scrapingSession, boolean includeCurrentSessionDetails, boolean includeTimestamp)` Create a scrape logger for the given session

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutoProgressBar`	`addAutoProgressBar(java.lang.String key, java.util.Collection<java.lang.String> values)` Adds an auto progress bar to this loggers progress bars
`void`	`addMonitoredPostfix(java.lang.String postfix)` Watches for all session variables whose keys end with the postfix specified, and will output their values when monitored variables are logged.
`void`	`addMonitoredPrefix(java.lang.String prefix)` Watches for all session variables whose keys begin with the prefix specified, and will output their values when monitored variables are logged.
`void`	`addMonitoredVariable(java.lang.String key)` Watches the value of a session variable, and will output it each time monitored variables are output
`ProgressBar`	`addProgressBar(java.lang.String title, double total)` Adds a progress bar to the progress bars
`java.lang.Object`	`addValue(java.lang.String key, java.lang.Object value)` Adds an arbitrary value to be logged with this logger.
`java.lang.String`	`buildWebMessage(java.lang.String mainDivStyle, java.lang.Object messageHeader, java.util.Map<java.lang.String,java.util.List<LoggableValue>> loggableValues)` Build a standard web message, with the formatting for the main <div> as given.
`ScrapeStateLogger`	`duplicate(ScrapingSession scrapingSession)` Creates a duplicate of this logger, but using the given scraping session instead of the current one.
`java.lang.String`	`getCustomHTMLHeader()` Returns the HTML header that has been set.
`java.util.Map<java.lang.String,java.lang.Object>`	`getGeneralInfoVariables()` Returns the general information values, or an empty map if they shouldn't be logged
`int`	`getHighestLevelLogged()` Returns the highest level this logger has logged at.
`java.util.Date`	`getLastRecordCountIncrementTime()` Returns the last time a record was saved, as determined by the number of records scraped value being changed
`java.lang.String`	`getMainWebHeader()` Returns the HTML to display the main header that is always present
`java.util.Set<java.lang.String>`	`getMonitoredPostfixes()` Returns a set of monitored postfixes
`java.util.Set<java.lang.String>`	`getMonitoredPrefixes()` Returns a set of monitored prefixes
`java.util.Map<java.lang.String,java.lang.Object>`	`getMonitoredVariables()` Gets all the currently monitored session variables and values
`int`	`getNumMessagesToSave()` Gets the number of messages that the web interface will save.
`int`	`getNumProgressBars()` Returns the number of progress bars currently available
`ProgressBar`	`getProgressBar(int index)` Returns the progress bar at the given index, with 0 being the highest level bar, and lower-level bars being sequentially larger in index
`ProgressBar`	`getProgressBar(java.lang.String title)` Returns the first progress bar with the given title, or null if none is found.
`java.lang.String`	`getSavedMessages()` Gets a string containing all the currently saved messages, sorted in order from newest to oldest
`java.lang.String`	`getWebDivider(java.lang.String value)` Gets the HTML needed to insert a custom divider in the web message
`java.lang.String`	`getWebProgress()` Get the HTML for the current progress of the scrape, taken from the current progress bars.
`java.lang.String`	`getWebTimestamp()` Get an HTML formatted message indicating the time this method was called, and an html element with the id age[id] that can be dynamically updated with javascript to show the age of the message
`boolean`	`isLogLowerCaseDataRecordKeys()` Returns whether or not full lower case keys will be logged in a data record
`boolean`	`isLogMixedCaseDataRecordKeys()` Returns whether or not keys with both upper and lower case characters will be logged in a data record
`boolean`	`isLogUpperCaseDataRecordKeys()` Returns whether or not full upper case keys will be logged in a data record
`void`	`removeAllMonitoredVariables()` Stops watching all currently monitored variables, prefixes, postfixes, and any manually set values
`void`	`removeMonitoredPostfix(java.lang.String postfix)` Stops watching for a postfix in session variables
`void`	`removeMonitoredPrefix(java.lang.String prefix)` Stops watching for a prefix in session variables
`void`	`removeMonitoredVariable(java.lang.String key)` Stops watching the specified variable
`void`	`removeProgressBar(ProgressBar progressBar)` Removes the specified progress bar
`java.lang.Object`	`removeValue(java.lang.String key)` Removes a value from the additional values being output by this monitor (doesn't remove session variable values)
`void`	`reset()` Resets all internal values, so that this becomes as if just created.
`void`	`saveMessage(java.lang.String message, int mapping)` Saves a message under a specific category, as given by the mapping.
`void`	`setCustomHTMLHeader(java.lang.String customHTMLHeader)` Sets the HTML header that will be logged at the top of every message in the web interface.
`void`	`setLogLowerCaseDataRecordKeys(boolean logLowerCaseDataRecordKeys)` Sets whether or not all lowercase keys of a datarecord should be logged
`void`	`setLogMixedCaseDataRecordKeys(boolean logMixedCaseDataRecordKeys)` Sets whether or not keys of a datarecord with both upper and lowercase characters should be logged
`void`	`setLogUpperCaseDataRecordKeys(boolean logUpperCaseDataRecordKeys)` Sets whether or not all uppercase keys of a datarecord should be logged
`void`	`setNumMessagesToSave(int numMessagesToSave)` Sets the number of messages that the web interface will save.
`void`	`updateLastRecordCountIncrementTime()` Updates the time value when the last record saved value was last modified
`java.lang.String`	`webMessage(java.lang.Object messageHeader, int level, boolean saveMessage)` Creates an HTML message representing the scrape state and current scrape progress, and outputs it to the web message area.
`void`	`writeToLog(java.lang.Object message, int logLevel)` Writes the values in this logger to the log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScrapeStateLogger
```
public ScrapeStateLogger(ScrapingSession scrapingSession)
```
    Create a scrape logger for the given session
    
    Parameters:
    
    scrapingSession - The scraping session to log values for
  - ScrapeStateLogger
```
public ScrapeStateLogger(ScrapingSession scrapingSession,
                         boolean includeCurrentSessionDetails,
                         boolean includeTimestamp)
```
    Create a scrape logger for the given session
    
    Parameters:
    
    scrapingSession - The scraping session to log values for
    
    includeCurrentSessionDetails - True to include details about the session (variables)
    
    includeTimestamp - True to include timestamps in the logged messages
- Method Detail
  - getLastRecordCountIncrementTime
```
@Nullable
public java.util.Date getLastRecordCountIncrementTime()
```
    Returns the last time a record was saved, as determined by the number of records scraped value being changed
    
    Returns:
    
    The last time a record was saved, as determined by the number of records scraped value being changed
  - getMonitoredPrefixes
```
@NotNull
public java.util.Set<java.lang.String> getMonitoredPrefixes()
```
    Returns a set of monitored prefixes
    
    Returns:
    
    A set of monitored prefixes
  - getMonitoredPostfixes
```
@NotNull
public java.util.Set<java.lang.String> getMonitoredPostfixes()
```
    Returns a set of monitored postfixes
    
    Returns:
    
    A set of monitored postfixes
  - isLogLowerCaseDataRecordKeys
```
public boolean isLogLowerCaseDataRecordKeys()
```
    Returns whether or not full lower case keys will be logged in a data record
    
    Returns:
    
    Whether or not full lower case keys will be logged in a data record
  - isLogUpperCaseDataRecordKeys
```
public boolean isLogUpperCaseDataRecordKeys()
```
    Returns whether or not full upper case keys will be logged in a data record
    
    Returns:
    
    Whether or not full upper case keys will be logged in a data record
  - isLogMixedCaseDataRecordKeys
```
public boolean isLogMixedCaseDataRecordKeys()
```
    Returns whether or not keys with both upper and lower case characters will be logged in a data record
    
    Returns:
    
    Whether or not keys with both upper and lower case characters will be logged in a data record
  - reset
```
public final void reset()
```
    Resets all internal values, so that this becomes as if just created. Nothing is monitored anymore and all progress bars are removed.
  - updateLastRecordCountIncrementTime
```
public void updateLastRecordCountIncrementTime()
```
    Updates the time value when the last record saved value was last modified
  - addValue
```
public java.lang.Object addValue(java.lang.String key,
                                 @Nullable
                                 java.lang.Object value)
```
    Adds an arbitrary value to be logged with this logger. Values in the session will have precedence over these values if a variable being monitored in the session has the same value as a value added this way
    
    Parameters:
    
    key - The key to use
    
    value - The value to log as the value for the given key
    
    Returns:
    
    The object previously associated with the key, or null if nothing was associated with it before
  - removeValue
```
public java.lang.Object removeValue(java.lang.String key)
```
    Removes a value from the additional values being output by this monitor (doesn't remove session variable values)
    
    Parameters:
    
    key - The key to use
    
    Returns:
    
    The object previously associated with the key, or null if nothing was associated with it before
  - writeToLog
```
public void writeToLog(@Nullable
                       java.lang.Object message,
                       int logLevel)
```
    Writes the values in this logger to the log
    
    Parameters:
    
    message - The message to log at the top of this write
    
    logLevel - The level at which to output the log messages
  - setNumMessagesToSave
```
public void setNumMessagesToSave(int numMessagesToSave)
```
    Sets the number of messages that the web interface will save. This number is per type, rather than overall. For example, setting this value to 5 would mean it will save up to 20 messages (5 debug, 5 info, 5 warn, 5 error).
    
    Parameters:
    
    numMessagesToSave - How many messages of a given type to save total.
  - getNumMessagesToSave
```
public int getNumMessagesToSave()
```
    Gets the number of messages that the web interface will save. This number is per type, rather than overall. For example, a value of 5 would mean it will save up to 20 messages (5 debug, 5 info, 5 warn, 5 error).
    
    Returns:
    
    How many messages of a given type will be saved
  - webMessage
```
@NotNull
public java.lang.String webMessage(java.lang.Object messageHeader,
                                             int level,
                                             boolean saveMessage)
```
    Creates an HTML message representing the scrape state and current scrape progress, and outputs it to the web message area.
    
    Parameters:
    
    messageHeader - A header to include at the top of the message
    
    level - The level at which to log this message
    
    saveMessage - Should this message be saved (so it can be viewed later)
    
    Returns:
    
    The HTML that was sent to the web interface
  - buildWebMessage
```
@NotNull
public java.lang.String buildWebMessage(java.lang.String mainDivStyle,
                                                  @Nullable
                                                  java.lang.Object messageHeader,
                                                  @NotNull
                                                  java.util.Map<java.lang.String,java.util.List<LoggableValue>> loggableValues)
```
    Build a standard web message, with the formatting for the main <div> as given.
    
    Parameters:
    
    mainDivStyle - The CSS Style for the message body
    
    messageHeader - The header to display at the top of the message
    
    loggableValues - A mapping of the values to log this time
    
    Returns:
    
    HTML String to output to the web interface
  - getWebProgress
```
@NotNull
public java.lang.String getWebProgress()
```
    Get the HTML for the current progress of the scrape, taken from the current progress bars. Will output estimated time remaining, and a graphical representation of each progress bar
    
    Returns:
    
    HTML for the current progress of the scrape
  - getWebTimestamp
```
@NotNull
public java.lang.String getWebTimestamp()
```
    Get an HTML formatted message indicating the time this method was called, and an html element with the id age[id] that can be dynamically updated with javascript to show the age of the message
    
    Returns:
    
    HTML code to display a time message
  - getWebDivider
```
public java.lang.String getWebDivider(@Nullable
                                      java.lang.String value)
```
    Gets the HTML needed to insert a custom divider in the web message
    
    Parameters:
    
    value - An optional value to put inside the divider
    
    Returns:
    
    The HTML for the divider
  - getMainWebHeader
```
@NotNull
public java.lang.String getMainWebHeader()
```
    Returns the HTML to display the main header that is always present
    
    Returns:
    
    HTML code to display the main header
  - getGeneralInfoVariables
```
@NotNull
public java.util.Map<java.lang.String,java.lang.Object> getGeneralInfoVariables()
```
    Returns the general information values, or an empty map if they shouldn't be logged
    
    Returns:
    
    The general information values, or an empty map if they shouldn't be logged
  - getMonitoredVariables
```
@NotNull
public java.util.Map<java.lang.String,java.lang.Object> getMonitoredVariables()
```
    Gets all the currently monitored session variables and values
    
    Returns:
    
    The session variables and values that are being monitored
  - getCustomHTMLHeader
```
public java.lang.String getCustomHTMLHeader()
```
    Returns the HTML header that has been set. This will be logged at the top of every message in the web interface, and a version of it will be logged with the log messages.
    
    Returns:
    
    The custom HTML header to log before each message, or null if none is set
  - setCustomHTMLHeader
```
public void setCustomHTMLHeader(java.lang.String customHTMLHeader)
```
    Sets the HTML header that will be logged at the top of every message in the web interface. A version of it will be logged with the log messages as well.
    
    Parameters:
    
    customHTMLHeader - The custom HTML header to log before each message, or null to clear it
  - getSavedMessages
```
@NotNull
public java.lang.String getSavedMessages()
```
    Gets a string containing all the currently saved messages, sorted in order from newest to oldest
    
    Returns:
    
    HTML from each saved message, sorted in order from newest to oldest
  - saveMessage
```
public void saveMessage(java.lang.String message,
                        int mapping)
```
    Saves a message under a specific category, as given by the mapping. There can be many mappings, but the defaults are the LOG_ values
    
    Parameters:
    
    message - Text for the message to save (if used with web messages, this should include the HTML)
    
    mapping - Category this message goes under
  - addMonitoredVariable
```
public void addMonitoredVariable(java.lang.String key)
```
    Watches the value of a session variable, and will output it each time monitored variables are output
    
    Parameters:
    
    key - The key in the session corresponding to a value
  - addMonitoredPrefix
```
public void addMonitoredPrefix(java.lang.String prefix)
```
    Watches for all session variables whose keys begin with the prefix specified, and will output their values when monitored variables are logged.
    
    Parameters:
    
    prefix - The prefix to monitor
  - addMonitoredPostfix
```
public void addMonitoredPostfix(java.lang.String postfix)
```
    Watches for all session variables whose keys end with the postfix specified, and will output their values when monitored variables are logged.
    
    Parameters:
    
    postfix - The postfix to monitor
  - removeMonitoredVariable
```
public void removeMonitoredVariable(java.lang.String key)
```
    Stops watching the specified variable
    
    Parameters:
    
    key - Key for the variable to stop watching
  - removeMonitoredPrefix
```
public void removeMonitoredPrefix(java.lang.String prefix)
```
    Stops watching for a prefix in session variables
    
    Parameters:
    
    prefix - Prefix to remove from monitoring
  - removeMonitoredPostfix
```
public void removeMonitoredPostfix(java.lang.String postfix)
```
    Stops watching for a postfix in session variables
    
    Parameters:
    
    postfix - Postfix to remove from monitoring
  - removeAllMonitoredVariables
```
public void removeAllMonitoredVariables()
```
    Stops watching all currently monitored variables, prefixes, postfixes, and any manually set values
  - duplicate
```
@NotNull
public ScrapeStateLogger duplicate(ScrapingSession scrapingSession)
```
    Creates a duplicate of this logger, but using the given scraping session instead of the current one. Doesn't copy any ProgressBars
    
    Parameters:
    
    scrapingSession - The scraping session to use for session variables, cookies, etc...
    
    Returns:
    
    The new logger with duplicated monitored values
  - addProgressBar
```
@NotNull
public ProgressBar addProgressBar(java.lang.String title,
                                            double total)
```
    Adds a progress bar to the progress bars
    
    Parameters:
    
    title - The title of the progress bar
    
    total - The total number of records allowed in this progress bar
    
    Returns:
    
    The newly created progress bar
  - addAutoProgressBar
```
@NotNull
public AutoProgressBar addAutoProgressBar(java.lang.String key,
                                                    @NotNull
                                                    java.util.Collection<java.lang.String> values)
```
    Adds an auto progress bar to this loggers progress bars
    
    Parameters:
    
    key - The key in the session to use
    
    values - The values the progress bar can have. These should iterate in the same order they will be searched
    
    Returns:
    
    The new progress bar
  - removeProgressBar
```
public void removeProgressBar(@Nullable
                              ProgressBar progressBar)
```
    Removes the specified progress bar
    
    Parameters:
    
    progressBar - The progress bar to remove
  - getProgressBar
```
@Nullable
public ProgressBar getProgressBar(java.lang.String title)
```
    Returns the first progress bar with the given title, or null if none is found. Starts with the lowest level progress bar (most recently added)
    
    Parameters:
    
    title - The title to search for
    
    Returns:
    
    The lowest-level progress bar (most recently added) with the specified title, or null if no such bar exists
  - getProgressBar
```
@Nullable
public ProgressBar getProgressBar(int index)
```
    Returns the progress bar at the given index, with 0 being the highest level bar, and lower-level bars being sequentially larger in index
    
    Parameters:
    
    index - The desired ProgressBar's index
    
    Returns:
    
    The ProgressBar at the given index, or null if the index is out of range
  - getHighestLevelLogged
```
public int getHighestLevelLogged()
```
    Returns the highest level this logger has logged at.
    
    Returns:
    
    The highest level this logger has logged at.
  - getNumProgressBars
```
public int getNumProgressBars()
```
    Returns the number of progress bars currently available
    
    Returns:
    
    The number of progress bars in this logger
  - setLogUpperCaseDataRecordKeys
```
public void setLogUpperCaseDataRecordKeys(boolean logUpperCaseDataRecordKeys)
```
    Sets whether or not all uppercase keys of a datarecord should be logged
    
    Parameters:
    
    logUpperCaseDataRecordKeys - True to log all uppercase keys, false otherwise
  - setLogLowerCaseDataRecordKeys
```
public void setLogLowerCaseDataRecordKeys(boolean logLowerCaseDataRecordKeys)
```
    Sets whether or not all lowercase keys of a datarecord should be logged
    
    Parameters:
    
    logLowerCaseDataRecordKeys - True to log all lowercase keys, false otherwise
  - setLogMixedCaseDataRecordKeys
```
public void setLogMixedCaseDataRecordKeys(boolean logMixedCaseDataRecordKeys)
```
    Sets whether or not keys of a datarecord with both upper and lowercase characters should be logged
    
    Parameters:
    
    logMixedCaseDataRecordKeys - True to log keys with both upper and lowercase characters, false otherwise

Class ScrapeStateLogger

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScrapeStateLogger

ScrapeStateLogger

Method Detail

getLastRecordCountIncrementTime

getMonitoredPrefixes

getMonitoredPostfixes

isLogLowerCaseDataRecordKeys

isLogUpperCaseDataRecordKeys

isLogMixedCaseDataRecordKeys

reset

updateLastRecordCountIncrementTime

addValue

removeValue

writeToLog

setNumMessagesToSave

getNumMessagesToSave

webMessage

buildWebMessage

getWebProgress

getWebTimestamp

getWebDivider

getMainWebHeader

getGeneralInfoVariables

getMonitoredVariables

getCustomHTMLHeader

setCustomHTMLHeader

getSavedMessages

saveMessage

addMonitoredVariable

addMonitoredPrefix

addMonitoredPostfix

removeMonitoredVariable

removeMonitoredPrefix

removeMonitoredPostfix

removeAllMonitoredVariables

duplicate

addProgressBar

addAutoProgressBar

removeProgressBar

getProgressBar

getProgressBar

getHighestLevelLogged

getNumProgressBars

setLogUpperCaseDataRecordKeys

setLogLowerCaseDataRecordKeys

setLogMixedCaseDataRecordKeys