org.bitrepository.pillar.cache

Interface ChecksumStore

All Known Implementing Classes:

ChecksumDAO

public interface ChecksumStore

Interface for the storage of checksums.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes and cleans up the ChecksumStore.
void	deleteEntry(String fileId, String collectionId) Deletes a given entry from the cache.
Collection<String>	getAllFileIDs(String collectionId) Retrieval of all the file ids in the store.
Date	getCalculationDate(String fileId, String collectionId) Retrieve the calculation date for the checksum of the file.
String	getChecksum(String fileId, String collectionId) Retrieve the checksum for the given file.
ExtractedChecksumResultSet	getEntries(XMLGregorianCalendar minTimeStamp, XMLGregorianCalendar maxTimeStamp, Long maxNumberOfResults, String collectionId) Retrieves the entries from the store.
ChecksumEntry	getEntry(String fileId, String collectionId)
ExtractedFileIDsResultSet	getFileIDs(XMLGregorianCalendar minTimeStamp, XMLGregorianCalendar maxTimeStamp, Long maxNumberOfResults, String collectionId) Retrieval of file ids.
boolean	hasFile(String fileId, String collectionId) Tells whether a given file id can be found in the cache.
void	insertChecksumCalculation(String fileId, String collectionId, String checksum, Date calculationDate) Inserts a checksum calculation for a given file.

Method Detail

getCalculationDate

Date getCalculationDate(String fileId,
                      String collectionId)

Retrieve the calculation date for the checksum of the file.

Parameters:

fileId - The id of the file.

collectionId - The id of the collection for the file.

Returns:

The calculation date for the checksum of the file at the collection.

getChecksum

String getChecksum(String fileId,
                 String collectionId)

Retrieve the checksum for the given file.

Parameters:

fileId - The id of the file.

collectionId - The id of the collection for the file.

Returns:

The checksum of the file.

getEntry

ChecksumEntry getEntry(String fileId,
                     String collectionId)

Parameters:

fileId - The id of the file.

collectionId - The id of the collection for the file.

Returns:

The entry with the checksum information about the file.

getEntries

ExtractedChecksumResultSet getEntries(XMLGregorianCalendar minTimeStamp,
                                    XMLGregorianCalendar maxTimeStamp,
                                    Long maxNumberOfResults,
                                    String collectionId)

Retrieves the entries from the store.

Parameters:

minTimeStamp - The minimum date for the timestamp of the extracted checksum entries.

maxTimeStamp - The maximum date for the timestamp of the extracted checksum entries.

maxNumberOfResults - The maximum number of results.

collectionId - The id of the collection for the file.

Returns:

The checksum entries from the store.

insertChecksumCalculation

void insertChecksumCalculation(String fileId,
                             String collectionId,
                             String checksum,
                             Date calculationDate)

Inserts a checksum calculation for a given file.

Parameters:

fileId - The id of the file.

collectionId - The id of the collection for the file.

checksum - The checksum of the file.

calculationDate - The date for the calculation of the checksum for the file.

getFileIDs

ExtractedFileIDsResultSet getFileIDs(XMLGregorianCalendar minTimeStamp,
                                   XMLGregorianCalendar maxTimeStamp,
                                   Long maxNumberOfResults,
                                   String collectionId)

Retrieval of file ids.

Parameters:

minTimeStamp - The minimum date for the timestamp of the extracted file ids.

maxTimeStamp - The maximum date for the timestamp of the extracted file ids.

maxNumberOfResults - The maximum number of results.

collectionId - The id of the collection for the file.

Returns:

The file ids in the store within the restrictions.

getAllFileIDs

Collection<String> getAllFileIDs(String collectionId)

Retrieval of all the file ids in the store.

Parameters:

collectionId - The id of the collection for the file.

Returns:

The collection of file ids in the store.

deleteEntry

void deleteEntry(String fileId,
               String collectionId)

Deletes a given entry from the cache.

Parameters:

fileId - The id of the file, whose entry should be removed from the cache.

collectionId - The id of the collection for the file.

hasFile

boolean hasFile(String fileId,
              String collectionId)

Tells whether a given file id can be found in the cache.

Parameters:

fileId - The id of the file to find in the cache.

collectionId - The id of the collection for the file.

Returns:

Whether the file could be found.

close

void close()

Closes and cleans up the ChecksumStore.