// Create an EventHandler object which will be called when the event triggers
EventHandler handler = new EventHandler()
{
/**
* Returns the name of the handler. This method doens't need to be implemented
* but helps with debugging (on error executing the callback it will output this)
*/
public String getHandlerName()
{
return "A test event handler";
}
/**
* Processes the event, and potentially returns a useful value modifying something
* in the internal code
*
* @param fireTime The fire time of the event. This helps when using the same handler
* for multiple event times, to determine which was called
* @param data The actual data from the event. Based on the event time this
* will be a different type. It could be SessionEventData, ScrapeableFileEventData,
* ScriptEventData, StringEventData, etc... It will match the fire time class name
*
* @return A value indicating how to proceed (or sometimes the value is ignored)
*/
public Object handleEvent(EventFireTime fireTime, AbstractEventData data)
{
// While you can specifically grab any data from the data object,
// if this is a method that has a return value that matters,
// it's best to get it as the last return value, so that multiple
// events can be chained together. The input data object
// will always have the original values for all the other getters
Object returnValue = data.getLastReturnValue();
// Do stuff...
// The EventFireTime values describe in the documentation what the return
// value will do, or says nothing about it if the value is ignored
// If you don't intend to modify the return, always return data.getLastReturnValue();
return returnValue;
}
};
getHandlerName
String getHandlerName ( )
Description
Returns the name of the handler. This method doesn't need to be implemented but helps with debugging.
Parameters
This method does not receive any parameters.
Return Values
Returns the name of the handler. This method doesn't need to be implemented but helps with debugging.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
// Create an EventHandler object which will be called when the event triggers
EventHandler handler = new EventHandler()
{
/**
* Returns the name of the handler. This method doens't need to be implemented
* but helps with debugging (on error executing the callback it will output this)
*/
public String getHandlerName()
{
return "A test event handler";
}
public Object handleEvent(EventFireTime fireTime, AbstractEventData data)
{
// do something
}
};
See Also
handleEvent
Object handleEvent ( EventFireTime fireTime, AbstractEventData data )
Description
Processes the event, and potentially returns a useful value modifying something in the internal code as defined by the EventFireTime used to launch this event.
Parameters
- fireTime Defines the methods that a fire time must have.
- data Allows for the accessing of various data values found within ScreenScraper dependent on the class used.
Return Values
Returns a value based on which AbstractEventData class is used.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
EventHandler handler = new EventHandler()
{
public String getHandlerName()
{
// return something
}
/**
* Processes the event, and potentially returns a useful value modifying something
* in the internal code
*
* @param fireTime The fire time of the event. This helps when using the same handler
* for multiple event times, to determine which was called
* @param data The actual data from the event. Based on the event time this
* will be a different type. It could be SessionEventData, ScrapeableFileEventData,
* ScriptEventData, StringEventData, etc... It will match the fire time class name
*
* @return A value indicating how to proceed (or sometimes the value is ignored)
*/
public Object handleEvent(EventFireTime fireTime, AbstractEventData data)
{
// While you can specifically grab any data from the data object,
// if this is a method that has a return value that matters,
// it's best to get it as the last return value, so that multiple
// events can be chained together. The input data object
// will always have the original values for all the other getters
Object returnValue = data.getLastReturnValue();
// Do stuff...
// The EventFireTime values describe in the documentation what the return
// value will do, or says nothing about it if the value is ignored
// If you don't intend to modify the return, always return data.getLastReturnValue();
return returnValue;
}
};
See Also
AbstractEventData
The AbstractEventData class is an abstract class which allows for the accessing of various data values found within ScreenScraper. Below are the various classes that extend AbstractEventData
AbstractEventData is extended by the following classes and it is those classes that should be used in place of AbstractEventData.
getLastReturnValue
Object getLastReturnValue ( )
Description
Returns the LastReturnValue for the object. This is the value previously returned by another callback. This can be null, if no callbacks have been fired yet for this event. A null value is also the default return value for the given event.
Parameters
This method does not receive any parameters.
Return Values
Returns the LastReturnValue for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Write to Log
// In practice AbstractEventData is just the abstract class.
// You must actually use one of the classes that extend it.
public Object handleEvent(EventFireTime fireTime, AbstractEventData data) {
// While you can specifically grab any data from the data object,
// if this is a method that has a return value that matters,
// it's best to get it as the last return value, so that multiple
// events can be chained together. The input data object
// will always have the original values for all the other getters
Object returnValue = data.getLastReturnValue();
// do something
// The EventFireTime values describe in the documentation what the return
// value will do, or says nothing about it if the value is ignored
// If you don't intend to modify the return, always return data.getLastReturnValue();
return data.getLastReturnValue();
}
setLastReturnValue
void setLastReturnValue ( Object lastReturnValue )
Description
Sets the LastReturnValue fro the object.
Parameters
- lastReturnValue The new value for the LastReturnValue
Return Values
Returns void.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
// In practice AbstractEventData is just the abstract class.
// You must actually use one of the classes that extend it.
public Object handleEvent(EventFireTime fireTime, AbstractEventData data) {
Object foo = // something here;
data.setLastReturnValue(foo);
// do something
// The EventFireTime values describe in the documentation what the return
// value will do, or says nothing about it if the value is ignored
// If you don't intend to modify the return, always return data.getLastReturnValue();
return data.getLastReturnValue();
}
ExtractorPatternEventData
ExtractorPatternEventData extends AbstractEventData
This contains the data for various extractor pattern operations
Inherits the following methods from AbstractEventData
See Also
extractorPatternTimedOut
boolean extractorPatternEventData.extractorPatternTimedOut ( )
Description
Returns the status of the extractor pattern timeout. Returns true if and only if the extractor pattern was applied and timed out while doing so. Otherwise it will return false.
Parameters
This method does not receive any parameters.
Return Values
Returns a boolean value representing the status of the extractor pattern timeout.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Determine if an extractor pattern has timed out.
public Object handleEvent(EventFireTime fireTime, ExtractorPatternEventData data) {
if (data.extractorPatternTimeOut()) {
// do something
}
}
getDataRecord
DataRecord extractorPatternEventData.getDataRecord ( )
Description
Returns the DataRecord value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the DataRecord value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current DataRecord.
public Object handleEvent(EventFireTime fireTime, ExtractorPatternEventData data) {
DataRecord dr = data.getDataRecord();
// do something
}
getDataSet
DataSet extractorPatternEventData.getDataSet ( )
Description
Returns the DataSet value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the DataSet value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current DataSet.
public Object handleEvent(EventFireTime fireTime, ExtractorPatternEventData data) {
DataSet ds = data.getDataSet();
// do something
}
getExtractorPattern
ExtractorPattern extractorPatternEventData.getExtractorPattern ( )
Description
Returns the ExtractorPattern value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the ExtractorPattern value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current ExtractorPattern.
public Object handleEvent(EventFireTime fireTime, ExtractorPatternEventData data) {
ExtractorPattern pattern = data.getExtractorPattern();
// do something
}
getScrapeableFile
ScrapeableFile extractorPatternEventData.getScrapeableFile ( )
Description
Returns the Scrapeablefile value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the Scrapeablefile value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current ScrapeableFile.
public Object handleEvent(EventFireTime fireTime, ExtractorPatternEventData data) {
ScrapeableFile sf = data.getScrapeableFile();
// do something
}
getSession
ScrapingSession extractorPatternEventData.getSession ( )
Description
Returns the Session value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the Session value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current Session.
public Object handleEvent(EventFireTime fireTime, ExtractorPatternEventData data) {
ScrapingSession _session = data.getSession();
// do something
}
ScrapeableFileEventData
ScrapeableFileEventData extends AbstractEventData
This contains the data for various scrapeable file operations
Inherits the following methods from AbstractEventData
See Also
getHttpResponseData
String scrapeableFileEventData.getHttpResponseData ( )
Description
Returns the HttpResponseData for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the HttpResponseData for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the HttpResponseData
public Object handleEvent(EventFireTime fireTime, ScrapeableFileEventData data) {
String responseData = data.getHttpResponseData();
// do something
}
getRedirectRequestBuilder
ScrapingRequest.Builder scrapeableFileEventData.getRedirectRequestBuilder ( )
Description
Returns the RedirectRequestBuilder for the object. Use this to add headers, etc... for the redirect. It can be null depending on the HTTP client being used, and whether or not it supports manually playing with the redirect.
Parameters
This method does not receive any parameters.
Return Values
Returns the RedirectRequestBuilder for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the Request Builder in order to modify it.
public Object handleEvent(EventFireTime fireTime, ScrapeableFileEventData data) {
ScrapingRequest.Builder builder = data.getRedirectRequestBuilder();
// do something
}
getScrapeableFile
ScrapeableFile scrapeableFileEventData.getScrapeableFile ( )
Description
Returns the Scrapeablefile value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the Scrapeablefile value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current ScrapeableFile.
public Object handleEvent(EventFireTime fireTime, ScrapeableFileEventData data) {
ScrapeableFile sf = data.getScrapeableFile();
// do something
}
getSession
ScrapingSession scrapeableFileEventData.getSession ( )
Description
Returns the Session value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the Session value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current Session.
public Object handleEvent(EventFireTime fireTime, ScrapeableFileEventData data) {
ScrapingSession _session = data.getSession();
// do something
}
ScriptEventData
ScriptEventData extends AbstractEventData
This contains the data for various script operations
Inherits the following methods from AbstractEventData
See Also
getDataRecord
DataRecord scriptEventData.getDataRecord ( )
Description
Returns the DataRecord value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the DataRecord value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current DataRecord.
public Object handleEvent(EventFireTime fireTime, ScriptEventData data) {
DataRecord dr = data.getDataRecord();
// do something
}
getDataSet
DataSet scriptEventData.getDataSet ( )
Description
Returns the DataSet value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the DataSet value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current DataSet.
public Object handleEvent(EventFireTime fireTime, ScriptEventData data) {
DataSet ds = data.getDataSet();
// do something
}
getScrapeableFile
ScrapeableFile scriptEventData.getScrapeableFile ( )
Description
Returns the Scrapeablefile value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the Scrapeablefile value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current ScrapeableFile.
public Object handleEvent(EventFireTime fireTime, ScriptEventData data) {
ScrapeableFile sf = data.getScrapeableFile();
// do something
}
getScriptException
java.lang.Exception scriptEventData.getScriptException ( )
Description
Returns the ScriptException for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the ScriptException for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the script exception
public Object handleEvent(EventFireTime fireTime, ScriptEventData data) {
java.lang.Exception e = data.getScriptException();
// do something
}
getScriptName
String scriptEventData.getScriptName ( )
Description
Returns the ScriptName value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the ScriptName value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the script name
public Object handleEvent(EventFireTime fireTime, ScriptEventData data) {
String name = data.getScriptName();
// do something
}
getSession
ScrapingSession scriptEventData.getSession ( )
Description
Returns the Session value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the Session value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current Session.
public Object handleEvent(EventFireTime fireTime, ScriptEventData data) {
ScrapingSession _session = data.getSession();
// do something
}
SessionEventData
SessionEventData extends AbstractEventData
This contains the data for various session operations
Inherits the following methods from AbstractEventData
See Also
getIncrementRecordsAmount
Object sessionEventData.getIncrementRecordsAmount ( )
Description
Returns the IncrementRecordsAmount value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the IncrementRecordsAmount value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current increment records amount.
public Object handleEvent(EventFireTime fireTime, SessionEventData data) {
Object recordsAmt = data.getIncrementRecordsAmount();
// do something
}
getSession
ScrapingSession sessionEventData.getSession ( )
Description
Returns the Session value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the Session value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current Session.
public Object handleEvent(EventFireTime fireTime, SessionEventData data) {
ScrapingSession _session = data.getSession();
// do something
}
getVariableName
String sessionEventData.getVariableName ( )
Description
Returns the VariableName value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the VariableName value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the variable name.
public Object handleEvent(EventFireTime fireTime, SessionEventData data) {
String name = data.getVariableName();
// do something
}
getVariableValue
Object sessionEventData.getVariableValue ( )
Description
Returns the VariableValue value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the VariableValue value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Get the current Session.
public Object handleEvent(EventFireTime fireTime, SessionEventData data) {
Object value = data.getVariableValue();
// do something
}
StringEventData
StringEventData extends AbstractEventData
This contains the data for various string operations
Inherits the following methods from AbstractEventData
See Also
getInput
String stringEventData.getInput ( )
Description
Returns the Input value for the object.
Parameters
This method does not receive any parameters.
Return Values
Returns the Input value for the object.
Change Log
| Version |
Description |
| 6.0.55a |
Available for all editions. |
Examples
Write to Log
public Object handleEvent(EventFireTime fireTime, StringEventData data) {
String str = data.getInput();
// do something
}