com.screenscraper.data

Class DScrapingSession

java.lang.Object

com.screenscraper.data.DScrapingSession

public class DScrapingSession
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
DScrapingSession()

Method Summary

Modifier and Type	Method and Description
static void	blankScrapeableFileLastRequest() Blanks out the last request of all scrapeable files.
static void	blankScrapeableFileLastScrapedData() Blanks out the last scraped data of all scrapeable files.
static void	clearMappingSetID(int mappingSetID) Clears the mapping set value from the extractor pattern tokens corresponding to the given mapping set ID.
static void	deleteExtractorPattern(int extractorPatternID) Deletes an extractor pattern from the database.
static void	deleteExtractorPatternTokens(int extractorPatternID) Deletes all extractor pattern tokens corresponding to an extractor pattern.
static void	deleteHTTPParameters(int scrapeableFileID) Delets all HTTP parameters corresponding to the given scrapeable file.
static void	deleteScheduledScrapingSession(int scheduledScrapingSessionID) Deletes a ScheduledScrapingSession from the database.
static void	deleteScheduledScrapingSessionByScrapingSessionID(int scrapingSessionID) Deletes all ScheduledScrapingSession objects corresponding to the given scraping session.
static void	deleteScrapeableFile(int scrapeableFileID) Deletes a scrapeable file from the database.
static void	deleteScrapeableSession(int scrapeableSessionID) Deletes a ScrapeableSession from the database.
static void	deleteScrapeableSessionByScrapingSessionID(int scrapingSessionID) Deletes all ScrapeableSession objects corresponding to the given scraping session.
static void	deleteScrapeableSessionsByStartTime(long startTime) Deletes all ScrapeableSession records from the database whose start_time value exceeds the given one.
static void	deleteScrapingSession(int scrapingSessionID) Deletes a scraping session from the database.
static void	deleteScript(int scriptID) Deletes a script from the database.
static void	deleteScriptInstance(int scrapingSessionID, int scrapeableFileID, int extractorPatternID) Deletes a script instance from the database.
static void	deleteScriptInstance(int scrapingSessionID, int scrapeableFileID, int extractorPatternID, int httpSessionID) Deletes a script instance from the database based on its containing object.
static void	deleteScriptInstance(int scrapingSessionID, int scrapeableFileID, int extractorPatternID, int httpSessionID, int sequence, int whenToRun) Deletes a specific script instance from the database.
static void	deleteScriptInstances(int scrapingSessionID, int scrapeableFileID, int extractorPatternID, int httpSessionID) Deletes all script instances corresponding to a scraping session, scrapeable file or extractor pattern.
static void	deleteSubExtractorPatterns(int parentExtractorPatternID) Deletes any sub-extractor patterns corresponding to the given parent extractor pattern ID.
static java.sql.ResultSet	getAllScrapingSessions() Get all scraping sessions from the database.
static java.sql.ResultSet	getAllScripts() Get all scripts from the database.
static java.lang.String	getExtractorPatternIdentifierForID(int extractorPatternID) Gets the identifier of an extractor pattern, given its ID.
static java.sql.ResultSet	getExtractorPatternsForScrapeableFileID(int scrapeableFileID) Get all extractor patterns from the database corresponding to the given scrapeable file.
static java.sql.ResultSet	getExtractorPatternsWithNoParent() Gets the ID's of the sub-extractor pattern records which have no corresponding parent extractor pattern record.
static java.sql.ResultSet	getExtractorPatternsWithNoScrapeableFile() Gets the ID's of the extractor pattern records which have no corresponding scrapeable file record.
static java.sql.ResultSet	getExtractorPatternTokens(int extractorPatternID) Gets all extractor pattern tokens corresponding to an extractor pattern.
static java.sql.ResultSet	getHTTPParametersForScrapeableFileID(int scrapeableFileID) Get all HTTP parameters from the database corresponding to the given scrapeable file.
static java.sql.ResultSet	getLE() Gets the email address of the licensee.
static java.sql.ResultSet	getPV() Gets the date the app was first run.
static java.sql.ResultSet	getScheduledScrapingSessions() Gets all ScheduledScrapingSession objects contained in the database.
static java.sql.ResultSet	getScrapeableFile(int scrapeableFileID) Gets all information for a ScrapeableFile.
static int	getScrapeableFileIDForExtractorPatternID(int extractorPatternID) Gets the scrapeable file ID corresponding to the given extractor pattern ID.
static java.lang.String	getScrapeableFileNameForScrapeableFileID(int scrapeableFileID) Gets the scrapeable file name corresponding to the given scrapeable file ID.
static java.sql.ResultSet	getScrapeableFilesBasicForScrapingSessionID(int scrapingSessionID) Get all scrapeable files from the database corresponding to the given scraping session.
static java.sql.ResultSet	getScrapeableSessions() Gets all ScrapeableSession objects contained in the database.
static java.lang.String	getScrapingSessionNameByScrapeableFileID(int scrapeableFileID) Gets the scraping session name corresponding to the scrapeable file ID.
static java.sql.ResultSet	getScript(int scriptID) Gets all information for a script based on its ID.
static java.sql.ResultSet	getScript(java.lang.String scriptName) Gets all information for a script based on its name.
static java.sql.ResultSet	getScriptInstances(int scrapingSessionID, int scrapeableFileID, int extractorPatternID, int httpSessionID) Gets script instances for a scraping session, scrapeable file, or extractor pattern.
static java.sql.ResultSet	getSubExtractorPatterns(int parentExtractorPatternID) Gets child extractor patterns corresponding to the given parent extractor pattern ID.
static void	replaceScrapingSessionOnScheduledScrapingSession(int existingScrapingSessionID, int newScrapingSessionID) Updates all scheduled scraping session records with a new scraping session ID.
static void	replaceScrapingSessionOnScrapeableSession(int existingScrapingSessionID, int newScrapingSessionID) Updates all scrapeable session records with a new scraping session ID.
static java.sql.ResultSet	searchExtractorPatterns(java.lang.String textToFind, boolean isCaseSensitive) Searches the extractorpattern table for the given text.
static java.sql.ResultSet	searchHTTPParameters(java.lang.String textToFind, boolean isCaseSensitive) Searches the httpparameter table for the given text.
static java.sql.ResultSet	searchScrapeableFiles(java.lang.String textToFind, boolean isCaseSensitive) Searches the scrapeablefile table for the given text.
static java.sql.ResultSet	searchScrapingSessions(java.lang.String textToFind, boolean isCaseSensitive) Searches the scrapingsession table for the given text.
static java.sql.ResultSet	searchScripts(java.lang.String textToFind, boolean isCaseSensitive) Searches the script table for the given text.
static int	setExtractorPattern(int extractorPatternID, int scrapeableFileID, int parentExtractorPatternID, java.lang.String identifier, java.lang.String patternText, int sequence, boolean automaticallySaveInSessionVariable, boolean applyWhitespaceTidyingBeforeExtraction, int ifSavedInSessionVariable, boolean filterDuplicates, boolean cacheDataSet, java.lang.String fileToSaveTo, java.lang.String fileToSaveToDelimiter, boolean willBeInvokedManually) Saves an extractor pattern to the database.
static void	setExtractorPatternToken(int extractorPatternID, java.lang.String identifier, boolean excludeFromData, int sequence, boolean saveInSessionVariable, java.lang.String regularExpression, boolean compoundKey, boolean stripHTML, boolean resolveRelativeURL, boolean replaceHTMLEntities, boolean trimWhiteSpace, boolean nullSessionVariable, int mappingSetID) Saves an extractor pattern to the database.
static int	setHTTPParameter(int httpParameterID, int scrapeableFileID, java.lang.String key, java.lang.String value, int sequence, java.lang.String httpParameterType) Saves an HTTP parameter to the database.
static void	setLE(java.lang.String ea) Sets the email address of the licensee.
static void	setPV(long pv) Inserts a value into the PV column of control.
static int	setScheduledScrapingSession(ScheduledScrapingSession scheduledScrapingSession) Saves a ScheduledScrapingSession to the database.
static int	setScrapeableFile(int scrapeableFileID, int scrapingSessionID, java.lang.String name, java.lang.String url, int sequence, java.lang.String BASICAuthenticationUsername, java.lang.String BASICAuthenticationPassword, java.lang.String lastRequest, java.lang.String lastScrapedData, boolean willBeInvokedManually, int tidyHTML, java.lang.String requestEntity, int httpTransactionID) Saves a scrapeable file to the database.
static int	setScrapeableSession(ScrapeableSession scrapeableSession) Saves a ScrapeableSession to the database.
static int	setScrapingSession(int scrapingSessionID, java.lang.String name, int cookiePolicy, int httpClient, int maxHTTPRequests, java.lang.String externalProxyUsername, java.lang.String externalProxyPassword, java.lang.String externalProxyHost, java.lang.String externalProxyPort, java.lang.String externalNTProxyUsername, java.lang.String externalNTProxyPassword, java.lang.String externalNTProxyHost, java.lang.String externalNTProxyDomain, boolean useStrictMode, int folderID, java.lang.String notes, boolean anonymize, boolean terminateProxiesOnCompletion, int numberOfRequiredProxies, int originatorEdition, int loggingLevel, java.lang.String characterSet, java.lang.String keyStoreFilePath, java.lang.String keyStorePassword, boolean useOnlySSLv3, java.lang.String createdByVersion) Saves a scraping session to the database.
static int	setScript(int scriptID, java.lang.String name, java.lang.String scriptText, java.lang.String language, int folderID, boolean overwriteOnImport) Saves a script to the database.
static void	setScriptInstance(int scriptID, int scrapingSessionID, int scrapeableFileID, int extractorPatternID, int httpSessionID, int sequence, int whenToRun, boolean enabled) Saves a script instance to the database.
static void	updateExtractorPatternTokensWithNewMappingSet(int mappingSetIDToBeReplaced, int mappingSetIDToKeep) Updates all extractor pattern token records to use a new mapping set ID instead of the old one they were using.

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

DScrapingSession

public DScrapingSession()

Method Detail

setScript

public static int setScript(int scriptID,
                            java.lang.String name,
                            java.lang.String scriptText,
                            java.lang.String language,
                            int folderID,
                            boolean overwriteOnImport)

Saves a script to the database.

Parameters:

scriptID - The ID of the script.

name - The name of the script.

scriptText - The actual content of the script.

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.

Returns:

The ID of the script.

getAllScripts

public static java.sql.ResultSet getAllScripts()

Get all scripts from the database.

Returns:

A ResultSet containing all of the scripts.

deleteScript

public static void deleteScript(int scriptID)

Deletes a script from the database.

Parameters:

scriptID - The ID of the script.

getScript

public static java.sql.ResultSet getScript(int scriptID)

Gets all information for a script based on its ID.

Parameters:

scriptID - The ID of the script.

getScript

public static java.sql.ResultSet getScript(java.lang.String scriptName)

Gets all information for a script based on its name.

Parameters:

scriptName - The name of the script.

setScrapingSession

public static int setScrapingSession(int scrapingSessionID,
                                     java.lang.String name,
                                     int cookiePolicy,
                                     int httpClient,
                                     int maxHTTPRequests,
                                     java.lang.String externalProxyUsername,
                                     java.lang.String externalProxyPassword,
                                     java.lang.String externalProxyHost,
                                     java.lang.String externalProxyPort,
                                     java.lang.String externalNTProxyUsername,
                                     java.lang.String externalNTProxyPassword,
                                     java.lang.String externalNTProxyHost,
                                     java.lang.String externalNTProxyDomain,
                                     boolean useStrictMode,
                                     int folderID,
                                     java.lang.String notes,
                                     boolean anonymize,
                                     boolean terminateProxiesOnCompletion,
                                     int numberOfRequiredProxies,
                                     int originatorEdition,
                                     int loggingLevel,
                                     java.lang.String characterSet,
                                     java.lang.String keyStoreFilePath,
                                     java.lang.String keyStorePassword,
                                     boolean useOnlySSLv3,
                                     java.lang.String createdByVersion)

Saves a scraping session to the database.

Parameters:

scrapingSessionID - The ID of the scraping session.

name - The name of the script.

cookiePolicy - The cookie policy.

httpClient - The HTTP client.

maxHTTPRequests - The maximum HTTP requests.

externalProxyUsername - The external proxy username.

externalProxyPassword - The external proxy password.

externalProxyHost - The external proxy host.

externalProxyPort - The external proxy port.

externalNTProxyUsername - The external NT proxy username.

externalNTProxyPassword - The external NT proxy password.

externalNTProxyHost - The external NT proxy host.

externalNTProxyDomain - The external NT proxy domain.

useStrictMode - Whether or not strict mode should be used.

folderID - The ID of the folder containing the object.

notes - Any notes.

anonymize - Indicates whether the scraping session should be anonymized

terminateProxiesOnCompletion - Indicates whether the proxies should be terminated

numberOfRequiredProxies - The number of required proxies for the scrape

originatorEdition - The edition in which the scraping session was created

loggingLevel - The logging level to use when running the scraping session.

characterSet - The character set to use.

keyStoreFilePath - The path to the keystore file.

keyStorePassword - The keystore password.

useOnlySSLv3 - Whether or not only SSLv3 should be used.

createdByVersion - The version of ss that created this scraping session.

Returns:

The ID of the scraping session.

getAllScrapingSessions

public static java.sql.ResultSet getAllScrapingSessions()

Get all scraping sessions from the database.

Returns:

A ResultSet containing all of the scraping sessions.

deleteScrapingSession

public static void deleteScrapingSession(int scrapingSessionID)

Deletes a scraping session from the database.

Parameters:

scrapingSessionID - The ID of the scraping session.

deleteScriptInstances

public static void deleteScriptInstances(int scrapingSessionID,
                                         int scrapeableFileID,
                                         int extractorPatternID,
                                         int httpSessionID)

Deletes all script instances corresponding to a scraping session, scrapeable file or extractor pattern.

Parameters:

scrapingSessionID - The ID of the scraping session this is associated with.

scrapeableFileID - The ID of the scrapeable file this is associated with.

extractorPatternID - The ID of the extractor pattern this is associated with.

httpSessionID - The ID of the HTTP session this is associated with.

setScriptInstance

public static void setScriptInstance(int scriptID,
                                     int scrapingSessionID,
                                     int scrapeableFileID,
                                     int extractorPatternID,
                                     int httpSessionID,
                                     int sequence,
                                     int whenToRun,
                                     boolean enabled)

Saves a script instance to the database.

Parameters:

scriptID - The ID of the script this is an instance of.

scrapingSessionID - The ID of the scraping session this is associated with.

scrapeableFileID - The ID of the scrapeable file this is associated with.

extractorPatternID - The ID of the extractor pattern this is associated with.

httpSessionID - The ID of the HTTP session this is associated with.

sequence - The sequence in which the script should be run.

whenToRun - When the script is to be run

enabled - Indicates whether or not the script instance is enabled.

deleteScriptInstance

public static void deleteScriptInstance(int scrapingSessionID,
                                        int scrapeableFileID,
                                        int extractorPatternID,
                                        int httpSessionID,
                                        int sequence,
                                        int whenToRun)

Deletes a specific script instance from the database.

Parameters:

scrapingSessionID - The ID of the scraping session.

scrapeableFileID - The ID of the scrapeable file.

extractorPatternID - The ID of the extractor pattern.

httpSessionID - The ID of the HTTP session.

sequence - The sequence of the script.

whenToRun - When the script instance should be run.

deleteScriptInstance

public static void deleteScriptInstance(int scrapingSessionID,
                                        int scrapeableFileID,
                                        int extractorPatternID,
                                        int httpSessionID)

Deletes a script instance from the database based on its containing object.

Parameters:

scrapingSessionID - The ID of the scraping session.

scrapeableFileID - The ID of the scrapeable file.

extractorPatternID - The ID of the extractor pattern.

httpSessionID - The ID of the HTTP session.

deleteScriptInstance

public static void deleteScriptInstance(int scrapingSessionID,
                                        int scrapeableFileID,
                                        int extractorPatternID)

Deletes a script instance from the database.

Parameters:

scrapingSessionID - The ID of the scraping session.

scrapeableFileID - The ID of the scrapeable file.

extractorPatternID - The ID of the extractor pattern.

getScriptInstances

public static java.sql.ResultSet getScriptInstances(int scrapingSessionID,
                                                    int scrapeableFileID,
                                                    int extractorPatternID,
                                                    int httpSessionID)

Gets script instances for a scraping session, scrapeable file, or extractor pattern.

Parameters:

scrapingSessionID - The ID of the scraping session this is associated with.

scrapeableFileID - The ID of the scrapeable file this is associated with.

extractorPatternID - The ID of the extractor pattern this is associated with.

httpSessionID - The ID of the HTTP session this is associated with.

setScrapeableFile

public static int setScrapeableFile(int scrapeableFileID,
                                    int scrapingSessionID,
                                    java.lang.String name,
                                    java.lang.String url,
                                    int sequence,
                                    java.lang.String BASICAuthenticationUsername,
                                    java.lang.String BASICAuthenticationPassword,
                                    java.lang.String lastRequest,
                                    java.lang.String lastScrapedData,
                                    boolean willBeInvokedManually,
                                    int tidyHTML,
                                    java.lang.String requestEntity,
                                    int httpTransactionID)

Saves a scrapeable file to the database.

Parameters:

scrapeableFileID - The ID of the scrapeable file.

scrapingSessionID - The ID of the scraping session corresponding to this scrapeable file.

name - The name of the scrapeable file.

url - The url to be scraped.

sequence - The sequence in which the file is to be scraped.

BASICAuthenticationUsername - The BASIC authentication username.

BASICAuthenticationPassword - The BASIC authentication password.

lastRequest - The request from the last scraping.

lastScrapedData - The data extracted from the last scraping.

willBeInvokedManually - Whether or not the session will be invoked manually.

tidyHTML - How the HTML is to be tidied.

requestEntity - The request entity.

httpTransactionID - The ID of the HTTP transaction associated with this scrapeable file.

Returns:

The ID of the scrapeable file.

deleteScrapeableFile

public static void deleteScrapeableFile(int scrapeableFileID)

Deletes a scrapeable file from the database.

Parameters:

scrapeableFileID - The ID of the scrapeable file.

getScrapeableFilesBasicForScrapingSessionID

public static java.sql.ResultSet getScrapeableFilesBasicForScrapingSessionID(int scrapingSessionID)

Get all scrapeable files from the database corresponding to the given scraping session.

Parameters:

scrapingSessionID - The ID of the scraping session.

Returns:

A ResultSet containing the scrapeable files.

getScrapeableFile

public static java.sql.ResultSet getScrapeableFile(int scrapeableFileID)

Gets all information for a ScrapeableFile.

Parameters:

scrapeableFileID - The ID of the ScrapeableFile to be loaded.

deleteHTTPParameters

public static void deleteHTTPParameters(int scrapeableFileID)

Delets all HTTP parameters corresponding to the given scrapeable file.

Parameters:

scrapeableFileID - The ID of the scrapeable file.

setHTTPParameter

public static int setHTTPParameter(int httpParameterID,
                                   int scrapeableFileID,
                                   java.lang.String key,
                                   java.lang.String value,
                                   int sequence,
                                   java.lang.String httpParameterType)

Saves an HTTP parameter to the database.

Parameters:

httpParameterID - The ID of the HTTP parameter.

scrapeableFileID - The ID of the scrapeable file associated with this HTTP parameter.

key - The key portion of the parameter.

value - The value portion of the parameter.

sequence - The sequence.

httpParameterType - The type of the parameter.

Returns:

The ID of the HTTP parameter.

getHTTPParametersForScrapeableFileID

public static java.sql.ResultSet getHTTPParametersForScrapeableFileID(int scrapeableFileID)

Get all HTTP parameters from the database corresponding to the given scrapeable file.

Parameters:

scrapeableFileID - The ID of the scrapeable file.

Returns:

A ResultSet containing the HTTP parameters.

setExtractorPattern

public static int setExtractorPattern(int extractorPatternID,
                                      int scrapeableFileID,
                                      int parentExtractorPatternID,
                                      java.lang.String identifier,
                                      java.lang.String patternText,
                                      int sequence,
                                      boolean automaticallySaveInSessionVariable,
                                      boolean applyWhitespaceTidyingBeforeExtraction,
                                      int ifSavedInSessionVariable,
                                      boolean filterDuplicates,
                                      boolean cacheDataSet,
                                      java.lang.String fileToSaveTo,
                                      java.lang.String fileToSaveToDelimiter,
                                      boolean willBeInvokedManually)

Saves an extractor pattern to the database.

Parameters:

extractorPatternID - The ID of the extractor pattern.

scrapeableFileID - The ID of the scrapeable file associated with this extractor pattern.

parentExtractorPatternID - The ID of the parent extractor pattern. If no parent exists a -1 will be passed.

identifier - The identifier.

patternText - The text of the pattern.

sequence - The sequence of the pattern.

automaticallySaveInSessionVariable - Save in session variable?

applyWhitespaceTidyingBeforeExtraction - Apply whitespace tidying on extraction

ifSavedInSessionVariable - How to save in a session variable.

filterDuplicates - Filter duplicates.

cacheDataSet - Cache the data set?

fileToSaveTo - The file to save the data extracted to.

fileToSaveToDelimiter - The delimiter t use when saving to a file.

willBeInvokedManually - Indicates whether or not the extractor pattern will be invoked manually.

Returns:

The ID of the extractor pattern.

getSubExtractorPatterns

public static java.sql.ResultSet getSubExtractorPatterns(int parentExtractorPatternID)

Gets child extractor patterns corresponding to the given parent extractor pattern ID.

Parameters:

parentExtractorPatternID - The ID of the parent extractor pattern.

Returns:

A result set of extractor pattern records.

deleteSubExtractorPatterns

public static void deleteSubExtractorPatterns(int parentExtractorPatternID)

Deletes any sub-extractor patterns corresponding to the given parent extractor pattern ID.

Parameters:

parentExtractorPatternID - The ID of the parent extractor pattern.

deleteExtractorPattern

public static void deleteExtractorPattern(int extractorPatternID)

Deletes an extractor pattern from the database.

Parameters:

extractorPatternID - The ID of the extractor pattern.

getExtractorPatternsForScrapeableFileID

public static java.sql.ResultSet getExtractorPatternsForScrapeableFileID(int scrapeableFileID)

Get all extractor patterns from the database corresponding to the given scrapeable file.

Parameters:

scrapeableFileID - The ID of the scrapeable file.

Returns:

A ResultSet containing the extractor patterns.

getExtractorPatternIdentifierForID

public static java.lang.String getExtractorPatternIdentifierForID(int extractorPatternID)

Gets the identifier of an extractor pattern, given its ID.

Parameters:

extractorPatternID - The ID of the extractor pattern.

Returns:

The identifier of the extractor pattern.

getExtractorPatternsWithNoScrapeableFile

public static java.sql.ResultSet getExtractorPatternsWithNoScrapeableFile()

Gets the ID's of the extractor pattern records which have no corresponding scrapeable file record.

Returns:

A ResultSet containing the ID's.

getExtractorPatternsWithNoParent

public static java.sql.ResultSet getExtractorPatternsWithNoParent()

Gets the ID's of the sub-extractor pattern records which have no corresponding parent extractor pattern record.

Returns:

A ResultSet containing the ID's.

deleteExtractorPatternTokens

public static void deleteExtractorPatternTokens(int extractorPatternID)

Deletes all extractor pattern tokens corresponding to an extractor pattern.

Parameters:

extractorPatternID - The ID of the extractor pattern this is associated with.

setExtractorPatternToken

public static void setExtractorPatternToken(int extractorPatternID,
                                            java.lang.String identifier,
                                            boolean excludeFromData,
                                            int sequence,
                                            boolean saveInSessionVariable,
                                            java.lang.String regularExpression,
                                            boolean compoundKey,
                                            boolean stripHTML,
                                            boolean resolveRelativeURL,
                                            boolean replaceHTMLEntities,
                                            boolean trimWhiteSpace,
                                            boolean nullSessionVariable,
                                            int mappingSetID)

Saves an extractor pattern to the database.

Parameters:

extractorPatternID - The ID of the extractor pattern this is associated with.

identifier - The identifier.

excludeFromData - Whether to exclude from Dataset/DataRecord

sequence - The sequence in which the script should be run.

saveInSessionVariable - Whether or not to save the value extracted by this token in a session variable.

regularExpression - Specifies a regular expression instead of having the system determine one.

compoundKey - Whether or not the token should be used in a compound key.

stripHTML - Whether or not HTML should be stripped.

mappingSetID - The database ID of the mapping set.

updateExtractorPatternTokensWithNewMappingSet

public static void updateExtractorPatternTokensWithNewMappingSet(int mappingSetIDToBeReplaced,
                                                                 int mappingSetIDToKeep)

Updates all extractor pattern token records to use a new mapping set ID instead of the old one they were using.

Parameters:

mappingSetIDToBeReplaced - The mapping set ID to be replaced.

mappingSetIDToKeep - The mapping set ID we want to keep.

setScheduledScrapingSession

public static int setScheduledScrapingSession(ScheduledScrapingSession scheduledScrapingSession)

Saves a ScheduledScrapingSession to the database.

Parameters:

scheduledScrapingSession - The ScheduledScrapingSession to save.

Returns:

The database ID of the inserted object.

replaceScrapingSessionOnScheduledScrapingSession

public static void replaceScrapingSessionOnScheduledScrapingSession(int existingScrapingSessionID,
                                                                    int newScrapingSessionID)

Updates all scheduled scraping session records with a new scraping session ID.

Parameters:

existingScrapingSessionID - The ID of the existing scraping session.

newScrapingSessionID - The ID of the new scraping session.

getScheduledScrapingSessions

public static java.sql.ResultSet getScheduledScrapingSessions()

Gets all ScheduledScrapingSession objects contained in the database.

Returns:

A ResultSet containing ScheduledScrapingSession data.

deleteScheduledScrapingSession

public static void deleteScheduledScrapingSession(int scheduledScrapingSessionID)

Deletes a ScheduledScrapingSession from the database.

Parameters:

scheduledScrapingSessionID - The ID of the session.

deleteScheduledScrapingSessionByScrapingSessionID

public static void deleteScheduledScrapingSessionByScrapingSessionID(int scrapingSessionID)

Deletes all ScheduledScrapingSession objects corresponding to the given scraping session.

Parameters:

scrapingSessionID - The ID of the scraping session.

getScrapeableSessions

public static java.sql.ResultSet getScrapeableSessions()

Gets all ScrapeableSession objects contained in the database.

Returns:

A ResultSet containing ScrapeableSession data.

deleteScrapeableSession

public static void deleteScrapeableSession(int scrapeableSessionID)

Deletes a ScrapeableSession from the database.

Parameters:

scrapeableSessionID - The ID of the session.

deleteScrapeableSessionsByStartTime

public static void deleteScrapeableSessionsByStartTime(long startTime)

Deletes all ScrapeableSession records from the database whose start_time value exceeds the given one.

Parameters:

startTime - The start time after which records will be deleted.

deleteScrapeableSessionByScrapingSessionID

public static void deleteScrapeableSessionByScrapingSessionID(int scrapingSessionID)

Deletes all ScrapeableSession objects corresponding to the given scraping session.

Parameters:

scrapingSessionID - The ID of the scraping session.

setScrapeableSession

public static int setScrapeableSession(ScrapeableSession scrapeableSession)

Saves a ScrapeableSession to the database.

Parameters:

scrapeableSession - The ScrapeableSession to save.

Returns:

The database ID of the inserted object.

replaceScrapingSessionOnScrapeableSession

public static void replaceScrapingSessionOnScrapeableSession(int existingScrapingSessionID,
                                                             int newScrapingSessionID)

Updates all scrapeable session records with a new scraping session ID.

Parameters:

existingScrapingSessionID - The ID of the existing scraping session.

newScrapingSessionID - The ID of the new scraping session.

clearMappingSetID

public static void clearMappingSetID(int mappingSetID)

Clears the mapping set value from the extractor pattern tokens corresponding to the given mapping set ID.

Parameters:

mappingSetID - The database ID of the mapping set.

getExtractorPatternTokens

public static java.sql.ResultSet getExtractorPatternTokens(int extractorPatternID)

Gets all extractor pattern tokens corresponding to an extractor pattern.

Parameters:

extractorPatternID - The ID of the extractor pattern this is associated with.

Returns:

A ResultSet containing all of the extractor pattern tokens.

getPV

public static java.sql.ResultSet getPV()

Gets the date the app was first run.

Returns:

A ResultSet that may contain the first time the app was used.

setPV

public static void setPV(long pv)

Inserts a value into the PV column of control.

Parameters:

pv - The current time in milliseconds.

getLE

public static java.sql.ResultSet getLE()

Gets the email address of the licensee.

Returns:

A ResultSet that may contain the email address of the licensee.

setLE

public static void setLE(java.lang.String ea)

Sets the email address of the licensee.

Parameters:

ea - The email address.

blankScrapeableFileLastRequest

public static void blankScrapeableFileLastRequest()

Blanks out the last request of all scrapeable files.

blankScrapeableFileLastScrapedData

public static void blankScrapeableFileLastScrapedData()

Blanks out the last scraped data of all scrapeable files.

searchScripts

public static java.sql.ResultSet searchScripts(java.lang.String textToFind,
                                               boolean isCaseSensitive)

Searches the script table for the given text.

Parameters:

textToFind - The text to look for.

isCaseSensitive - Whether or not to do a case-sensitive search.

Returns:

A ResultSet.

searchExtractorPatterns

public static java.sql.ResultSet searchExtractorPatterns(java.lang.String textToFind,
                                                         boolean isCaseSensitive)

Searches the extractorpattern table for the given text.

Parameters:

textToFind - The text to look for.

isCaseSensitive - Whether or not to do a case-sensitive search.

Returns:

A ResultSet.

searchHTTPParameters

public static java.sql.ResultSet searchHTTPParameters(java.lang.String textToFind,
                                                      boolean isCaseSensitive)

Searches the httpparameter table for the given text.

Parameters:

textToFind - The text to look for.

isCaseSensitive - Whether or not to do a case-sensitive search.

Returns:

A ResultSet.

searchScrapeableFiles

public static java.sql.ResultSet searchScrapeableFiles(java.lang.String textToFind,
                                                       boolean isCaseSensitive)

Searches the scrapeablefile table for the given text.

Parameters:

textToFind - The text to look for.

isCaseSensitive - Whether or not to do a case-sensitive search.

Returns:

A ResultSet.

searchScrapingSessions

public static java.sql.ResultSet searchScrapingSessions(java.lang.String textToFind,
                                                        boolean isCaseSensitive)

Searches the scrapingsession table for the given text.

Parameters:

textToFind - The text to look for.

isCaseSensitive - Whether or not to do a case-sensitive search.

Returns:

A ResultSet.

getScrapeableFileNameForScrapeableFileID

public static java.lang.String getScrapeableFileNameForScrapeableFileID(int scrapeableFileID)

Gets the scrapeable file name corresponding to the given scrapeable file ID.

Returns:

The name.

getScrapeableFileIDForExtractorPatternID

public static int getScrapeableFileIDForExtractorPatternID(int extractorPatternID)

Gets the scrapeable file ID corresponding to the given extractor pattern ID.

Returns:

The ID.

getScrapingSessionNameByScrapeableFileID

public static java.lang.String getScrapingSessionNameByScrapeableFileID(int scrapeableFileID)

Gets the scraping session name corresponding to the scrapeable file ID.

Returns:

The name.