com.kheops.util

Class KObjectCache

java.lang.Object

com.kheops.util.KObjectCache

public class KObjectCache
extends java.lang.Object

A class used to store and retrieve data stored on memory.

Constructor Summary

Constructors

Constructor and Description
KObjectCache(int maximumSize) Constructs a KMemoryDataCache with the specified maximum size

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String key) Checks if the table contains the data with the specified keys
long	getCurrentSize() Gets the memory cache current size
double	getEfficiency() This method returns the sucessfull retrieval data count over the number of retrieval attemps It enables to get statistic of the retrieve method
long	getMaximumSize() Gets the memory cache maximum allowed size
void	remove(java.lang.String key) Removes the memory cache with the specified key
java.lang.Object	retrieve(java.lang.String key) Retrieves the data previously stored using the specified key.
void	store(java.lang.String key, java.lang.Object object) Stores the specified object in memory cache using the specified key.

Methods inherited from class java.lang.Object

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

Constructor Detail

KObjectCache

public KObjectCache(int maximumSize)

Constructs a KMemoryDataCache with the specified maximum size

Parameters:

maximumSize - the maximum number of objects the cache can contain

Method Detail

store

public void store(java.lang.String key,
                  java.lang.Object object)

Stores the specified object in memory cache using the specified key.

Parameters:

key - the key of the KMemoryDataCache where to store the data

object - the object to be stored

retrieve

public java.lang.Object retrieve(java.lang.String key)

Retrieves the data previously stored using the specified key. If the data does not exist, no exception is thrown but the method returns null.

Parameters:

key - unique identifier used to search for the corresponding data

Returns:

data the data retrieved from memory
this method keeps the count of sucessfull and unsecessfull data retrieval

contains

public boolean contains(java.lang.String key)

Checks if the table contains the data with the specified keys

Parameters:

key - the corresponding key

Returns:

the boolean value of the result

getCurrentSize

public long getCurrentSize()

Gets the memory cache current size

Returns:

the current cache size

getMaximumSize

public long getMaximumSize()

Gets the memory cache maximum allowed size

Returns:

the maximum cache size

remove

public void remove(java.lang.String key)

Removes the memory cache with the specified key

Parameters:

key - the key of the data to be removed

getEfficiency

public double getEfficiency()

This method returns the sucessfull retrieval data count over the number of retrieval attemps It enables to get statistic of the retrieve method

Returns:

the effeciency ratio