com.screenscraper.scraper

Class MappingSetManager

java.lang.Object

com.screenscraper.scraper.MappingSetManager

public class MappingSetManager
extends java.lang.Object

Manages all MappingSet objects for the application.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MappingSetManager() Constructs an empty mapping set manager.

Method Summary

Modifier and Type	Method and Description
boolean	addMappingSet(MappingSet mappingSet) Adds a MappingSet to the local collection.
void	deleteMappingSet(java.lang.String setName) Deletes a set identified by the given name.
static MappingSetManager	getInstance() Returns the singleton instance of the class.
MappingSet	getMappingSet(java.lang.String name) Gets the MappingSet corresponding to the given name.
MappingSet	getMappingSetByID(int mappingSetID) Gets a MappingSet based on its database ID.
MappingSet	getMappingSetByName(java.lang.String name) Gets a MappingSet based on its name.
MappingSet	getMappingSetBySequence(int index) Gets the MappingSet at the given position.
java.util.Iterator	getMappingSetIterator() Reterns an Iterator over which the MappingSet objects can be iterated.
int	getNumMappingSets() Gets the number of MappingSet objects in the manager.
void	removeMappingSet(java.lang.String setName) Removes a set identified by the given name.
void	save() Saves the various sets to the database.

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.

Constructor Detail

MappingSetManager

public MappingSetManager()

Constructs an empty mapping set manager.

Method Detail

getInstance

@Nullable
public static MappingSetManager getInstance()

Returns the singleton instance of the class.

Returns:

An instance of MappingSetManager

getMappingSetIterator

@NotNull
public java.util.Iterator getMappingSetIterator()

Reterns an Iterator over which the MappingSet objects can be iterated.

Returns:

An Iterator.

addMappingSet

public boolean addMappingSet(@Nullable
                             MappingSet mappingSet)

Adds a MappingSet to the local collection.

Parameters:

mappingSet - The MappingSet to add.

Returns:

true if the set was added; false, otherwise.

getNumMappingSets

public int getNumMappingSets()

Gets the number of MappingSet objects in the manager.

Returns:

The number.

getMappingSet

@Nullable
public MappingSet getMappingSet(@Nullable
                                           java.lang.String name)

Gets the MappingSet corresponding to the given name.

Parameters:

name - The name of the set.

Returns:

A MappingSet if found; null, otherwise.

getMappingSetBySequence

@Nullable
public MappingSet getMappingSetBySequence(int index)

Gets the MappingSet at the given position.

Parameters:

index - The zero-based index of the position.

Returns:

A MappingSet if the position is valid; null, otherwise.

getMappingSetByID

@Nullable
public MappingSet getMappingSetByID(int mappingSetID)

Gets a MappingSet based on its database ID.

Parameters:

mappingSetID - The database ID of the mapping set.

Returns:

A MappingSet, if found.

getMappingSetByName

@Nullable
public MappingSet getMappingSetByName(@NotNull
                                                 java.lang.String name)

Gets a MappingSet based on its name.

Parameters:

name - The name of the mapping set.

Returns:

A MappingSet, if found.

removeMappingSet

public void removeMappingSet(@Nullable
                             java.lang.String setName)

Removes a set identified by the given name.

Parameters:

setName - The name of the set to delete.

deleteMappingSet

public void deleteMappingSet(@Nullable
                             java.lang.String setName)

Deletes a set identified by the given name.

Parameters:

setName - The name of the set to delete.

save

public void save()

Saves the various sets to the database.