com.screenscraper.scraper

Class Mapping

java.lang.Object

com.screenscraper.scraper.Mapping

All Implemented Interfaces:

java.lang.Comparable

public class Mapping
extends java.lang.Object
implements java.lang.Comparable

Used to substitute one extracted value for another.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.
static java.lang.String	STR_TYPE_CONTAINS
static java.lang.String	STR_TYPE_EQUALS The constants that define the possible types of mappings in a human-friendly format.
static java.lang.String	STR_TYPE_REGULAR_EXPRESSION
static int	TYPE_CONTAINS
static int	TYPE_EQUALS The constants that define the possible types of mappings.
static int	TYPE_REGULAR_EXPRESSION

Constructor Summary

Constructors

Constructor and Description
Mapping() Creates a blank object.
Mapping(int mappingID, java.lang.String toValue, java.lang.String fromValue, int mappingType, boolean isCaseSensitive, int sequence) Creates a mapping for all fields.
Mapping(java.lang.String toValue) Creates a mapping using the given "to" value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object mapping) So we can be sorted.
protected void	delete() Causes the mapping to be deleted from the database.
void	dumpToLog() Dumps the mapping to the log.
boolean	equals(java.lang.Object obj) Overriding equals...
java.lang.String	getFromValue() Gets the "From" value.
static java.lang.String	getHumanFriendlyMappingType(int mappingType) Gets a human-friendly representation of a mapping type.
int	getID() Gets the database ID of the mapping.
boolean	getIsCaseSensitive() Indicates whether or not the match is case sensitive.
int	getMappingSetID() Gets the database ID of the set containing this mapping.
int	getMappingType() Gets the type of the value, as defined by one of the "TYPE" constants defined in this class.
static int	getMappingTypeForHumanFriendlyMapingType(java.lang.String strMappingType) Maps a human-friendly representation of a mapping type to one of the int constants in this class.
int	getSequence() Gets the sequence of the mapping in the set.
java.lang.String	getToValue() Gets the "to" value.
java.lang.String	getToValueWithBackReferencesReplaced(java.lang.String value) Returns a "to value" with any back-references replaced, if the "to value" contains any.
boolean	mapValue(java.lang.String value) Indicates whether or not the given value matches, according to the specified criteria.
protected void	save() Saves the mapping to the database.
void	setFromValue(java.lang.String fromValue) Sets the "From" value.
void	setIsCaseSensitive(boolean isCaseSensitive) Determines whether or not the match is case sensitive.
protected void	setMappingSetID(int mappingSetID) Gets the database ID of the set containing this mapping.
void	setMappingType(int mappingType) Gets the type of the value, as defined by one of the "TYPE" constants defined in this class.
void	setSequence(int sequence) Sets the sequence of the mapping in the set.
void	setToValue(java.lang.String toValue) Sets the "to" value.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

TYPE_EQUALS

public static final int TYPE_EQUALS

The constants that define the possible types of mappings.

See Also:

Constant Field Values

TYPE_CONTAINS

public static final int TYPE_CONTAINS

See Also:

Constant Field Values

TYPE_REGULAR_EXPRESSION

public static final int TYPE_REGULAR_EXPRESSION

See Also:

Constant Field Values

STR_TYPE_EQUALS

public static final java.lang.String STR_TYPE_EQUALS

The constants that define the possible types of mappings in a human-friendly format.

See Also:

Constant Field Values

STR_TYPE_CONTAINS

public static final java.lang.String STR_TYPE_CONTAINS

See Also:

Constant Field Values

STR_TYPE_REGULAR_EXPRESSION

public static final java.lang.String STR_TYPE_REGULAR_EXPRESSION

See Also:

Constant Field Values

Constructor Detail

Mapping

public Mapping()

Creates a blank object.

Mapping

public Mapping(java.lang.String toValue)

Creates a mapping using the given "to" value.

Parameters:

toValue - The "to" value.

Mapping

public Mapping(int mappingID,
               java.lang.String toValue,
               java.lang.String fromValue,
               int mappingType,
               boolean isCaseSensitive,
               int sequence)

Creates a mapping for all fields.

Parameters:

mappingID - The database ID of the mapping.

toValue - The "to" value.

fromValue - The "from" value.

mappingType - The type.

isCaseSensitive - Indicates whether or not the match should be case sensitive.

sequence - The sequence.

Method Detail

getID

public int getID()

Gets the database ID of the mapping.

Returns:

The database ID.

getMappingSetID

public int getMappingSetID()

Gets the database ID of the set containing this mapping.

Returns:

The database ID.

setMappingSetID

protected void setMappingSetID(int mappingSetID)

Gets the database ID of the set containing this mapping.

Parameters:

mappingSetID - The database ID.

getFromValue

@Nullable
public java.lang.String getFromValue()

Gets the "From" value. This is the value that user defines to map to the value that gets extracted.

Returns:

The "From" value.

setFromValue

public void setFromValue(java.lang.String fromValue)

Sets the "From" value. This is the value that user defines to map to the value that gets extracted. Note that this method is public only because it's necessary for Castor.

Parameters:

fromValue - The "From" value.

getToValue

@Nullable
public java.lang.String getToValue()

Gets the "to" value. This is the value that gets extracted that the user will define a "from" value for.

Returns:

The "To" value.

setToValue

public void setToValue(java.lang.String toValue)

Sets the "to" value. This is the value that gets extracted that the user will define a "from" value for. Note that this method is public only because it's necessary for Castor.

Parameters:

toValue - The "To" value.

getMappingType

public int getMappingType()

Gets the type of the value, as defined by one of the "TYPE" constants defined in this class.

Returns:

The type.

setMappingType

public void setMappingType(int mappingType)

Gets the type of the value, as defined by one of the "TYPE" constants defined in this class. Note that this method is public only because it's necessary for Castor.

Parameters:

mappingType - The type.

getIsCaseSensitive

public boolean getIsCaseSensitive()

Indicates whether or not the match is case sensitive.

Returns:

A boolean.

setIsCaseSensitive

public void setIsCaseSensitive(boolean isCaseSensitive)

Determines whether or not the match is case sensitive.

Parameters:

isCaseSensitive - A boolean.

getSequence

public int getSequence()

Gets the sequence of the mapping in the set.

Returns:

The sequence.

setSequence

public void setSequence(int sequence)

Sets the sequence of the mapping in the set.

Parameters:

sequence - The sequence.

mapValue

public boolean mapValue(@Nullable
                        java.lang.String value)

Indicates whether or not the given value matches, according to the specified criteria.

Parameters:

value - The value to be mapped.

Returns:

A boolean indicating whether or not the mapping was successful.

getToValueWithBackReferencesReplaced

public java.lang.String getToValueWithBackReferencesReplaced(@NotNull
                                                             java.lang.String value)

Returns a "to value" with any back-references replaced, if the "to value" contains any.

Parameters:

value - The value we're matching against.

Returns:

The "to value" with back-references replaced.

compareTo

public int compareTo(java.lang.Object mapping)

So we can be sorted.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

mapping - The Mapping we're comparing to.

Returns:

The usual stuff.

getHumanFriendlyMappingType

public static java.lang.String getHumanFriendlyMappingType(int mappingType)

Gets a human-friendly representation of a mapping type.

Parameters:

mappingType - The type of the mapping, as defined by one of the constants in this class.

Returns:

A human-friendly representation.

getMappingTypeForHumanFriendlyMapingType

public static int getMappingTypeForHumanFriendlyMapingType(java.lang.String strMappingType)

Maps a human-friendly representation of a mapping type to one of the int constants in this class.

Parameters:

strMappingType - A string mapping type.

Returns:

One of the TYPE constants.

delete

protected void delete()

Causes the mapping to be deleted from the database.

save

protected void save()

Saves the mapping to the database.

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overriding equals...

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare to.

dumpToLog

public void dumpToLog()

Dumps the mapping to the log.