com.screenscraper.scraper

Class Script

java.lang.Object

com.screenscraper.scraper.Script

All Implemented Interfaces:

Deleteable, Folderable, Uniqueable, java.awt.datatransfer.Transferable, java.lang.Comparable

public class Script
extends java.lang.Object
implements Deleteable, java.lang.Comparable, java.awt.datatransfer.Transferable, Folderable, Uniqueable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LANGUAGE The default language.
(package private) static java.awt.datatransfer.DataFlavor[]	flavors
static java.awt.datatransfer.DataFlavor	INFO_FLAVOR Drag 'n drop stuff.
static java.lang.String	LANGUAGE_GROOVY
static java.lang.String	LANGUAGE_INTERPRETED_JAVA Possible values for the language.
static java.lang.String	LANGUAGE_JAVASCRIPT
static java.lang.String	LANGUAGE_JSCRIPT
static java.lang.String	LANGUAGE_PERL
static java.lang.String	LANGUAGE_PYTHON
static java.lang.String	LANGUAGE_VBSCRIPT
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
Script() Required by castor.
Script(int scriptID) Generates a new Script based on the ID.
Script(int scriptID, java.lang.String name, java.lang.String scriptText, java.lang.String language, int folderID, boolean overwriteOnImport) Generates a new Script.
Script(java.lang.String name) Generates a new Script.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object object) Required by the Comparable interface.
void	delete() Deletes the script from the database.
void	dumpToLog() Dumps the script to the log.
boolean	equals(java.lang.Object object) Overriding equals...
static javax.swing.JComboBox	getComboBoxForScripts(java.util.Set<Script> hsScripts) Takes a HashSet of Script objects and returns a JComboBox representing them all.
java.lang.String	getDateExported() Gets the date the scraping session was exported.
Folder	getFolder() Gets the folder containing this object.
int	getID() Gets the ID of the script.
java.lang.String	getIdentifier() Gets the identifier for this object.
java.lang.String	getLanguage() Gets the language.
java.lang.String	getName() Gets the name.
boolean	getNeedsToBeSaved() Indicates whether or not the object needs to be saved.
javax.swing.tree.DefaultMutableTreeNode	getNode() Gets the node representing this scraping file.
boolean	getOverwriteOnImport() Indicates whether or not this script should be overwritten on import.
static java.lang.String	getScriptIdentifier(java.lang.String languageName) Given a script language name, gets its BSF identifier.
java.lang.String	getScriptText() Gets the text of the script to be run.
java.lang.Object	getTransferData(java.awt.datatransfer.DataFlavor df)
java.awt.datatransfer.DataFlavor[]	getTransferDataFlavors()
static java.lang.Object[]	getValidScriptLanguages() Gets an array of valid script languages.
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor df) Transferable methods.
void	moveToNewFolder(Folder folder) Moves the object to a new folder.
static boolean	readerPointsToImportableScript(java.io.Reader reader) Indicates whether or not the given reader points to an importable script.
void	removeFromFolder() Removes the object from its current folder.
void	save() Saves the script to the database.
void	setDateExported(java.lang.String date) Sets the date the scraping session was exported.
void	setFolder(Folder folder) Sets the folder containing this object.
void	setID(int scriptID) Sets the ID of the script.
void	setIdentifier(java.lang.String identifier) Sets the identifier for this object.
void	setLanguage(java.lang.String language) Sets the language.
void	setName(java.lang.String name) Sets the name.
void	setNeedsToBeSaved(boolean needsToBeSaved) Sets whether or not the object needs to be saved.
void	setNode(javax.swing.tree.DefaultMutableTreeNode node) Sets the node representing this scraping file.
void	setOverwriteOnImport(boolean overwriteOnImport) Determines whether or not this script should be overwritten on import.
void	setScriptText(java.lang.String scriptText) Gets the text of the script to be run.
java.lang.String	toString() Overridden so that the name appears as the title in the main tree.
static Script	unmarshalScript(java.io.Reader reader) Unmarshals a script from the given reader.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

LANGUAGE_INTERPRETED_JAVA

public static final java.lang.String LANGUAGE_INTERPRETED_JAVA

Possible values for the language.

See Also:

Constant Field Values

LANGUAGE_JAVASCRIPT

public static final java.lang.String LANGUAGE_JAVASCRIPT

See Also:

Constant Field Values

LANGUAGE_PYTHON

public static final java.lang.String LANGUAGE_PYTHON

See Also:

Constant Field Values

LANGUAGE_JSCRIPT

public static final java.lang.String LANGUAGE_JSCRIPT

See Also:

Constant Field Values

LANGUAGE_VBSCRIPT

public static final java.lang.String LANGUAGE_VBSCRIPT

See Also:

Constant Field Values

LANGUAGE_PERL

public static final java.lang.String LANGUAGE_PERL

See Also:

Constant Field Values

LANGUAGE_GROOVY

public static final java.lang.String LANGUAGE_GROOVY

See Also:

Constant Field Values

DEFAULT_LANGUAGE

public static final java.lang.String DEFAULT_LANGUAGE

The default language.

See Also:

Constant Field Values

INFO_FLAVOR

public static final java.awt.datatransfer.DataFlavor INFO_FLAVOR

Drag 'n drop stuff.

flavors

@NotNull
static java.awt.datatransfer.DataFlavor[] flavors

Constructor Detail

Script

public Script()

Required by castor.

Script

public Script(@Nullable
              java.lang.String name)

Generates a new Script.

Parameters:

name - A name to identify the file.

Script

public Script(int scriptID)

Generates a new Script based on the ID. The script will load itself up with its basic data.

Parameters:

scriptID - The ID of the script.

Script

public Script(int scriptID,
              @Nullable
              java.lang.String name,
              java.lang.String scriptText,
              @Nullable
              java.lang.String language,
              int folderID,
              boolean overwriteOnImport)

Generates a new Script.

Parameters:

scriptID - The ID of the script.

name - A name to identify the file.

scriptText - The text of the script to be run.

language - The scripting language the script is written in.

folderID - The ID of the folder containing the object.

overwriteOnImport - Indicates whether or not the script should be overwritten on import.

Method Detail

getScriptIdentifier

@Nullable
public static java.lang.String getScriptIdentifier(@Nullable
                                                              java.lang.String languageName)

Given a script language name, gets its BSF identifier.

Parameters:

languageName - The name of the language.

Returns:

The BSF identifier.

getOverwriteOnImport

public boolean getOverwriteOnImport()

Indicates whether or not this script should be overwritten on import.

Returns:

A boolean.

setOverwriteOnImport

public void setOverwriteOnImport(boolean overwriteOnImport)

Determines whether or not this script should be overwritten on import.

Parameters:

overwriteOnImport - A boolean.

unmarshalScript

@NotNull
public static Script unmarshalScript(java.io.Reader reader)
                                        throws org.exolab.castor.mapping.MappingException,
                                               java.io.IOException,
                                               org.exolab.castor.xml.ValidationException,
                                               org.exolab.castor.xml.MarshalException

Unmarshals a script from the given reader.

Parameters:

reader - A Reader stream containing the script to be unmarshalled.

Returns:

The script reference

Throws:

org.exolab.castor.mapping.MappingException

java.io.IOException

org.exolab.castor.xml.ValidationException

org.exolab.castor.xml.MarshalException

getValidScriptLanguages

@Nullable
public static java.lang.Object[] getValidScriptLanguages()

Gets an array of valid script languages.

Returns:

The script languages.

getName

@Nullable
public java.lang.String getName()

Gets the name.

Returns:

The name.

setName

public void setName(@Nullable
                    java.lang.String name)

Sets the name.

Parameters:

name - The name.

getScriptText

public java.lang.String getScriptText()

Gets the text of the script to be run.

Returns:

The script text.

setScriptText

public void setScriptText(java.lang.String scriptText)

Gets the text of the script to be run.

Parameters:

scriptText - The text of the script.

getFolder

@Nullable
public Folder getFolder()

Gets the folder containing this object.

Specified by:

getFolder in interface Folderable

Returns:

The folder.

setFolder

public void setFolder(@Nullable
                      Folder folder)

Sets the folder containing this object.

Specified by:

setFolder in interface Folderable

Parameters:

folder - The folder.

removeFromFolder

public void removeFromFolder()

Removes the object from its current folder.

Specified by:

removeFromFolder in interface Folderable

moveToNewFolder

public void moveToNewFolder(Folder folder)

Moves the object to a new folder.

Specified by:

moveToNewFolder in interface Folderable

Parameters:

folder - The Folder to which the object should be moved.

getLanguage

@Nullable
public java.lang.String getLanguage()

Gets the language.

Returns:

The language.

setLanguage

public void setLanguage(@Nullable
                        java.lang.String language)

Sets the language.

Parameters:

language - The language.

setNode

public void setNode(@Nullable
                    javax.swing.tree.DefaultMutableTreeNode node)

Sets the node representing this scraping file.

Parameters:

node - A DefaultMutableTreeNode.

getNode

@Nullable
public javax.swing.tree.DefaultMutableTreeNode getNode()

Gets the node representing this scraping file.

Returns:

A DefaultMutableTreeNode.

getID

public int getID()

Gets the ID of the script.

Returns:

The id of the script

setID

public void setID(int scriptID)

Sets the ID of the script.

Parameters:

scriptID - The ID.

toString

@Nullable
public java.lang.String toString()

Overridden so that the name appears as the title in the main tree.

Overrides:

toString in class java.lang.Object

Returns:

The name of the session.

getComboBoxForScripts

@NotNull
public static javax.swing.JComboBox getComboBoxForScripts(@NotNull
                                                                    java.util.Set<Script> hsScripts)

Takes a HashSet of Script objects and returns a JComboBox representing them all.

Parameters:

hsScripts - A HashSet of Script objects.

Returns:

A JComboBox.

save

public void save()

Saves the script to the database.

delete

public void delete()

Deletes the script from the database.

Specified by:

delete in interface Deleteable

getDateExported

@Nullable
public java.lang.String getDateExported()

Gets the date the scraping session was exported.

Returns:

The date as a string.

setDateExported

public void setDateExported(@Nullable
                            java.lang.String date)

Sets the date the scraping session was exported.

Parameters:

date - The date as a string.

compareTo

public int compareTo(java.lang.Object object)

Required by the Comparable interface.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

object - The object to compare to.

Returns:

An int indicating how the given object compares to this object.

equals

public boolean equals(@Nullable
                      java.lang.Object object)

Overriding equals...

Overrides:

equals in class java.lang.Object

Parameters:

object - The object we're comparing.

readerPointsToImportableScript

public static boolean readerPointsToImportableScript(@NotNull
                                                     java.io.Reader reader)

Indicates whether or not the given reader points to an importable script.

Parameters:

reader - A Reader used to reader the characters.

Returns:

A boolean.

isDataFlavorSupported

public boolean isDataFlavorSupported(@NotNull
                                     java.awt.datatransfer.DataFlavor df)

Transferable methods.

Specified by:

isDataFlavorSupported in interface java.awt.datatransfer.Transferable

getTransferData

@NotNull
public java.lang.Object getTransferData(@NotNull
                                                  java.awt.datatransfer.DataFlavor df)
                                           throws java.awt.datatransfer.UnsupportedFlavorException,
                                                  java.io.IOException

Specified by:

getTransferData in interface java.awt.datatransfer.Transferable

Throws:

java.awt.datatransfer.UnsupportedFlavorException

java.io.IOException

getTransferDataFlavors

@NotNull
public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()

Specified by:

getTransferDataFlavors in interface java.awt.datatransfer.Transferable

getNeedsToBeSaved

public boolean getNeedsToBeSaved()

Indicates whether or not the object needs to be saved.

Returns:

A boolean.

setNeedsToBeSaved

public void setNeedsToBeSaved(boolean needsToBeSaved)

Sets whether or not the object needs to be saved.

Parameters:

needsToBeSaved - A boolean.

getIdentifier

@Nullable
public java.lang.String getIdentifier()

Description copied from interface: Uniqueable

Gets the identifier for this object.

Specified by:

getIdentifier in interface Uniqueable

Returns:

The identifier.

setIdentifier

public void setIdentifier(@Nullable
                          java.lang.String identifier)

Description copied from interface: Uniqueable

Sets the identifier for this object.

Specified by:

setIdentifier in interface Uniqueable

Parameters:

identifier - The identifier.

dumpToLog

public void dumpToLog()

Dumps the script to the log.