ScrapeableSession

java.lang.Object
- com.screenscraper.scraper.ScrapeableSession

All Implemented Interfaces:: com.screenscraper.client.util.WebConstants, java.lang.Comparable

public class ScrapeableSession
extends java.lang.Object
implements java.lang.Comparable, com.screenscraper.client.util.WebConstants

Field Summary

Fields
Modifier and Type Field and Description

static org.apache.log4j.Logger log
- Fields inherited from interface com.screenscraper.client.util.WebConstants
  APD_LOG_CONTENTS, APD_NUM_LOG_LINES_TO_DISPLAY, APD_RUN_RUNNING_SESSION_TAB, APD_RUNNABLE_SESSION_TAB, APD_SCHEDULED_SCRAPING_SESSION_DATA, APD_SCHEDULED_SESSION_TAB, APD_SCRAPEABLE_SESSION_ID, APD_SCRAPING_SESSION_ID, APD_TAB_TO_SELECT, APE_DISPLAY_ENTER_REGISTRATION_INFORMATION_DIALOG, APE_DISPLAY_IMPORT_DIALOG, APE_DISPLAY_NOTES_DIALOG, APE_DISPLAY_PEEK_LOG_DIALOG, APE_DISPLAY_SCRAPING_SESSION_SCHEDULER_DIALOG, APE_DISPLAY_SETTINGS_DIALOG, APE_HIDE_REGISTRATION_BUTTON, APE_REFRESH_TABLE, APE_SCHEDULE_SCRAPING_SESSION, APE_SELECT_RUN_RUNNING_TAB_AND_REFRESH_TABLE, APE_SELECT_RUNNABLE_TAB_AND_REFRESH_TABLE, APE_SELECT_SHEDULED_TAB_AND_REFRESH_TABLE, APE_SELECT_TAB, DEFAULT_REPEAT_DAYS, DEFAULT_REPEAT_HOURS, DEFAULT_REPEAT_MINUTES, DEFAULT_REPEAT_SECONDS, DEFAULT_THRESHOLD_RECORD_COUNT, DEFAULT_THRESHOLD_TIME, DEFAULT_TIMEOUT, DOWNLOAD_FILE_TYPE_SCRAPING_SESSION, ENABLED, ERROR_MESSAGE, FOLDER_NAME, GUI_DIALOG_BOX_SCHEDULE_SCRAPING_SESSION, GUI_PANEL_MAIN_CONTENT, GUI_PANEL_RUN_RUNNING_SCRAPING_SESSIONS, GUI_PANEL_RUNNABLE_SCRAPING_SESSIONS, GUI_PANEL_SCHEDULED_SCRAPING_SESSIONS, GUI_PANEL_TOP_NAV, GUI_SCREENSCRAPER_WEB, GUI_SETTINGS_DIALOG, IS_ERROR, NUM_DUPLICATE_RECORDS, NUM_ERROR_RECORDS, NUM_NEW_RECORDS, NUM_RECORDS, NUM_UPDATED_RECORDS, PREVIOUS_NUM_RECORDS, PREVIOUS_RUNNING_TIME, PREVIOUS_RUNNING_TIME_MACHINE_READABLE, REPEAT_DAYS, REPEAT_HOURS, REPEAT_MINUTES, REPEAT_SECONDS, RUNNING_TIME, RUNNING_TIME_MACHINE_READABLE, SCHEDULE_DATE, SCHEDULE_TIME, SCHEDULED_SCRAPING_SESSION_ID, SCRAPEABLE_SESSION_ID, SCRAPING_SESSION_ID, SCRAPING_SESSION_NAME, SCRAPING_SESSIONS, SECONDS_IN_A_DAY, SECONDS_IN_A_MINUTE, SECONDS_IN_AN_HOUR, SETTABLE_SESSION_VARIABLES, START_TIME, START_TIME_MACHINE_READABLE, STATUS, STATUS_COMPLETED, STATUS_IN_PROCESS, STATUS_INTERRUPTED, STATUS_NOT_STARTED, STATUS_UNKNOWN, THRESHOLD_RECORD_COUNT, THRESHOLD_TIME, TIMEOUT

Fields
Modifier and Type	Field and Description
`static org.apache.log4j.Logger`	`log`

Constructor Summary

Constructors
Constructor and Description
`ScrapeableSession(int scrapeableSessionID, int scrapingSessionID, long startTime, long elapsedTime, int numRecordsScraped, int numNewRecordsScraped, int numUpdatedRecordsScraped, int numDuplicateRecordsScraped, int numErrorRecordsScraped, boolean fatalErrorOccurred, java.lang.String status, java.lang.String errorMessage, java.lang.String logFileName, int relativeTimeThreshold, int relativeRecordsScrapedThreshold, java.lang.String savedSessionVariables)` Initializes the object with all of its fields.
`ScrapeableSession(ScrapingSession session)` Initializes the object for a running `ScrapingSession`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(java.lang.Object scrapeableSession)` So that these things can be sorted.
`void`	`completeScrapingSession()` Handles salvaging any data it can from the `ScrapingSession` before it gets nuked.
`boolean`	`containsReferenceToScrapingSession()` Indicates whether or not the object holds a reference to its corresponding `ScrapingSession`.
`void`	`dumpToLog()` Dumps this ojbect to the log.
`boolean`	`getCompleteScrapingSessionWhenFinished()` Indicates whether or not the scrapeable session should be completed when it finishes.
`long`	`getElapsedTime()` Gets the amount of time that did or has transpired in running the session.
`java.lang.String`	`getErrorMessage()` Gets any error message(s) that might have been logged.
`boolean`	`getFatalErrorOccurred()` Gets whether or not an error occurred in running the session.
`java.lang.String`	`getHost()` Gets the host on which this session was run.
`int`	`getID()` Gets the database ID of this object.
`java.lang.String`	`getLogFileName()` Gets the name of the log file corresponding to this session.
`int`	`getNumDuplicateRecordsScraped()` Gets the number of duplicate records scraped.
`int`	`getNumErrorRecordsScraped()` Gets the number of error records scraped.
`int`	`getNumNewRecordsScraped()` Gets the number of new records scraped.
`int`	`getNumRecordsScraped()` Gets the number of records scraped.
`int`	`getNumUpdatedRecordsScraped()` Gets the number of updated records scraped.
`java.lang.String`	`getPort()` Gets the port on which this scraping session was run.
`long`	`getPreviousElapsedTime()` Gets the elapsed time of the scrapeable session just prior to this one.
`int`	`getPreviousNumRecordsScraped()` Gets the number of records scraped of the scrapeable session just prior to this one.
`int`	`getRelativeRecordsScrapedThreshold()` Gets the records scraped threshold used for the scraping session.
`int`	`getRelativeTimeThreshold()` Gets the time threshold used for the scraping session.
`boolean`	`getRemoveLogFileOnCompletion()` Indicates whether or not the log file should be removed when the scraping session completes.
`java.lang.String`	`getSavedSessionVariables()` Gets any saved session variables corresponding to the session.
`ScrapingSession`	`getScrapingSession()` If the session is in progress, this will get a reference to the corresponding session.
`int`	`getScrapingSessionID()` Gets the database ID of the scraping session corresponding to this object.
`java.lang.String`	`getScrapingSessionName()` Gets the name of the scraping session corresponding to this object.
`long`	`getStartTime()` Gets the time the session was started.
`java.lang.String`	`getStartTimeAsString()` Gets the start time as a string.
`java.lang.String`	`getStatus()` Gets the status of the session, as defined by one of the corresponding constants found in com.screenscraper.client.util.
`void`	`nullScrapingSessionReference()` Nulls out the reference this object has to its corresponding `ScrapingSession` object.
`void`	`save()` Saves the `ScrapeableSession` to the database.
`void`	`setCompleteScrapingSessionWhenFinished(boolean completeScrapingSessionWhenFinished)` Determines whether or not the scrapeable session should be completed when it finishes.
`void`	`setPreviousElapsedTime(long previousElapsedTime)` Sets the elapsed time of the scrapeable session just prior to this one.
`void`	`setPreviousNumRecordsScraped(int previousNumRecordsScraped)` Sets the number of records scraped of the scrapeable session just prior to this one.
`void`	`setRemoveLogFileOnCompletion(boolean removeLogFileOnCompletion)` Sets whether or not the log file should be removed when the scraping session completes.
`void`	`setScrapingSession(ScrapingSession session)` If the session is in progress, this will set a reference to the corresponding session.
`void`	`setScrapingSessionID(int scrapingSessionID)` Sets the database ID of the scraping session corresponding to this object.
`void`	`setStatus(java.lang.String status)` Sets the status of the session, as defined by one of the corresponding constants found in com.screenscraper.client.util.

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
```
- Constructor Detail
  - ScrapeableSession
```
public ScrapeableSession(@Nullable
                         ScrapingSession session)
```
    Initializes the object for a running ScrapingSession.
    
    Parameters:
    
    session - The running ScrapingSession.
  - ScrapeableSession
```
public ScrapeableSession(int scrapeableSessionID,
                         int scrapingSessionID,
                         long startTime,
                         long elapsedTime,
                         int numRecordsScraped,
                         int numNewRecordsScraped,
                         int numUpdatedRecordsScraped,
                         int numDuplicateRecordsScraped,
                         int numErrorRecordsScraped,
                         boolean fatalErrorOccurred,
                         java.lang.String status,
                         java.lang.String errorMessage,
                         java.lang.String logFileName,
                         int relativeTimeThreshold,
                         int relativeRecordsScrapedThreshold,
                         java.lang.String savedSessionVariables)
```
    Initializes the object with all of its fields.
- Method Detail
  - getID
```
public int getID()
```
    Gets the database ID of this object.
    
    Returns:
    
    The ID.
  - getScrapingSessionID
```
public int getScrapingSessionID()
```
    Gets the database ID of the scraping session corresponding to this object.
    
    Returns:
    
    The ID of the scraping session.
  - setScrapingSessionID
```
public void setScrapingSessionID(int scrapingSessionID)
```
    Sets the database ID of the scraping session corresponding to this object.
    
    Parameters:
    
    scrapingSessionID - The ID of the scraping session.
  - getScrapingSessionName
```
@Nullable
public java.lang.String getScrapingSessionName()
```
    Gets the name of the scraping session corresponding to this object.
    
    Returns:
    
    The name of the scraping session.
  - getStartTime
```
public long getStartTime()
```
    Gets the time the session was started.
    
    Returns:
    
    The time.
  - getStartTimeAsString
```
@Nullable
public java.lang.String getStartTimeAsString()
```
    Gets the start time as a string.
    
    Returns:
    
    The start time as a string.
  - getHost
```
@Nullable
public java.lang.String getHost()
```
    Gets the host on which this session was run.
    
    Returns:
    
    The host.
  - getPort
```
@Nullable
public java.lang.String getPort()
```
    Gets the port on which this scraping session was run.
    
    Returns:
    
    The port.
  - getElapsedTime
```
public long getElapsedTime()
```
    Gets the amount of time that did or has transpired in running the session.
    
    Returns:
    
    The amount of time.
  - getPreviousElapsedTime
```
public long getPreviousElapsedTime()
```
    Gets the elapsed time of the scrapeable session just prior to this one.
    
    Returns:
    
    The elapsed time.
  - setPreviousElapsedTime
```
public void setPreviousElapsedTime(long previousElapsedTime)
```
    Sets the elapsed time of the scrapeable session just prior to this one.
    
    Parameters:
    
    previousElapsedTime - The elapsed time.
  - getNumRecordsScraped
```
public int getNumRecordsScraped()
```
    Gets the number of records scraped.
    
    Returns:
    
    The number of records.
  - getNumNewRecordsScraped
```
public int getNumNewRecordsScraped()
```
    Gets the number of new records scraped.
    
    Returns:
    
    The number of new records.
  - getNumUpdatedRecordsScraped
```
public int getNumUpdatedRecordsScraped()
```
    Gets the number of updated records scraped.
    
    Returns:
    
    The number of updated records.
  - getNumDuplicateRecordsScraped
```
public int getNumDuplicateRecordsScraped()
```
    Gets the number of duplicate records scraped.
    
    Returns:
    
    The number of duplicate records.
  - getNumErrorRecordsScraped
```
public int getNumErrorRecordsScraped()
```
    Gets the number of error records scraped.
    
    Returns:
    
    The number of error records.
  - getPreviousNumRecordsScraped
```
public int getPreviousNumRecordsScraped()
```
    Gets the number of records scraped of the scrapeable session just prior to this one.
    
    Returns:
    
    The number of records.
  - setPreviousNumRecordsScraped
```
public void setPreviousNumRecordsScraped(int previousNumRecordsScraped)
```
    Sets the number of records scraped of the scrapeable session just prior to this one.
    
    Parameters:
    
    previousNumRecordsScraped - The number of records.
  - getFatalErrorOccurred
```
public boolean getFatalErrorOccurred()
```
    Gets whether or not an error occurred in running the session.
    
    Returns:
    
    The error condition.
  - getStatus
```
@Nullable
public java.lang.String getStatus()
```
    Gets the status of the session, as defined by one of the corresponding constants found in com.screenscraper.client.util.
    
    Returns:
    
    The status.
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Sets the status of the session, as defined by one of the corresponding constants found in com.screenscraper.client.util.
    
    Parameters:
    
    status - The status.
  - getErrorMessage
```
@Nullable
public java.lang.String getErrorMessage()
```
    Gets any error message(s) that might have been logged.
    
    Returns:
    
    The error message(s).
  - getLogFileName
```
@Nullable
public java.lang.String getLogFileName()
```
    Gets the name of the log file corresponding to this session.
    
    Returns:
    
    The name of the log file.
  - getRelativeTimeThreshold
```
public int getRelativeTimeThreshold()
```
    Gets the time threshold used for the scraping session.
    
    Returns:
    
    The time threshold.
  - getRelativeRecordsScrapedThreshold
```
public int getRelativeRecordsScrapedThreshold()
```
    Gets the records scraped threshold used for the scraping session.
    
    Returns:
    
    The records scraped threshold.
  - getSavedSessionVariables
```
@Nullable
public java.lang.String getSavedSessionVariables()
```
    Gets any saved session variables corresponding to the session.
    
    Returns:
    
    The saved session variables.
  - getScrapingSession
```
@Nullable
public ScrapingSession getScrapingSession()
```
    If the session is in progress, this will get a reference to the corresponding session.
    
    Returns:
    
    The ScrapingSession
  - setScrapingSession
```
public void setScrapingSession(@Nullable
                               ScrapingSession session)
```
    If the session is in progress, this will set a reference to the corresponding session.
    
    Parameters:
    
    session - The ScrapingSession
  - save
```
public void save()
```
    Saves the ScrapeableSession to the database.
  - compareTo
```
public int compareTo(java.lang.Object scrapeableSession)
```
    So that these things can be sorted.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    Parameters:
    
    scrapeableSession - The object to compare to.
  - containsReferenceToScrapingSession
```
public boolean containsReferenceToScrapingSession()
```
    Indicates whether or not the object holds a reference to its corresponding ScrapingSession.
    
    Returns:
    
    A boolean.
  - completeScrapingSession
```
public void completeScrapingSession()
```
    Handles salvaging any data it can from the ScrapingSession before it gets nuked.
  - getRemoveLogFileOnCompletion
```
public boolean getRemoveLogFileOnCompletion()
```
    Indicates whether or not the log file should be removed when the scraping session completes.
    
    Returns:
    
    A boolean.
  - setRemoveLogFileOnCompletion
```
public void setRemoveLogFileOnCompletion(boolean removeLogFileOnCompletion)
```
    Sets whether or not the log file should be removed when the scraping session completes.
  - getCompleteScrapingSessionWhenFinished
```
public boolean getCompleteScrapingSessionWhenFinished()
```
    Indicates whether or not the scrapeable session should be completed when it finishes.
    
    Returns:
    
    A boolean.
  - setCompleteScrapingSessionWhenFinished
```
public void setCompleteScrapingSessionWhenFinished(boolean completeScrapingSessionWhenFinished)
```
    Determines whether or not the scrapeable session should be completed when it finishes.
    
    Parameters:
    
    completeScrapingSessionWhenFinished - A boolean.
  - nullScrapingSessionReference
```
public void nullScrapingSessionReference()
```
    Nulls out the reference this object has to its corresponding ScrapingSession object.
  - dumpToLog
```
public void dumpToLog()
```
    Dumps this ojbect to the log.

Class ScrapeableSession

Field Summary

Fields inherited from interface com.screenscraper.client.util.WebConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

Constructor Detail

ScrapeableSession

ScrapeableSession

Method Detail

getID

getScrapingSessionID

setScrapingSessionID

getScrapingSessionName

getStartTime

getStartTimeAsString

getHost

getPort

getElapsedTime

getPreviousElapsedTime

setPreviousElapsedTime

getNumRecordsScraped

getNumNewRecordsScraped

getNumUpdatedRecordsScraped

getNumDuplicateRecordsScraped

getNumErrorRecordsScraped

getPreviousNumRecordsScraped

setPreviousNumRecordsScraped

getFatalErrorOccurred

getStatus

setStatus

getErrorMessage

getLogFileName

getRelativeTimeThreshold

getRelativeRecordsScrapedThreshold

getSavedSessionVariables

getScrapingSession

setScrapingSession

save

compareTo

containsReferenceToScrapingSession

completeScrapingSession

getRemoveLogFileOnCompletion

setRemoveLogFileOnCompletion

getCompleteScrapingSessionWhenFinished

setCompleteScrapingSessionWhenFinished

nullScrapingSessionReference

dumpToLog