com.screenscraper.scraper

Class ScriptInstances

java.lang.Object

com.screenscraper.scraper.ScriptInstances

public class ScriptInstances
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
ScriptInstances() Required by castor.
ScriptInstances(ScriptInstances scriptInstances) Creates a new ScriptInstances by copying the one passed in.
ScriptInstances(ScriptInstancesContainer owner) Creates a new Scriptinstances for the given context.

Method Summary

Modifier and Type	Method and Description
void	addScriptInstance(ScriptInstance scriptInstance) Adds a script instance to the collection.
void	delete() Deletes the script instances from the database.
void	dumpToLog() Dumps the script instance objects to the log.
int	getDefaultWhenToRunValue() Gets the default "WHENTORUN" value given the context of the script instances.
int	getNumScriptInstances() Gets the number of ScriptInstance objects.
java.lang.Object	getOwner() Gets the owner of the script instances.
java.lang.String	getOwnerName() The following are needed only for castor.
java.lang.String	getOwnerType()
java.util.Iterator	getScriptInstacesIterator() Gets an Iterator over which the script instances can be iterated.
ScriptInstance	getScriptInstance(int sequence) Gets a script instance from the session.
java.util.TreeSet<ScriptInstance>	getScriptInstances() Gets all script instances held by this object.
int	getTotalScriptInstances() Gets the total number of script instances held by this object.
javax.swing.JComboBox	getValidWhenToRunValuesAsComboBox() Gets valid "WHENTORUN" values for this script instances, given the context.
boolean	isLoaded() Indicates whether or not the object has been loaded.
void	load() Loads up the script instances.
void	processScripts(int whenToRun, ScriptContext scriptContext) Processes the scripts associated with this object.
void	removeScriptInstance(int sequence) Removes a script instance.
void	reset() Resets the script instances so that it doesn't use more memory than it needs to.
void	save() Saves the script instances to the database.
void	setNotifiable(Notifiable notifiable) Sets the object the script instances will use to notify when things happen.
void	setOwner(ScriptInstancesContainer owner) Sets the owner of the script instances.
void	setOwnerName(java.lang.String ownerName)
void	setOwnerType(java.lang.String ownerType)
void	setScriptInstances(java.util.TreeSet tsScriptInstances) Sets all script instances held by this object.
void	setSequencesOnScriptInstanceObjects() Sets the sequence value on each of the script instances based on the order indicated by the tree set.

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

ScriptInstances

public ScriptInstances()

Required by castor.

ScriptInstances

public ScriptInstances(ScriptInstancesContainer owner)

Creates a new Scriptinstances for the given context.

Parameters:

owner - The owner of the script instances. Can be a ScrapingSession, ScrapeableFile, or ExtractorPattern.

ScriptInstances

public ScriptInstances(@NotNull
                       ScriptInstances scriptInstances)

Creates a new ScriptInstances by copying the one passed in.

Parameters:

scriptInstances - The ScriptInstances to copy.

Method Detail

getOwner

@Nullable
public java.lang.Object getOwner()

Gets the owner of the script instances. Can be a ScrapingSession, ScrapeableFile, or ExtractorPattern.

Returns:

The owner.

setOwner

public void setOwner(@NotNull
                     ScriptInstancesContainer owner)

Sets the owner of the script instances. Can be a ScrapingSession, ScrapeableFile, or ExtractorPattern.

Parameters:

owner - The owner.

getOwnerName

@Nullable
public java.lang.String getOwnerName()

The following are needed only for castor.

setOwnerName

public void setOwnerName(java.lang.String ownerName)

getOwnerType

@Nullable
public java.lang.String getOwnerType()

setOwnerType

public void setOwnerType(java.lang.String ownerType)

addScriptInstance

public void addScriptInstance(@NotNull
                              ScriptInstance scriptInstance)

Adds a script instance to the collection.

Parameters:

scriptInstance - A ScriptInstance.

getScriptInstacesIterator

@NotNull
public java.util.Iterator getScriptInstacesIterator()

Gets an Iterator over which the script instances can be iterated.

Returns:

The Iterator.

removeScriptInstance

public void removeScriptInstance(int sequence)

Removes a script instance.

Parameters:

sequence - The sequence.

setSequencesOnScriptInstanceObjects

public void setSequencesOnScriptInstanceObjects()

Sets the sequence value on each of the script instances based on the order indicated by the tree set.

getScriptInstance

@Nullable
public ScriptInstance getScriptInstance(int sequence)

Gets a script instance from the session.

Parameters:

sequence - The sequence of the script to be retrieved.

getScriptInstances

public java.util.TreeSet<ScriptInstance> getScriptInstances()

Gets all script instances held by this object. Note that this is currently only used by castor.

Returns:

A HashSet of ScriptInstance objects.

getNumScriptInstances

public int getNumScriptInstances()

Gets the number of ScriptInstance objects.

Returns:

The number.

setScriptInstances

public void setScriptInstances(java.util.TreeSet tsScriptInstances)

Sets all script instances held by this object.

Parameters:

tsScriptInstances - A HashSet of ScriptInstance objects.

getTotalScriptInstances

public int getTotalScriptInstances()

Gets the total number of script instances held by this object.

Returns:

The total.

setNotifiable

public void setNotifiable(Notifiable notifiable)

Sets the object the script instances will use to notify when things happen.

Parameters:

notifiable - The object.

getValidWhenToRunValuesAsComboBox

@NotNull
public javax.swing.JComboBox getValidWhenToRunValuesAsComboBox()

Gets valid "WHENTORUN" values for this script instances, given the context.

Returns:

An array of "WHENTORUN" variables, as defined in ScriptInstance.

getDefaultWhenToRunValue

public int getDefaultWhenToRunValue()

Gets the default "WHENTORUN" value given the context of the script instances.

Returns:

The "WHENTORUN" value.

save

public void save()

Saves the script instances to the database.

delete

public void delete()

Deletes the script instances from the database.

isLoaded

public boolean isLoaded()

Indicates whether or not the object has been loaded.

Returns:

A boolean.

load

public void load()

Loads up the script instances. y++

reset

public void reset()

Resets the script instances so that it doesn't use more memory than it needs to.

processScripts

public void processScripts(int whenToRun,
                           @NotNull
                           ScriptContext scriptContext)
                    throws ScriptException

Processes the scripts associated with this object.

Parameters:

whenToRun - Determines which scripts are to be executed based on their "whenToRun" value.

scriptContext - The context in which the scripts should be run.

Throws:

ScriptException

dumpToLog

public void dumpToLog()

Dumps the script instance objects to the log.