com.screenscraper.scraper

Class ScriptManager

java.lang.Object

com.screenscraper.scraper.ScriptManager

public class ScriptManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	ScriptManager.ComboBoxRenderer

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.
static java.util.concurrent.locks.ReentrantReadWriteLock	SCRIPT_TEXT_LOCK A lock used to get script text.

Constructor Summary

Constructors

Constructor and Description
ScriptManager()

Method Summary

Modifier and Type	Method and Description
static Script	addNewScript(Folder folder) Adds a new blank script.
static void	addRecentScript(Script script) Adds a recently used script.
static void	addScript(Script script) Adds a Script
static void	dumpToLog() Dumps all of the scripts to the log.
static java.util.HashSet	extractInvokedScriptsFromScrapingSession(ScrapingSession scrapingSession) Extracts Scripts invoked in the given ScrapingSession and returns them.
static void	generateScriptsComboBox(java.lang.String forScrapingSession) Generates (or re-generates) the JComboBox that holds all of the scripts.
static java.util.concurrent.ExecutorService	getExecutorService() Gets a reference to the executor service.
static Script	getMostRecentScript() Gets the most recently accessed script.
static int	getNumScripts() Gets the number of Scripts held by the manager.
static int	getNumScriptsWithName(java.lang.String scriptName) Gets the number of scripts carrying the given name.
static Script	getScript(int scriptID) I'm probably just being lazy, but this allows easy access to any of the scripts,
static Script	getScript(java.lang.String scriptName) I'm probably just being lazy, but this allows easy access to any of the scripts,
static Script	getScriptBySequence(int sequence) Gets a Script based on a sequence, assuming the scraping sessions are sorted alphabetically.
static java.util.Set<Script>	getScripts() Gets a HashSet of Script objects.
static java.util.TreeSet<Script>	getScriptsAsTreeSet() Returns a sorted TreeSet containing the Script objects.
static javax.swing.JComboBox	getScriptsComboBox(java.lang.String forScrapingSession) Gets a reference to the JComboBox holding all of the scripts.
static java.util.Iterator	getScriptsIterator() Returns an Iterator over which the scripts can be cycled.
static int	getSequenceForScript(Script script) Gets the sequence for a script.
static void	hotSwapScriptsFromDatabase() Hot swaps scripts by loading them from the database.
static void	hotSwapScriptsFromFiles() Checks for existing scripts in the "import" directory, and if they exist, hot swaps them in.
static boolean	importScript(Script script, Folder folder, boolean promptForOverwrite)
static int	importScripts(java.util.HashSet<Script> scripts, Folder folder, boolean promptForOverwrite) Iterates through and imports scripts.
static void	loadScripts() Loads the model with all scripts found in the database.
static void	removeAllScripts() Removes all scripts.
static void	removeScript(Script script) Removes a Script and any corresponding ScriptInstance objects.
static void	removeScriptInstances(ScriptInstances scriptInstances, Script script) Removes any ScriptInstance objects found within the given ScriptInstances object corresponding to the given Script object.
static void	replaceScript(Script script) Replaces the script (if found) with the name matching the given one.
static void	replaceScriptsOnScrapingSession(ScrapingSession scrapingSession) After the user has imported a scraping session they may have elected to not import some of the scripts associated with the scraping session.
static void	saveScripts() Saves all scripts.

Methods inherited from class java.lang.Object

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

Field Detail

SCRIPT_TEXT_LOCK

public static java.util.concurrent.locks.ReentrantReadWriteLock SCRIPT_TEXT_LOCK

A lock used to get script text. Locking the write lock allows importing scrapes and preventing new scripts from executing while the import occurs

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

ScriptManager

public ScriptManager()

Method Detail

getScript

public static Script getScript(int scriptID)

I'm probably just being lazy, but this allows easy access to any of the scripts,

Parameters:

scriptID - The ID of the desired script.

Returns:

The Script.

getScript

public static Script getScript(java.lang.String scriptName)

I'm probably just being lazy, but this allows easy access to any of the scripts,

Parameters:

scriptName - The name of the desired script.

Returns:

The Script.

getNumScriptsWithName

public static int getNumScriptsWithName(java.lang.String scriptName)

Gets the number of scripts carrying the given name. Used to ensure that we don't get duplicate names.

Parameters:

scriptName - The name of the desired script.

Returns:

The number of scripts with the name.

getScripts

@NotNull
public static java.util.Set<Script> getScripts()

Gets a HashSet of Script objects.

Returns:

The scripts.

removeAllScripts

public static void removeAllScripts()

Removes all scripts.

getNumScripts

public static int getNumScripts()

Gets the number of Scripts held by the manager.

Returns:

The number.

getScriptsAsTreeSet

public static java.util.TreeSet<Script> getScriptsAsTreeSet()

Returns a sorted TreeSet containing the Script objects.

Returns:

A TreeSet.

getScriptsIterator

public static java.util.Iterator getScriptsIterator()

Returns an Iterator over which the scripts can be cycled.

Returns:

The Iterator.

getSequenceForScript

public static int getSequenceForScript(@NotNull
                                       Script script)

Gets the sequence for a script.

Parameters:

script - The Script.

Returns:

The sequence.

getScriptBySequence

public static Script getScriptBySequence(int sequence)

Gets a Script based on a sequence, assuming the scraping sessions are sorted alphabetically.

Parameters:

sequence - The sequence corresponding to the desired Script.

Returns:

The Script if the sequence is valid. Returns null, otherwise.

addScript

public static void addScript(@Nullable
                             Script script)

Adds a Script

Parameters:

script - The Script to be added.

addNewScript

@NotNull
public static Script addNewScript(Folder folder)

Adds a new blank script.

Parameters:

folder - The folder that will contain the new script.

Returns:

The generated script.

loadScripts

public static void loadScripts()

Loads the model with all scripts found in the database.

removeScriptInstances

public static void removeScriptInstances(@NotNull
                                         ScriptInstances scriptInstances,
                                         @Nullable
                                         Script script)

Removes any ScriptInstance objects found within the given ScriptInstances object corresponding to the given Script object.

Parameters:

scriptInstances - The ScriptInstances.

script - The Script to match.

removeScript

public static void removeScript(@NotNull
                                Script script)

Removes a Script and any corresponding ScriptInstance objects.

Parameters:

script - The Script to remove.

saveScripts

public static void saveScripts()

Saves all scripts.

replaceScript

public static void replaceScript(@NotNull
                                 Script script)

Replaces the script (if found) with the name matching the given one.

Parameters:

script - The Script to replace.

hotSwapScriptsFromFiles

public static void hotSwapScriptsFromFiles()

Checks for existing scripts in the "import" directory, and if they exist, hot swaps them in.

hotSwapScriptsFromDatabase

public static void hotSwapScriptsFromDatabase()

Hot swaps scripts by loading them from the database.

importScript

public static boolean importScript(Script script,
                                   Folder folder,
                                   boolean promptForOverwrite)
                            throws ImportScriptException

Parameters:

script - Script to import

folder - The Folder to contain the script

promptForOverwrite - True if a prompt should be shown for overwriting existing script, false otherwise

Returns:

Returns boolean if script was added

Throws:

ImportScriptException - On import error

importScripts

public static int importScripts(@NotNull
                                java.util.HashSet<Script> scripts,
                                Folder folder,
                                boolean promptForOverwrite)
                         throws ImportScriptException

Iterates through and imports scripts. Overwrites existing scripts based on user input.

Parameters:

scripts - HashSet

• Summary:
• Nested |
• Field |
• Constr |
• Method

• Detail:
• Field |
• Constr |
• Method