com.screenscraper.scraper

Class MappingSet

java.lang.Object

com.screenscraper.scraper.MappingSet

All Implemented Interfaces:

java.lang.Comparable

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

Encapsulates a set of Mapping objects associated with an ExtractorPatternToken.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
MappingSet() Default constructor required by Castor.
MappingSet(int mappingSetID, java.lang.String name) Creates a set with all values and loads up all of its constituent Mapping objects.
MappingSet(java.lang.String name) Creates a new set using the given name.

Method Summary

Modifier and Type	Method and Description
void	addMapping(Mapping mapping) Adds a Mapping to the set.
void	addMappingToBeDeleted(Mapping mapping) Adds a Mapping to the set to be deleted.
int	compareTo(java.lang.Object mappingSet) So we can be sorted.
void	delete() Deletes the set from the database.
void	deleteMapping(Mapping mapping) Queues up a Mapping to be deleted.
void	dumpToLog() Dumps the set to the log.
boolean	equals(java.lang.Object obj) Overriding equals...
int	getID() Gets the database ID of the set.
Mapping	getMapping(int sequence) Gets a Mapping based on an index.
java.util.TreeSet	getMappings() Gets a reference to the HashSet containing the Mapping objects.
java.util.Iterator	getMappingsIterator() Gets an Iterator used to cycle through the Mapping objects.
java.util.Iterator	getMappingsToBeDeletedIterator() Gets an Iterator used to cycle through the Mapping objects to be deleted.
java.lang.String	getName() Gets the name of the set.
int	getNumMappings() Gets the number of Mapping objects in the set.
java.lang.String	mapValue(java.lang.String value) Maps a value based on the mappings held by this set.
void	resequence(int beginSequence, int endSequence, boolean increaseSequences) Re-sequences all of the mappings whose sequence falls in between the given sequences.
void	save() Saves the set and all of its constituent Mapping objects to the database.
void	setName(java.lang.String name) Sets the name of the set.
java.lang.String	toString() Gets a String representation for the set.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

MappingSet

public MappingSet()

Default constructor required by Castor.

MappingSet

public MappingSet(java.lang.String name)

Creates a new set using the given name.

Parameters:

name - The name of the set.

MappingSet

public MappingSet(int mappingSetID,
                  java.lang.String name)

Creates a set with all values and loads up all of its constituent Mapping objects.

Parameters:

mappingSetID - The database ID of the set.

name - The name of the set.

Method Detail

getID

public int getID()

Gets the database ID of the set.

Returns:

The database ID.

getName

@Nullable
public java.lang.String getName()

Gets the name of the set.

Returns:

The name.

setName

public void setName(java.lang.String name)

Sets the name of the set.

Parameters:

name - The name.

getMappings

@Nullable
public java.util.TreeSet getMappings()

Gets a reference to the HashSet containing the Mapping objects. Note that this is public only for Castor.

Returns:

The HashSet.

getMappingsIterator

@NotNull
public java.util.Iterator getMappingsIterator()

Gets an Iterator used to cycle through the Mapping objects.

Returns:

An Iterator.

addMapping

public void addMapping(@NotNull
                       Mapping mapping)

Adds a Mapping to the set.

Parameters:

mapping - The mapping.

resequence

public void resequence(int beginSequence,
                       int endSequence,
                       boolean increaseSequences)

Re-sequences all of the mappings whose sequence falls in between the given sequences.

Parameters:

beginSequence - The sequence to begin at.

endSequence - The sequence to end at.

increaseSequences - Whether or not sequences should be increased.

getNumMappings

public int getNumMappings()

Gets the number of Mapping objects in the set.

Returns:

The number of objects.

getMapping

@Nullable
public Mapping getMapping(int sequence)

Gets a Mapping based on an index.

Parameters:

sequence - The sequence to check.

Returns:

The Mapping.

getMappingsToBeDeletedIterator

@NotNull
public java.util.Iterator getMappingsToBeDeletedIterator()

Gets an Iterator used to cycle through the Mapping objects to be deleted.

Returns:

An Iterator.

addMappingToBeDeleted

public void addMappingToBeDeleted(Mapping mapping)

Adds a Mapping to the set to be deleted.

Parameters:

mapping - The mapping.

deleteMapping

public void deleteMapping(@Nullable
                          Mapping mapping)

Queues up a Mapping to be deleted.

Parameters:

mapping - The Mapping to be deleted.

toString

@Nullable
public java.lang.String toString()

Gets a String representation for the set.

Overrides:

toString in class java.lang.Object

Returns:

The name.

mapValue

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

Maps a value based on the mappings held by this set.

Parameters:

value - The value to be mapped.

Returns:

The mapped value, if a mapping is found; otherwise, returns the original value.

compareTo

public int compareTo(java.lang.Object mappingSet)

So we can be sorted.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

mappingSet - The MappingSet we're comparing to.

Returns:

The usual stuff.

delete

public void delete()

Deletes the set from the database.

save

public void save()

Saves the set and all of its constituent Mapping objects 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 set to the log.