com.screenscraper.scraper

Class ExtractorPatternTokenDefaults

java.lang.Object

com.screenscraper.scraper.ExtractorPatternTokenDefaults

public class ExtractorPatternTokenDefaults
extends java.lang.Object

Class Description

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static ExtractorPatternTokenDefaults	EMPTY_TOKEN_DEFAULTS The defaults to use to indicate do nothing special

Constructor Summary

Constructors

Constructor and Description
ExtractorPatternTokenDefaults() Returns a defaults configuration that represents nothing special (no regex or checkbox settings)
ExtractorPatternTokenDefaults(java.lang.String name, java.util.List<com.screenscraper.scraper.ExtractorPatternTokenDefaults.MatchCondition> conditions, com.screenscraper.scraper.ExtractorPatternTokenDefaults.DefaultOptions options) Creates a defaults setup

Method Summary

Modifier and Type	Method and Description
static java.util.List<ExtractorPatternTokenDefaults>	getAllDefaults() Returns all the defaults currently in use, in the order they will be applied.
java.lang.String	getName() Returns the Name for the object
java.lang.String	getRegex() Returns the Regex for the object
static ExtractorPatternTokenDefaults	getTokenDefaults(java.lang.String name, java.lang.String left, java.lang.String right)
boolean	isConvertEntities() Returns the ConvertEntities for the object
boolean	isExcludeFromDataRecord() Returns the ExcludeFromDataRecord for the object
boolean	isMatch(java.lang.String name, java.lang.String left, java.lang.String right) Checks if this defaults configuration is a match for the given extractor
boolean	isNullSessionVariableOnNoMatch() Returns the NullSessionVariableOnNoMatch for the object
boolean	isResolveURLs() Returns the ResolveURLs for the object
boolean	isSaveInSessionVariable() Returns the SaveInSessionVariable for the object
boolean	isStripHTML() Returns the StripHTML for the object
boolean	isTrimWhiteSpace() Returns the TrimWhiteSpace for the object
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_TOKEN_DEFAULTS

public static final ExtractorPatternTokenDefaults EMPTY_TOKEN_DEFAULTS

The defaults to use to indicate do nothing special

Constructor Detail

ExtractorPatternTokenDefaults

public ExtractorPatternTokenDefaults(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.util.List<com.screenscraper.scraper.ExtractorPatternTokenDefaults.MatchCondition> conditions,
                                     @NotNull
                                     com.screenscraper.scraper.ExtractorPatternTokenDefaults.DefaultOptions options)

Creates a defaults setup

Parameters:

name - The name to use for display

conditions - The list of match conditions

options - The options to set

ExtractorPatternTokenDefaults

public ExtractorPatternTokenDefaults()

Returns a defaults configuration that represents nothing special (no regex or checkbox settings)

Method Detail

getTokenDefaults

@NotNull
public static ExtractorPatternTokenDefaults getTokenDefaults(@Nullable
                                                                       java.lang.String name,
                                                                       @Nullable
                                                                       java.lang.String left,
                                                                       @Nullable
                                                                       java.lang.String right)

getAllDefaults

public static java.util.List<ExtractorPatternTokenDefaults> getAllDefaults()

Returns all the defaults currently in use, in the order they will be applied. This list should not (and cannot) be modified

Returns:

The list of all possible defaults for tokens in the order they are checked

Since:

7.0.4a

isMatch

public boolean isMatch(@NotNull
                       java.lang.String name,
                       @Nullable
                       java.lang.String left,
                       @Nullable
                       java.lang.String right)

Checks if this defaults configuration is a match for the given extractor

Parameters:

name - The name of the token

left - The text to the left of the token

right - The text to the right of the token

Returns:

True if this defaults configuration matches, false otherwise

getName

@NotNull
public java.lang.String getName()

Returns the Name for the object

Returns:

The Name for the object

Since:

7.0.4a

isStripHTML

public boolean isStripHTML()

Returns the StripHTML for the object

Returns:

The StripHTML for the object

isResolveURLs

public boolean isResolveURLs()

Returns the ResolveURLs for the object

Returns:

The ResolveURLs for the object

isConvertEntities

public boolean isConvertEntities()

Returns the ConvertEntities for the object

Returns:

The ConvertEntities for the object

isTrimWhiteSpace

public boolean isTrimWhiteSpace()

Returns the TrimWhiteSpace for the object

Returns:

The TrimWhiteSpace for the object

isExcludeFromDataRecord

public boolean isExcludeFromDataRecord()

Returns the ExcludeFromDataRecord for the object

Returns:

The ExcludeFromDataRecord for the object

isSaveInSessionVariable

public boolean isSaveInSessionVariable()

Returns the SaveInSessionVariable for the object

Returns:

The SaveInSessionVariable for the object

isNullSessionVariableOnNoMatch

public boolean isNullSessionVariableOnNoMatch()

Returns the NullSessionVariableOnNoMatch for the object

Returns:

The NullSessionVariableOnNoMatch for the object

getRegex

@NotNull
public java.lang.String getRegex()

Returns the Regex for the object

Returns:

The Regex for the object

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object