com.screenscraper.events.extractor

Class ExtractorPatternEventData

java.lang.Object

java.util.EventObject

com.screenscraper.events.AbstractEventData

com.screenscraper.events.extractor.ExtractorPatternEventData

All Implemented Interfaces:

java.io.Serializable

public class ExtractorPatternEventData
extends AbstractEventData

Extractor pattern event data

Version:

6.0.55a

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ExtractorPatternEventData(ScrapingSession session, ScrapeableFile scrapeableFile, ExtractorPattern extractorPattern, DataSet dataSet, DataRecord dataRecord, boolean extractorPatternTimedOut)

Method Summary

Modifier and Type	Method and Description
boolean	extractorPatternTimedOut() Returns whether or not the extractor pattern timed out.
DataRecord	getDataRecord() Returns the current data record (if applicable to the fire time) or null otherwise
DataSet	getDataSet() Returns the current data set (if applicable to the fire time) or null otherwise
ExtractorPattern	getExtractorPattern() Returns the extractor pattern the event was called from
ScrapeableFile	getScrapeableFile() Returns the scrapeable file the extractor pattern is being run from
ScrapingSession	getSession() Returns the current scraping session on which the event was triggered
java.lang.String	toString()

Methods inherited from class com.screenscraper.events.AbstractEventData

getLastReturnValue, setLastReturnValue

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtractorPatternEventData

ExtractorPatternEventData(@NotNull
                          ScrapingSession session,
                          @NotNull
                          ScrapeableFile scrapeableFile,
                          @NotNull
                          ExtractorPattern extractorPattern,
                          @Nullable
                          DataSet dataSet,
                          @Nullable
                          DataRecord dataRecord,
                          boolean extractorPatternTimedOut)

Method Detail

getSession

@NotNull
public ScrapingSession getSession()

Returns the current scraping session on which the event was triggered

Returns:

The current scraping session on which the event was triggered

getScrapeableFile

@NotNull
public ScrapeableFile getScrapeableFile()

Returns the scrapeable file the extractor pattern is being run from

Returns:

The scrapeable file the extractor pattern is being run from

getExtractorPattern

@NotNull
public ExtractorPattern getExtractorPattern()

Returns the extractor pattern the event was called from

Returns:

The extractor pattern the event was called from

getDataSet

@Nullable
public DataSet getDataSet()

Returns the current data set (if applicable to the fire time) or null otherwise

Returns:

The current data set (if applicable to the fire time) or null otherwise

getDataRecord

@Nullable
public DataRecord getDataRecord()

Returns the current data record (if applicable to the fire time) or null otherwise

Returns:

The current data record (if applicable to the fire time) or null otherwise

extractorPatternTimedOut

public boolean extractorPatternTimedOut()

Returns whether or not the extractor pattern timed out. If the event was triggered before the extractor was run this will

Returns:

The current data record (if applicable to the fire time) or null otherwise

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.util.EventObject