com.screenscraper.datamanager.sql.cache

Class CacheToDatabaseReaderWriter

java.lang.Object

com.screenscraper.datamanager.sql.cache.CacheToDatabaseReaderWriter

All Implemented Interfaces:

CacheReaderWriter

public class CacheToDatabaseReaderWriter
extends java.lang.Object
implements CacheReaderWriter

The data cache reader/writer that simply stores everything to a database table

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
CacheToDatabaseReaderWriter(SqlDataManager dataManager, java.lang.String cacheTableName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMainTable() Validates that the cache can be read from and written to, and if so returns the name of the main table (which the cache references)
java.util.List<CacheBlock>	readCache(long id) Reads all the cache blocks for the given id from the database
java.util.List<CacheBlock>	readCache(long id, int maxNum) Reads up to the maximum number of cache blocks for the given id from the database
boolean	validateCacheStructure() Validates that the cache can be read from and written to
void	writeCache(long id, CacheBlock block) Writes a cache block for the given id

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheToDatabaseReaderWriter

public CacheToDatabaseReaderWriter(@NotNull
                                   SqlDataManager dataManager,
                                   @NotNull
                                   java.lang.String cacheTableName)

Method Detail

readCache

@NotNull
public java.util.List<CacheBlock> readCache(long id)

Description copied from interface: CacheReaderWriter

Reads all the cache blocks for the given id from the database

Specified by:

readCache in interface CacheReaderWriter

Parameters:

id - The id of the main table row in the database

Returns:

The list of cache blocks

readCache

@NotNull
public java.util.List<CacheBlock> readCache(long id,
                                                      int maxNum)

Description copied from interface: CacheReaderWriter

Reads up to the maximum number of cache blocks for the given id from the database

Specified by:

readCache in interface CacheReaderWriter

Parameters:

id - The id of the main table row in the database

maxNum - The maximum number of blocks to load, or negative to indicate infinite

Returns:

The list of cache blocks

writeCache

public void writeCache(long id,
                       @NotNull
                       CacheBlock block)

Writes a cache block for the given id

Specified by:

writeCache in interface CacheReaderWriter

Parameters:

id - The id of the main table row in the database (can be null if the main row failed to write)

block - The block of data to write

getMainTable

@Nullable
public java.lang.String getMainTable()

Description copied from interface: CacheReaderWriter

Validates that the cache can be read from and written to, and if so returns the name of the main table (which the cache references)

Specified by:

getMainTable in interface CacheReaderWriter

Returns:

The name of the main table, or null if validation fails

validateCacheStructure

public boolean validateCacheStructure()

Validates that the cache can be read from and written to

Specified by:

validateCacheStructure in interface CacheReaderWriter

Returns:

True if the cache can be read or written, false otherwise