com.screenscraper.datamanager.skeleton.cache

Interface CacheReaderWriter

All Known Implementing Classes:

CacheToDatabaseReaderWriter

public interface CacheReaderWriter

Basic class used to read and write cache blocks

Version:

1.0

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 maxBlocks) 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

Method Detail

readCache

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

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

Parameters:

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

Returns:

The list of cache blocks

readCache

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

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

Parameters:

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

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

Returns:

The list of cache blocks

writeCache

void writeCache(long id,
                @NotNull
                CacheBlock block)

Writes a cache block for the given id

Parameters:

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

block - The block of data to write

validateCacheStructure

boolean validateCacheStructure()

Validates that the cache can be read from and written to

Returns:

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

getMainTable

@Nullable
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)

Returns:

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