ExtractorPattern

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

All Implemented Interfaces:: ScriptInstancesContainer

public class ExtractorPattern
extends java.lang.Object
implements ScriptInstancesContainer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`INT_APPEND`
`static int`	`INT_OVERWRITE`
`static org.apache.log4j.Logger`	`log` Used for logging.
`static java.lang.String`	`STR_APPEND` Constants used with the "ifSavedInSessionVariable" field.
`static java.lang.String`	`STR_OVERWRITE`

Constructor Summary

Constructors
Constructor and Description
`ExtractorPattern()` Generates a new empty pattern.
`ExtractorPattern(ExtractorPattern extractorPattern)` Creates an `ExtractorPattern` by copying an existing one.
`ExtractorPattern(int extractorPatternID, int scrapeableFileID, 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)` Generates a new extractor pattern with all of its information.
`ExtractorPattern(java.lang.String identifier, java.lang.String patternText, int sequence)` Generates a new pattern based on the given value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtractorPatternToken(ExtractorPatternToken extractorPatternToken)` Adds an extractor pattern token to the collection.
`void`	`addSubExtractorPattern(ExtractorPattern subExtractorPattern)` Adds a child extractor pattern.
`void`	`addSubExtractorPatternToBeDeleted(ExtractorPattern subExtractorPatternToBeDeleted)` Adds a child extractor pattern to be deleted.
`DataSet`	`applyPattern(java.lang.String sessionName, java.lang.String content, Notifiable notifiable, ScrapingSessionState scrapingSessionState, ExtractorPattern subExtractorPattern)` Applies the extractor pattern to a string.
`void`	`bumpSubExtractorPatternSequences(int bottomSequence, int topSequence, int bumpModifier)` Bumps sequences up or down between the bottom and top sequences.
`boolean`	`containsNullableTokens()` Indicates whether or not the pattern contains any tokens that will null session variables.
`void`	`delete()` Deletes the extractor pattern from the database.
`void`	`dumpToLog()` Dumps the extractor pattern to the log.
`boolean`	`getApplyWhitespaceTidyingBeforeExtraction()` Indicates whether we should run white space tidying before extraction (strip out tabs and new lines) or not
`boolean`	`getAutomaticallySaveInSessionVariable()` Indicates whether or not the data set generated by this extractor pattern should be automatically saved in a session variable.
`boolean`	`getCacheDataSet()` Indicates whether or not the data set is to be cached.
`ExtractorPatternToken`	`getDeepExtractorPatternToken(java.lang.String identifier)` Gets an extractor pattern token from the extractor pattern based on identifier.
`java.util.Iterator<ExtractorPatternToken>`	`getDeepExtractorPatternTokensIterator()` Allows iterating over all extractor pattern tokens, including those in sub-extractor patterns.
`ExtractorPatternToken`	`getExtractorPatternToken(int sequence)` Gets an extractor pattern from the session based on sequence.
`ExtractorPatternToken`	`getExtractorPatternToken(java.lang.String identifier)` Gets an extractor pattern token from the extractor pattern based on identifier.
`java.util.HashSet`	`getExtractorPatternTokens()` Gets all extractor pattern tokens held by this pattern.
`java.util.HashSet`	`getExtractorPatternTokensCopy()` Gets a copy of all extractor pattern tokens held by this pattern.
`java.util.Iterator`	`getExtractorPatternTokensIterator()` Gets an `Iterator` used to cycle through the `ExtractorPatternToken` objects held by this object.
`java.lang.String`	`getFileToSaveTo()` Indicates the file to save the data to.
`java.lang.String`	`getFileToSaveToDelimiter()` Indicates the delimiter to use for the file to save the data to.
`boolean`	`getFilterDuplicates()` Indicates whether or not duplicates should be filtered.
`int`	`getID()` Gets the ID of the extractor pattern.
`java.lang.String`	`getIdentifier()` Gets the identifier for the pattern.
`int`	`getIfSavedInSessionVariable()` If automatically saved in a session variable indicates whether the data set should be appended or overwritte.
`static int`	`getIntSaveInSessionVariableForString(java.lang.String saveInSessionVariable)` Gets the `String` constant for the "saveInSessionVariable" field, given the int version.
`java.lang.String`	`getName()` Gets the name for the pattern.
`int`	`getNumExtractorPatternTokens()` Gets the total number of script instances held by this object.
`int`	`getNumSubExtractorPatterns()` Gets the number of sub-extractor patterns.
`int`	`getNumSubExtractorPatternsToBeDeleted()` Gets the number of sub-extractor patterns to be deleted.
`ExtractorPattern`	`getParentExtractorPattern()` Gets parent extractor pattern, if this one is a child.
`java.lang.String`	`getPatternText()` Gets the text of the pattern.
`int`	`getScrapeableFileID()` Gets the ID of the HTTP parameter.
`ScriptInstances`	`getScriptInstances()` Returns a `ScriptInstances` object containing all script instances associated with this scrapeable file.
`int`	`getSequence()` Gets the sequence with which the parameter should be sent.
`static java.lang.String`	`getStringSaveInSessionVariableForInt(int saveInSessionVariable)` Gets the int constant for the "saveInSessionVariable" field, given the `String` version.
`ExtractorPattern`	`getSubExtractorPattern(int sequence)` Gets a sub-extractor pattern corresponding to the sequence.
`java.util.HashSet`	`getSubExtractorPatterns()` Gets a `HashSet` holding the sub-extractor patterns.
`java.util.Iterator`	`getSubExtractorPatternsIterator()` Gets an iterator of `ExtractorPattern` objects so that an external class can iterate through them.
`java.util.Iterator`	`getSubExtractorPatternsToBeDeletedIterator()` Gets an iterator of `ExtractorPattern` objects to be deleted so that an external class can iterate through them.
`java.util.HashSet`	`getTokenIdentifiersToBeUsedInFilteringDuplicates()` Gets a `HashSet` of `String` objects containing token identifiers that should be used in filtering duplicates.
`AbstractView`	`getView()` Gets the view representing this extractor pattern.
`boolean`	`getWillBeInvokedManually()` Indicates whether or not the pattern will be invoked manually from a script.
`void`	`logTokensWithNoRegEx(Notifiable notifiable)` Logs extractor pattern tokens with no regex.
`void`	`removeAllExtractorPatternTokens()` Removes all extractor pattern tokens from the pattern.
`void`	`removeExtractorPatternToken(int sequence)` Removes a script instance.
`void`	`removeSubExtractorPattern(ExtractorPattern subExtractorPattern)` Revoves a child extractor pattern.
`void`	`resetContainsNullableTokens()` Resets the containsNullableTokens value.
`void`	`save()` Saves the extractor pattern to the database.
`void`	`sequenceSubExtractorPatterns()` This method adds a sequence number to the sub-extractor patterns.
`void`	`setApplyWhitespaceTidyingBeforeExtraction(boolean applyWhitespaceTidyingBeforeExtraction)` Sets whether we should run white space tidying before extraction (strip out tabs and new lines) or not
`void`	`setAutomaticallySaveInSessionVariable(boolean automaticallySaveInSessionVariable)` Determines whether or not the data set generated by this extractor pattern should be automatically saved in a session variable.
`void`	`setCacheDataSet(boolean cacheDataSet)` Determines whether or not the data set is to be cached.
`void`	`setFileToSaveTo(java.lang.String fileToSaveTo)` Determines the file to save the data to.
`void`	`setFileToSaveToDelimiter(java.lang.String fileToSaveToDelimiter)` Determines the delimiter to use for the file to save the data to.
`void`	`setFilterDuplicates(boolean filterDuplicates)` Determines whether or not duplicates should be filtered.
`void`	`setIdentifier(java.lang.String identifier)` Sets the identifier.
`void`	`setIfSavedInSessionVariable(int ifSavedInSessionVariable)` If automatically saved in a session variable determines whether the data set should be appended or overwritte.
`void`	`setPatternText(java.lang.String patternText)` Sets the value.
`protected void`	`setScrapeableFileID(int scrapeableFileID)` Sets the scrapeable file ID of the scrapeable file associated with this extractor pattern.
`void`	`setScriptInstances(ScriptInstances scriptInstances)` Sets the script instances to be associated with this scrapeable file.
`void`	`setSequence(int sequence)` Sets the sequence with which the parameter should be sent.
`void`	`setView(AbstractView view)` Sets the view representing this extractor pattern.
`void`	`setWillBeInvokedManually(boolean willBeInvokedManually)` Determines whether or not the pattern will be invoked manually from a script.
`void`	`stripNonSubExtractorPatternStuff()` Strips off any objects that wouldn't apply to a sub-extractor pattern.

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.
  - STR_APPEND
```
public static final java.lang.String STR_APPEND
```
    Constants used with the "ifSavedInSessionVariable" field.
    
    See Also:
    
    Constant Field Values
  - STR_OVERWRITE
```
public static final java.lang.String STR_OVERWRITE
```
    See Also:
    
    Constant Field Values
  - INT_APPEND
```
public static final int INT_APPEND
```
    See Also:
    
    Constant Field Values
  - INT_OVERWRITE
```
public static final int INT_OVERWRITE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExtractorPattern
```
public ExtractorPattern()
```
    Generates a new empty pattern.
  - ExtractorPattern
```
public ExtractorPattern(java.lang.String identifier,
                        java.lang.String patternText,
                        int sequence)
```
    Generates a new pattern based on the given value.
    
    Parameters:
    
    identifier - Identifies the pattern.
    
    patternText - The text of the pattern.
    
    sequence - The sequence of the pattern.
  - ExtractorPattern
```
public ExtractorPattern(int extractorPatternID,
                        int scrapeableFileID,
                        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)
```
    Generates a new extractor pattern with all of its information.
    
    Parameters:
    
    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.
    
    extractorPatternID - The ID of the extractor pattern.
    
    scrapeableFileID - The ID of the scrapeable file associated with this extractor pattern.
    
    identifier - The identifier.
    
    patternText - The text of the pattern.
    
    sequence - The sequence of the pattern.
    
    automaticallySaveInSessionVariable - Save in session variable?
    
    applyWhitespaceTidyingBeforeExtraction - True to apply whitespace tidying
    
    ifSavedInSessionVariable - How to save in a session variable.
    
    filterDuplicates - Filter duplicates.
    
    cacheDataSet - Cache the data set?
  - ExtractorPattern
```
public ExtractorPattern(@NotNull
                        ExtractorPattern extractorPattern)
```
    Creates an ExtractorPattern by copying an existing one.
    
    Parameters:
    
    extractorPattern - The ExtractorPattern to copy.
- Method Detail
  - getID
```
public int getID()
```
    Gets the ID of the extractor pattern.
    
    Specified by:
    
    getID in interface ScriptInstancesContainer
    
    Returns:
    
    The ID.
  - setScrapeableFileID
```
protected void setScrapeableFileID(int scrapeableFileID)
```
    Sets the scrapeable file ID of the scrapeable file associated with this extractor pattern.
  - getScrapeableFileID
```
public int getScrapeableFileID()
```
    Gets the ID of the HTTP parameter.
  - getParentExtractorPattern
```
@Nullable
public ExtractorPattern getParentExtractorPattern()
```
    Gets parent extractor pattern, if this one is a child.
    
    Returns:
    
    The extractor pattern.
  - getIdentifier
```
@Nullable
public java.lang.String getIdentifier()
```
    Gets the identifier for the pattern.
    
    Returns:
    
    The identifier.
  - setIdentifier
```
public void setIdentifier(@Nullable
                          java.lang.String identifier)
```
    Sets the identifier.
    
    Parameters:
    
    identifier - The identifier.
  - getName
```
@Nullable
public java.lang.String getName()
```
    Gets the name for the pattern. Used only for castor.
    
    Specified by:
    
    getName in interface ScriptInstancesContainer
    
    Returns:
    
    The name.
  - getPatternText
```
@Nullable
public java.lang.String getPatternText()
```
    Gets the text of the pattern.
    
    Returns:
    
    The text.
  - setPatternText
```
public void setPatternText(java.lang.String patternText)
```
    Sets the value.
    
    Parameters:
    
    patternText - The text to be set.
  - getSequence
```
public int getSequence()
```
    Gets the sequence with which the parameter should be sent.
    
    Returns:
    
    The sequence.
  - setSequence
```
public void setSequence(int sequence)
```
    Sets the sequence with which the parameter should be sent.
    
    Parameters:
    
    sequence - The sequence.
  - getView
```
@Nullable
public AbstractView getView()
```
    Gets the view representing this extractor pattern. This probably isn't the best design, but it makes re-sequencing the panels a heck of a lot easier.
    
    Returns:
    
    The view.
  - setView
```
public void setView(AbstractView view)
```
    Sets the view representing this extractor pattern. This probably isn't the best design, but it makes re-sequencing the panels a heck of a lot easier.
    
    Parameters:
    
    view - The view.
  - getScriptInstances
```
@Nullable
public ScriptInstances getScriptInstances()
```
    Returns a ScriptInstances object containing all script instances associated with this scrapeable file.
    
    Specified by:
    
    getScriptInstances in interface ScriptInstancesContainer
    
    Returns:
    
    The script instances.
  - setScriptInstances
```
public void setScriptInstances(@Nullable
                               ScriptInstances scriptInstances)
```
    Sets the script instances to be associated with this scrapeable file.
    
    Specified by:
    
    setScriptInstances in interface ScriptInstancesContainer
    
    Parameters:
    
    scriptInstances - The script instances.
  - save
```
public void save()
```
    Saves the extractor pattern to the database.
  - stripNonSubExtractorPatternStuff
```
public void stripNonSubExtractorPatternStuff()
```
    Strips off any objects that wouldn't apply to a sub-extractor pattern.
  - delete
```
public void delete()
```
    Deletes the extractor pattern from the database.
  - getSubExtractorPatterns
```
@Nullable
public java.util.HashSet getSubExtractorPatterns()
```
    Gets a HashSet holding the sub-extractor patterns. This is only public because of Castor.
    
    Returns:
    
    The HashSet.
  - getSubExtractorPatternsIterator
```
@NotNull
public java.util.Iterator getSubExtractorPatternsIterator()
```
    Gets an iterator of ExtractorPattern objects so that an external class can iterate through them.
    
    Returns:
    
    The iterator.
  - getSubExtractorPatternsToBeDeletedIterator
```
@NotNull
public java.util.Iterator getSubExtractorPatternsToBeDeletedIterator()
```
    Gets an iterator of ExtractorPattern objects to be deleted so that an external class can iterate through them.
    
    Returns:
    
    The iterator.
  - addSubExtractorPatternToBeDeleted
```
public void addSubExtractorPatternToBeDeleted(@Nullable
                                              ExtractorPattern subExtractorPatternToBeDeleted)
```
    Adds a child extractor pattern to be deleted.
    
    Parameters:
    
    subExtractorPatternToBeDeleted - An ExtractorPattern.
  - getNumSubExtractorPatternsToBeDeleted
```
public int getNumSubExtractorPatternsToBeDeleted()
```
    Gets the number of sub-extractor patterns to be deleted.
    
    Returns:
    
    The number.
  - addExtractorPatternToken
```
public void addExtractorPatternToken(@Nullable
                                     ExtractorPatternToken extractorPatternToken)
```
    Adds an extractor pattern token to the collection.
    
    Parameters:
    
    extractorPatternToken - An ExtractorPatternToken.
  - removeExtractorPatternToken
```
public void removeExtractorPatternToken(int sequence)
```
    Removes a script instance.
    
    Parameters:
    
    sequence - The sequence.
  - getExtractorPatternToken
```
@Nullable
public ExtractorPatternToken getExtractorPatternToken(int sequence)
```
    Gets an extractor pattern from the session based on sequence.
    
    Parameters:
    
    sequence - The sequence of the token to be retrieved.
  - getExtractorPatternToken
```
@Nullable
public ExtractorPatternToken getExtractorPatternToken(java.lang.String identifier)
```
    Gets an extractor pattern token from the extractor pattern based on identifier.
    
    Parameters:
    
    identifier - The identifier of the token to be retrieved.
    
    Returns:
    
    The extractor pattern token
  - getDeepExtractorPatternTokensIterator
```
@NotNull
public java.util.Iterator<ExtractorPatternToken> getDeepExtractorPatternTokensIterator()
```
    Allows iterating over all extractor pattern tokens, including those in sub-extractor patterns.
    
    Returns:
    
    An Iterater<ExtractorPatternToken>.
  - getDeepExtractorPatternToken
```
@Nullable
public ExtractorPatternToken getDeepExtractorPatternToken(java.lang.String identifier)
```
    Gets an extractor pattern token from the extractor pattern based on identifier. This method will first search for the token in the main extractor pattern, and, failing to find it there, will search all of the sub-patterns.
    
    Parameters:
    
    identifier - The identifier of the token to be retrieved.
  - getExtractorPatternTokensIterator
```
@NotNull
public java.util.Iterator getExtractorPatternTokensIterator()
```
    Gets an Iterator used to cycle through the ExtractorPatternToken objects held by this object.
    
    Returns:
    
    An Iterator.
  - getExtractorPatternTokens
```
@NotNull
public java.util.HashSet getExtractorPatternTokens()
```
    Gets all extractor pattern tokens held by this pattern. Note that this it only public because of Castor.
    
    Returns:
    
    A HashSet of ExtractorPatternTokens.
  - getExtractorPatternTokensCopy
```
@NotNull
public java.util.HashSet getExtractorPatternTokensCopy()
```
    Gets a copy of all extractor pattern tokens held by this pattern.
    
    Returns:
    
    A HashSet of ExtractorPatternTokens.
  - removeAllExtractorPatternTokens
```
public void removeAllExtractorPatternTokens()
```
    Removes all extractor pattern tokens from the pattern.
  - getNumExtractorPatternTokens
```
public int getNumExtractorPatternTokens()
```
    Gets the total number of script instances held by this object.
    
    Returns:
    
    The total.
  - getAutomaticallySaveInSessionVariable
```
public boolean getAutomaticallySaveInSessionVariable()
```
    Indicates whether or not the data set generated by this extractor pattern should be automatically saved in a session variable.
    
    Returns:
    
    A boolean.
  - getApplyWhitespaceTidyingBeforeExtraction
```
public boolean getApplyWhitespaceTidyingBeforeExtraction()
```
    Indicates whether we should run white space tidying before extraction (strip out tabs and new lines) or not
    
    Returns:
    
    Whether we should run white space tidying before extraction (strip out tabs and new lines) or not
  - setApplyWhitespaceTidyingBeforeExtraction
```
public void setApplyWhitespaceTidyingBeforeExtraction(boolean applyWhitespaceTidyingBeforeExtraction)
```
    Sets whether we should run white space tidying before extraction (strip out tabs and new lines) or not
    
    Parameters:
    
    applyWhitespaceTidyingBeforeExtraction - Whether we should run white space tidying before extraction (strip out tabs and new lines) or not
  - setAutomaticallySaveInSessionVariable
```
public void setAutomaticallySaveInSessionVariable(boolean automaticallySaveInSessionVariable)
```
    Determines whether or not the data set generated by this extractor pattern should be automatically saved in a session variable.
    
    Parameters:
    
    automaticallySaveInSessionVariable - A boolean.
  - getIfSavedInSessionVariable
```
public int getIfSavedInSessionVariable()
```
    If automatically saved in a session variable indicates whether the data set should be appended or overwritte.
    
    Returns:
    
    An int corresponding to one of the related constants in this class.
  - setIfSavedInSessionVariable
```
public void setIfSavedInSessionVariable(int ifSavedInSessionVariable)
```
    If automatically saved in a session variable determines whether the data set should be appended or overwritte.
    
    Parameters:
    
    ifSavedInSessionVariable - An int corresponding to one of the related constants in this class.
  - getIntSaveInSessionVariableForString
```
public static int getIntSaveInSessionVariableForString(@NotNull
                                                       java.lang.String saveInSessionVariable)
```
    Gets the String constant for the "saveInSessionVariable" field, given the int version.
    
    Parameters:
    
    saveInSessionVariable - An int corresponding to one of the related constants in this class.
    
    Returns:
    
    A String corresponding to one of the constants in this class.
  - getStringSaveInSessionVariableForInt
```
@NotNull
public static java.lang.String getStringSaveInSessionVariableForInt(int saveInSessionVariable)
```
    Gets the int constant for the "saveInSessionVariable" field, given the String version.
    
    Parameters:
    
    saveInSessionVariable - A String corresponding to one of the related constants in this class.
    
    Returns:
    
    An int corresponding to one of the constants in this class.
  - getNumSubExtractorPatterns
```
public int getNumSubExtractorPatterns()
```
    Gets the number of sub-extractor patterns.
    
    Returns:
    
    The number.
  - addSubExtractorPattern
```
public void addSubExtractorPattern(@Nullable
                                   ExtractorPattern subExtractorPattern)
```
    Adds a child extractor pattern.
    
    Parameters:
    
    subExtractorPattern - An ExtractorPattern.
  - removeSubExtractorPattern
```
public void removeSubExtractorPattern(@Nullable
                                      ExtractorPattern subExtractorPattern)
```
    Revoves a child extractor pattern.
    
    Parameters:
    
    subExtractorPattern - An ExtractorPattern.
  - sequenceSubExtractorPatterns
```
public void sequenceSubExtractorPatterns()
```
    This method adds a sequence number to the sub-extractor patterns. This is necessary because of the transition to using sequences with sub-extractor patterns.
  - getSubExtractorPattern
```
@Nullable
public ExtractorPattern getSubExtractorPattern(int sequence)
```
    Gets a sub-extractor pattern corresponding to the sequence.
    
    Parameters:
    
    sequence - The sequence of the pattern to be retrieved.
  - bumpSubExtractorPatternSequences
```
public void bumpSubExtractorPatternSequences(int bottomSequence,
                                             int topSequence,
                                             int bumpModifier)
```
    Bumps sequences up or down between the bottom and top sequences.
    
    Parameters:
    
    bottomSequence - The bottom sequence.
    
    topSequence - The top sequence.
    
    bumpModifier - Modifies each sequence.
  - getFilterDuplicates
```
public boolean getFilterDuplicates()
```
    Indicates whether or not duplicates should be filtered.
    
    Returns:
    
    A boolean.
  - setFilterDuplicates
```
public void setFilterDuplicates(boolean filterDuplicates)
```
    Determines whether or not duplicates should be filtered.
    
    Parameters:
    
    filterDuplicates - A boolean.
  - getCacheDataSet
```
public boolean getCacheDataSet()
```
    Indicates whether or not the data set is to be cached.
    
    Returns:
    
    A boolean.
  - setCacheDataSet
```
public void setCacheDataSet(boolean cacheDataSet)
```
    Determines whether or not the data set is to be cached.
    
    Parameters:
    
    cacheDataSet - A boolean.
  - getFileToSaveTo
```
@Nullable
public java.lang.String getFileToSaveTo()
```
    Indicates the file to save the data to.
    
    Returns:
    
    A String representing the file to save to.
  - setFileToSaveTo
```
public void setFileToSaveTo(java.lang.String fileToSaveTo)
```
    Determines the file to save the data to.
    
    Parameters:
    
    fileToSaveTo - A String representing the file to save to.
  - getFileToSaveToDelimiter
```
@Nullable
public java.lang.String getFileToSaveToDelimiter()
```
    Indicates the delimiter to use for the file to save the data to.
    
    Returns:
    
    The delimiter
  - setFileToSaveToDelimiter
```
public void setFileToSaveToDelimiter(java.lang.String fileToSaveToDelimiter)
```
    Determines the delimiter to use for the file to save the data to.
    
    Parameters:
    
    fileToSaveToDelimiter - The delimiter
  - getWillBeInvokedManually
```
public boolean getWillBeInvokedManually()
```
    Indicates whether or not the pattern will be invoked manually from a script.
    
    Returns:
    
    A boolean.
  - setWillBeInvokedManually
```
public void setWillBeInvokedManually(boolean willBeInvokedManually)
```
    Determines whether or not the pattern will be invoked manually from a script.
    
    Parameters:
    
    willBeInvokedManually - A boolean.
  - resetContainsNullableTokens
```
public void resetContainsNullableTokens()
```
    Resets the containsNullableTokens value.
  - containsNullableTokens
```
public boolean containsNullableTokens()
```
    Indicates whether or not the pattern contains any tokens that will null session variables.
    
    Returns:
    
    A boolean.
  - getTokenIdentifiersToBeUsedInFilteringDuplicates
```
@Nullable
public java.util.HashSet getTokenIdentifiersToBeUsedInFilteringDuplicates()
```
    Gets a HashSet of String objects containing token identifiers that should be used in filtering duplicates.
    
    Returns:
    
    The token identifiers, if records are to be filtered and if any of the tokens are to be used in the compound key.
  - logTokensWithNoRegEx
```
public void logTokensWithNoRegEx(@NotNull
                                 Notifiable notifiable)
```
    Logs extractor pattern tokens with no regex.
    
    Parameters:
    
    notifiable - The Notifiable object that should be used to log.
  - applyPattern
```
public DataSet applyPattern(java.lang.String sessionName,
                            java.lang.String content,
                            Notifiable notifiable,
                            ScrapingSessionState scrapingSessionState,
                            ExtractorPattern subExtractorPattern)
                     throws java.lang.Exception
```
    Applies the extractor pattern to a string.
    
    Parameters:
    
    sessionName - The name of the scraping session (used to help with debugging)
    
    content - The content to which the extractor pattern is to be applied.
    
    notifiable - A Notifiable to which messages will be logged.
    
    scrapingSessionState - A ScrapingSessionState used to resolve variables.
    
    subExtractorPattern - This will be passed in if the extractor pattern should only return a data set containing data matched by this particular sub-extractor pattern.
    
    Returns:
    
    A DataSet containing the extracted data.
    
    Throws:
    
    java.lang.Exception - if the pattern either takes too long or another problem occurs in the process.
  - dumpToLog
```
public void dumpToLog()
```
    Dumps the extractor pattern to the log.

Class ExtractorPattern

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

STR_APPEND

STR_OVERWRITE

INT_APPEND

INT_OVERWRITE

Constructor Detail

ExtractorPattern

ExtractorPattern

ExtractorPattern

ExtractorPattern

Method Detail

getID

setScrapeableFileID

getScrapeableFileID

getParentExtractorPattern

getIdentifier

setIdentifier

getName

getPatternText

setPatternText

getSequence

setSequence

getView

setView

getScriptInstances

setScriptInstances

save

stripNonSubExtractorPatternStuff

delete

getSubExtractorPatterns

getSubExtractorPatternsIterator

getSubExtractorPatternsToBeDeletedIterator

addSubExtractorPatternToBeDeleted

getNumSubExtractorPatternsToBeDeleted

addExtractorPatternToken

removeExtractorPatternToken

getExtractorPatternToken

getExtractorPatternToken

getDeepExtractorPatternTokensIterator

getDeepExtractorPatternToken

getExtractorPatternTokensIterator

getExtractorPatternTokens

getExtractorPatternTokensCopy

removeAllExtractorPatternTokens

getNumExtractorPatternTokens

getAutomaticallySaveInSessionVariable

getApplyWhitespaceTidyingBeforeExtraction

setApplyWhitespaceTidyingBeforeExtraction

setAutomaticallySaveInSessionVariable

getIfSavedInSessionVariable

setIfSavedInSessionVariable

getIntSaveInSessionVariableForString

getStringSaveInSessionVariableForInt

getNumSubExtractorPatterns

addSubExtractorPattern

removeSubExtractorPattern

sequenceSubExtractorPatterns

getSubExtractorPattern

bumpSubExtractorPatternSequences

getFilterDuplicates

setFilterDuplicates

getCacheDataSet

setCacheDataSet

getFileToSaveTo

setFileToSaveTo

getFileToSaveToDelimiter

setFileToSaveToDelimiter

getWillBeInvokedManually

setWillBeInvokedManually

resetContainsNullableTokens

containsNullableTokens

getTokenIdentifiersToBeUsedInFilteringDuplicates

logTokensWithNoRegEx

applyPattern