Package org.compiere.util

Class CCache<K,V>

java.lang.Object

org.compiere.util.CCache<K,V>

Type Parameters:

K - Key

V - Value

All Implemented Interfaces:

Serializable, Map<K,V>, CacheInterface

Direct Known Subclasses:

ImmutablePOCache, NaturalAccountMap, POCopyCache

public class CCache<K,V>
extends Object
implements CacheInterface, Map<K,V>, Serializable

Cache for table.

Version:

$Id: CCache.java,v 1.2 2006/07/30 00:54:35 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<K,V>	cache
static int	DEFAULT_EXPIRE_MINUTE	Default cache expire time in minutes
protected Set<K>	nullList

Constructor Summary

Constructors

Constructor	Description
CCache(String name, int initialCapacity)
CCache(String name, int initialCapacity, int expireMinutes)
CCache(String name, int initialCapacity, int expireMinutes, boolean distributed)
CCache(String name, int initialCapacity, int expireMinutes, boolean distributed, int maxSize)
CCache(String tableName, String name, int initialCapacity)	Adempiere Cache - expires after 2 hours
CCache(String tableName, String name, int initialCapacity, boolean distributed)
CCache(String tableName, String name, int initialCapacity, int expireMinutes, boolean distributed)
CCache(String tableName, String name, int initialCapacity, int expireMinutes, boolean distributed, int maxSize)	Adempiere Cache

Method Summary

Modifier and Type	Method	Description
void	addVetoableChangeListener(VetoableChangeListener listener)	Add Vetoable Change Listener
void	clear()	Clear cache and calculate new expiry time
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()	The return entry set exclude entries that contains null value
V	get(Object key)
int	getExpireMinutes()	Get Expire Minutes
long	getHit()
int	getMaxSize()
long	getMiss()
String	getName()	Get (table) Name
String	getTableName()
boolean	isDistributed()
boolean	isEmpty()
boolean	isExpire()
boolean	isReset()	Cache was reset
Set<K>	keySet()	The return key set excludes key that map to null value
void	newRecord(int record_ID)	New record created notification
V	put(K key, V value)	Put value
void	putAll(Map<? extends K,? extends V> m)	Put All
V	remove(Object key)
void	removeVetoableChangeListener(VetoableChangeListener listener)	Remove Vetoable Change Listener
int	reset()	Reset Cache
int	reset(int recordId)	Reset Cache by record id
void	setExpireMinutes(int expireMinutes)	Set Expire Minutes and start it
void	setUsed()	Resets the Reset flag
int	size()	Get Size of Cache
int	sizeNoExpire()	Get Size w/o Expire
String	toString()	String Representation
Collection<V>	values()	The return values collection exclude null value entries

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

cache

protected Map<K,V> cache

nullList

protected Set<K> nullList

DEFAULT_EXPIRE_MINUTE

public static final int DEFAULT_EXPIRE_MINUTE

Default cache expire time in minutes

Constructor Detail

CCache

public CCache(String name,
              int initialCapacity)

CCache

public CCache(String name,
              int initialCapacity,
              int expireMinutes)

CCache

public CCache(String name,
              int initialCapacity,
              int expireMinutes,
              boolean distributed)

CCache

public CCache(String name,
              int initialCapacity,
              int expireMinutes,
              boolean distributed,
              int maxSize)

CCache

public CCache(String tableName,
              String name,
              int initialCapacity)

Adempiere Cache - expires after 2 hours

Parameters:

name - (table) name of the cache

initialCapacity - initial capacity

CCache

public CCache(String tableName,
              String name,
              int initialCapacity,
              boolean distributed)

CCache

public CCache(String tableName,
              String name,
              int initialCapacity,
              int expireMinutes,
              boolean distributed)

CCache

public CCache(String tableName,
              String name,
              int initialCapacity,
              int expireMinutes,
              boolean distributed,
              int maxSize)

Adempiere Cache

Parameters:

name - (table) name of the cache

initialCapacity - initial capacity

expireMinutes - expire after minutes (0=no expire)

distributed -

maxSize - ignore if distributed=true

Method Detail

getName

public String getName()

Get (table) Name

Returns:

name

getTableName

public String getTableName()

setExpireMinutes

public void setExpireMinutes(int expireMinutes)

Set Expire Minutes and start it

Parameters:

expireMinutes - minutes or 0

getExpireMinutes

public int getExpireMinutes()

Get Expire Minutes

Returns:

expire minutes

isReset

public boolean isReset()

Cache was reset

Returns:

true if reset

setUsed

public void setUsed()

Resets the Reset flag

reset

public int reset()

Reset Cache

Specified by:

reset in interface CacheInterface

Returns:

number of items cleared

See Also:

CacheInterface.reset()

toString

public String toString()

String Representation

Overrides:

toString in class Object

Returns:

info

clear

public void clear()

Clear cache and calculate new expiry time

Specified by:

clear in interface Map<K,V>

See Also:

Map.clear()

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

See Also:

Map.containsKey(java.lang.Object)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

See Also:

Map.containsValue(java.lang.Object)

entrySet

public Set<Map.Entry<K,V>> entrySet()

The return entry set exclude entries that contains null value

Specified by:

entrySet in interface Map<K,V>

See Also:

Map.entrySet()

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

See Also:

Map.get(java.lang.Object)

put

public V put(K key,
             V value)

Put value

Specified by:

put in interface Map<K,V>

Parameters:

key - key

value - value

Returns:

previous value

putAll

public void putAll(Map<? extends K,? extends V> m)

Put All

Specified by:

putAll in interface Map<K,V>

Parameters:

m - map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

See Also:

Map.isEmpty()

keySet

public Set<K> keySet()

The return key set excludes key that map to null value

Specified by:

keySet in interface Map<K,V>

See Also:

Map.keySet()

size

public int size()

Description copied from interface: CacheInterface

Get Size of Cache

Specified by:

size in interface CacheInterface

Specified by:

size in interface Map<K,V>

Returns:

number of items

See Also:

Map.size()

sizeNoExpire

public int sizeNoExpire()

Get Size w/o Expire

Returns:

size

See Also:

Map.size()

values

public Collection<V> values()

The return values collection exclude null value entries

Specified by:

values in interface Map<K,V>

See Also:

Map.values()

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener listener)

Add Vetoable Change Listener

Parameters:

listener - listner

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener listener)

Remove Vetoable Change Listener

Parameters:

listener - listener

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

reset

public int reset(int recordId)

Description copied from interface: CacheInterface

Reset Cache by record id

Specified by:

reset in interface CacheInterface

Returns:

number of items reset

newRecord

public void newRecord(int record_ID)

Description copied from interface: CacheInterface

New record created notification

Specified by:

newRecord in interface CacheInterface

getMaxSize

public int getMaxSize()

Returns:

max size of cache

isDistributed

public boolean isDistributed()

Returns:

true if cache is distributed (using hazelcast)

getHit

public long getHit()

Returns:

cache hit count

getMiss

public long getMiss()

Returns:

cache miss count

isExpire

public boolean isExpire()

Returns:

true if cache has expire