com.screenscraper.util

Class AutoProgressBar

java.lang.Object

com.screenscraper.util.ProgressBar

com.screenscraper.util.AutoProgressBar

public class AutoProgressBar
extends ProgressBar

Progress Bars that automatically update based on a given list. This class is available in the compiled code only (not in the script)

Field Summary

Fields inherited from class com.screenscraper.util.ProgressBar

creationTime, currentRecord, lastUpdate, progress, progressBars, session, totalRecords

Constructor Summary

Constructors

Constructor and Description
AutoProgressBar(ScrapingSession session, java.util.List<ProgressBar> progressBarList, java.lang.String sessionKey, java.util.Collection<java.lang.String> values) Builds a progress bar that will track itself using given values
AutoProgressBar(ScrapingSession session, java.util.List<ProgressBar> progressBarList, java.lang.String sessionKey, java.lang.String... values) Builds a progress bar that will track itself using given values

Method Summary

Modifier and Type	Method and Description
boolean	autoUpdateProgressLevel() Automatically updates the progress of this bar, base on the value of the appropriate session variable
boolean	equals(java.lang.Object o) Checks to see if this is equal to another object.
java.lang.String[]	getLogDisplay() Get the lines to show for this progress bar in the log
java.lang.String	getSessionKey() Returns the value this progress bar watches for in the session variable keys
java.lang.String	getWebDisplay() Generates the HTML code for this progress bar.
void	reset() Resets the values for this progress bar, as if it had been just barely created

Methods inherited from class com.screenscraper.util.ProgressBar

add, getCreationTime, getCurrent, getIndex, getPercent, getRemainingTime, getTitle, getTotal, setCreationTime, setCurrent, setCurrent, setPercent, setProgress, setProgress, setTitle, setTotal, setTotal, updateProgress

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoProgressBar

public AutoProgressBar(ScrapingSession session,
                       java.util.List<ProgressBar> progressBarList,
                       java.lang.String sessionKey,
                       java.lang.String... values)

Builds a progress bar that will track itself using given values

Parameters:

session - The scraping session this progress bar is attached to

progressBarList - The list of progress bars this is linked to

sessionKey - The sessionKey (session variable) this uses to track it's progress

values - The values that can be set for this bar

AutoProgressBar

public AutoProgressBar(ScrapingSession session,
                       java.util.List<ProgressBar> progressBarList,
                       java.lang.String sessionKey,
                       @NotNull
                       java.util.Collection<java.lang.String> values)

Builds a progress bar that will track itself using given values

Parameters:

session - The scraping session this progress bar is attached to

progressBarList - The list of progress bars this is linked to

sessionKey - The sessionKey (session variable) this uses to track it's progress

values - The values that can be set for this bar

Method Detail

getWebDisplay

public java.lang.String getWebDisplay()

Generates the HTML code for this progress bar.

Overrides:

getWebDisplay in class ProgressBar

Returns:

HTML code for the web interface to show this progress bar

getLogDisplay

public java.lang.String[] getLogDisplay()

Get the lines to show for this progress bar in the log

Overrides:

getLogDisplay in class ProgressBar

Returns:

An array of strings to write to the log to show this progress bar

autoUpdateProgressLevel

public boolean autoUpdateProgressLevel()

Automatically updates the progress of this bar, base on the value of the appropriate session variable

Returns:

True if this progress bar is still valid, false if there was no corresponding value to match

reset

public void reset()

Resets the values for this progress bar, as if it had been just barely created

getSessionKey

public java.lang.String getSessionKey()

Returns the value this progress bar watches for in the session variable keys

Returns:

The session variable name this progress bar uses to determine it's progress

equals

public boolean equals(java.lang.Object o)

Checks to see if this is equal to another object. In this case, it is equal if the other object is an AutoProgressBar and the key they are watching for is the same (doesn't care about the list of values)

Overrides:

equals in class java.lang.Object

Parameters:

o - The other object

Returns:

True if o is an AutoProgressBar and the session variable watched by o is the same as the one watched by this bar