com.j_spaces.core.cache

Class MemoryBasedEntryCacheInfo

java.lang.Object

com.j_spaces.core.cache.MemoryBasedEntryCacheInfo

All Implemented Interfaces:

IHashEntry<Object,IStoredList<IEntryCacheInfo>>, EvictableServerEntry, ServerEntry, IEntryCacheInfo, ILeasedEntryCacheInfo, ICollection<IEntryCacheInfo>, IObjectInfo<IEntryCacheInfo>, IStoredList<IEntryCacheInfo>, IStoredListIterator<IEntryCacheInfo>, IObjectsList, IScanListIterator<IEntryCacheInfo>

Direct Known Subclasses:

EvictableEntryCacheInfo

public class MemoryBasedEntryCacheInfo
extends Object
implements IEntryCacheInfo

Field Summary

Fields

Modifier and Type	Field and Description
static int	UID_HASH_INDICATOR

Constructor Summary

Constructors

Constructor and Description
MemoryBasedEntryCacheInfo(IEntryHolder entryHolder) Const used only for snapshots, called from CacheManager.prePrepare(Context, ServerTransaction).
MemoryBasedEntryCacheInfo(IEntryHolder entryHolder, int backRefsSize)

Method Summary

Modifier and Type	Method and Description
IObjectInfo<IEntryCacheInfo>	add(IEntryCacheInfo subject) Store an element in the list.
IObjectInfo<IEntryCacheInfo>	addUnlocked(IEntryCacheInfo subject) Store an element in the list, while the SL is unlocked .
boolean	contains(IEntryCacheInfo obj) Checks whether it contains the specified element.
void	dump(Logger logger, String msg) Dump list content, used for Debug.
IStoredListIterator<IEntryCacheInfo>	establishListScan(boolean random_scan) establish a scan position.
void	freeSLHolder(IStoredListIterator slh) Called by an outside scan that wants to quit the scan and return the slholder to the resource pool.
int	getAlreadyMatchedFixedPropertyIndexPos() if the scan is on a property index, currently supported for extended index
String	getAlreadyMatchedIndexPath()
ArrayList<IObjectInfo<IEntryCacheInfo>>	getBackRefs()
String	getClassName()
IEntryHolder	getEntryHolder()
IEntryHolder	getEntryHolder(CacheManager cacheManager)
IEntryHolder	getEntryHolder(CacheManager cacheManager, Context context)
Object	getEvictionPayLoad() in order to avoid searching the eviction handler data structures when an existing entry is rendered to it by the space cache manager, the eviction-handler may store a backref to the entry in it data structure and retrieve it later
long	getExpirationTime() Gets the entry expiration time.
Object	getFixedPropertyValue(int position) Gets the specified fixed property's value.
int	getHashCode(int id)
IObjectInfo<IEntryCacheInfo>	getHead() Returns the first element in the list (fifo)
Object	getKey(int id)
int	getLatestIndexCreationNumber()
IStoredList<Object>	getLeaseManagerListRef()
IObjectInfo<Object>	getLeaseManagerPosition()
IObjectInfo<IEntryCacheInfo>	getMainListBackRef()
IEntryCacheInfo	getObjectFromHead() Returns the value of the first element in the list (fifo)
Object	getObjectStoredInLeaseManager()
Object	getPathValue(String path) Gets the specified path's value.
Object	getPropertyValue(String name) Gets the specified property's value.
IServerTypeDesc	getServerTypeDesc()
SpaceTypeDescriptor	getSpaceTypeDescriptor() Gets the entry's type descriptor.
IEntryCacheInfo	getSubject() Gets the subject pointed to by the cursor's scan.
String	getUID() Returns the entry unique space identifier.
IStoredList<IEntryCacheInfo>	getValue(int id)
int	getVersion() Gets the entry version.
boolean	hasNext()
boolean	indexesBackRefsKept()
boolean	invalidate() Sets an indication that this StoredList is invalid.
boolean	isAlreadyMatched() is the entry returned already matched against the searching template currently is true if the underlying scan made by CacheManager::EntriesIter
boolean	isConnectedToLeaseManager()
boolean	isDeleted()
boolean	isEmpty() Returns true if this list is empty, i.e.
boolean	isInCache()
boolean	isInserted()
boolean	isIterator() is the list an iterator or basic list ?
boolean	isMultiObjectCollection() is it an actual multi object container.
boolean	isNativeHashEntry()
boolean	isOffHeapEntry()
boolean	isPinned()
boolean	isRecentDelete()
boolean	isRemoved()
boolean	isRemoving()
boolean	isRemovingOrRemoved()
boolean	isSameLeaseManagerRef(ILeasedEntryCacheInfo other)
boolean	isTransient()
IEntryCacheInfo	next()
IStoredListIterator<IEntryCacheInfo>	next(IStoredListIterator<IEntryCacheInfo> slh) Returns the next element in the scan order.
boolean	optimizeScanForSingleObject() return true if we can save iterator creation and get a single entry
boolean	preMatch(Context context, ITemplateHolder template)
void	release() Release of this SLHolder resource
void	releaseScan() release SLHolder for this scan
void	remove(IObjectInfo oi) Remove an element described by ObjectInfo.
boolean	removeByObject(IEntryCacheInfo obj) Given an element scan the list, find it and remove it.
void	removeUnlocked(IObjectInfo oi) Remove an element described by ObjectInfo, while the SL is unlocked.
void	setBackRefs(ArrayList<IObjectInfo<IEntryCacheInfo>> backRefs)
void	setEvictionPayLoad(Object evictionBackRef) in order to avoid searching the eviction handler data structures when an existing entry is rendered to it by the space cache manager, the eviction-handler may store a backref to the entry in it data structure and retrieve it later
void	setInCache(boolean checkPendingPin)
void	setLatestIndexCreationNumber(int val)
void	setLeaseManagerListRefAndPosition(IStoredList<Object> entriesList, IObjectInfo<Object> entryPos)
void	setMainListBackRef(IObjectInfo<IEntryCacheInfo> mainListBackref)
boolean	setPinned(boolean value)
boolean	setPinned(boolean value, boolean waitIfPendingInsertion)
void	setRecentDelete()
void	setRemoved()
boolean	setRemoving(boolean isPinned)
void	setSubject(IEntryCacheInfo subject) Sets the subject for this node.
int	size() Returns the amount of elements in the StoredList.
boolean	wasInserted()

Methods inherited from class java.lang.Object

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

Field Detail

UID_HASH_INDICATOR

public static final int UID_HASH_INDICATOR

See Also:

Constant Field Values

Constructor Detail

MemoryBasedEntryCacheInfo

public MemoryBasedEntryCacheInfo(IEntryHolder entryHolder)

Const used only for snapshots, called from CacheManager.prePrepare(Context, ServerTransaction). Assuming no need for the m_BackRefs ArrayList.

MemoryBasedEntryCacheInfo

public MemoryBasedEntryCacheInfo(IEntryHolder entryHolder,
                                 int backRefsSize)

Method Detail

getEntryHolder

public IEntryHolder getEntryHolder(CacheManager cacheManager)

Specified by:

getEntryHolder in interface IEntryCacheInfo

Returns:

the m_EntryHolder.

getEntryHolder

public IEntryHolder getEntryHolder()

getEntryHolder

public IEntryHolder getEntryHolder(CacheManager cacheManager,
                                   Context context)

Specified by:

getEntryHolder in interface IEntryCacheInfo

isDeleted

public boolean isDeleted()

Specified by:

isDeleted in interface IEntryCacheInfo

Returns:

true if the entry is deleted

getBackRefs

public ArrayList<IObjectInfo<IEntryCacheInfo>> getBackRefs()

Specified by:

getBackRefs in interface IEntryCacheInfo

Returns:

Returns the m_BackRefs.

setBackRefs

public void setBackRefs(ArrayList<IObjectInfo<IEntryCacheInfo>> backRefs)

Specified by:

setBackRefs in interface IEntryCacheInfo

getMainListBackRef

public IObjectInfo<IEntryCacheInfo> getMainListBackRef()

Specified by:

getMainListBackRef in interface IEntryCacheInfo

indexesBackRefsKept

public boolean indexesBackRefsKept()

Specified by:

indexesBackRefsKept in interface IEntryCacheInfo

setMainListBackRef

public void setMainListBackRef(IObjectInfo<IEntryCacheInfo> mainListBackref)

Specified by:

setMainListBackRef in interface IEntryCacheInfo

setLeaseManagerListRefAndPosition

public void setLeaseManagerListRefAndPosition(IStoredList<Object> entriesList,
                                              IObjectInfo<Object> entryPos)

Specified by:

setLeaseManagerListRefAndPosition in interface IEntryCacheInfo

Specified by:

setLeaseManagerListRefAndPosition in interface ILeasedEntryCacheInfo

getLeaseManagerListRef

public IStoredList<Object> getLeaseManagerListRef()

Specified by:

getLeaseManagerListRef in interface IEntryCacheInfo

Specified by:

getLeaseManagerListRef in interface ILeasedEntryCacheInfo

getLeaseManagerPosition

public IObjectInfo<Object> getLeaseManagerPosition()

Specified by:

getLeaseManagerPosition in interface IEntryCacheInfo

Specified by:

getLeaseManagerPosition in interface ILeasedEntryCacheInfo

isConnectedToLeaseManager

public boolean isConnectedToLeaseManager()

Specified by:

isConnectedToLeaseManager in interface IEntryCacheInfo

Specified by:

isConnectedToLeaseManager in interface ILeasedEntryCacheInfo

isSameLeaseManagerRef

public boolean isSameLeaseManagerRef(ILeasedEntryCacheInfo other)

Specified by:

isSameLeaseManagerRef in interface IEntryCacheInfo

Specified by:

isSameLeaseManagerRef in interface ILeasedEntryCacheInfo

isOffHeapEntry

public boolean isOffHeapEntry()

Specified by:

isOffHeapEntry in interface ILeasedEntryCacheInfo

getObjectStoredInLeaseManager

public Object getObjectStoredInLeaseManager()

Specified by:

getObjectStoredInLeaseManager in interface ILeasedEntryCacheInfo

getServerTypeDesc

public IServerTypeDesc getServerTypeDesc()

Specified by:

getServerTypeDesc in interface IEntryCacheInfo

getLatestIndexCreationNumber

public int getLatestIndexCreationNumber()

Specified by:

getLatestIndexCreationNumber in interface IEntryCacheInfo

setLatestIndexCreationNumber

public void setLatestIndexCreationNumber(int val)

Specified by:

setLatestIndexCreationNumber in interface IEntryCacheInfo

getClassName

public String getClassName()

Specified by:

getClassName in interface IEntryCacheInfo

setEvictionPayLoad

public void setEvictionPayLoad(Object evictionBackRef)

in order to avoid searching the eviction handler data structures when an existing entry is rendered to it by the space cache manager, the eviction-handler may store a backref to the entry in it data structure and retrieve it later

Specified by:

setEvictionPayLoad in interface EvictableServerEntry

getEvictionPayLoad

public Object getEvictionPayLoad()

in order to avoid searching the eviction handler data structures when an existing entry is rendered to it by the space cache manager, the eviction-handler may store a backref to the entry in it data structure and retrieve it later

Specified by:

getEvictionPayLoad in interface EvictableServerEntry

Returns:

the eviction back-ref to the entry, or null if not stored

isTransient

public boolean isTransient()

getUID

public String getUID()

Description copied from interface: EvictableServerEntry

Returns the entry unique space identifier.

Specified by:

getUID in interface EvictableServerEntry

setInCache

public void setInCache(boolean checkPendingPin)

Specified by:

setInCache in interface IEntryCacheInfo

isInCache

public boolean isInCache()

isInserted

public boolean isInserted()

setPinned

public boolean setPinned(boolean value,
                         boolean waitIfPendingInsertion)

Specified by:

setPinned in interface IEntryCacheInfo

setPinned

public boolean setPinned(boolean value)

Specified by:

setPinned in interface IEntryCacheInfo

isPinned

public boolean isPinned()

Specified by:

isPinned in interface IEntryCacheInfo

setRemoving

public boolean setRemoving(boolean isPinned)

Specified by:

setRemoving in interface IEntryCacheInfo

isRemoving

public boolean isRemoving()

Specified by:

isRemoving in interface IEntryCacheInfo

setRemoved

public void setRemoved()

Specified by:

setRemoved in interface IEntryCacheInfo

isRemoved

public boolean isRemoved()

Specified by:

isRemoved in interface IEntryCacheInfo

isRemovingOrRemoved

public boolean isRemovingOrRemoved()

Specified by:

isRemovingOrRemoved in interface IEntryCacheInfo

wasInserted

public boolean wasInserted()

Specified by:

wasInserted in interface IEntryCacheInfo

isRecentDelete

public boolean isRecentDelete()

Specified by:

isRecentDelete in interface IEntryCacheInfo

setRecentDelete

public void setRecentDelete()

Specified by:

setRecentDelete in interface IEntryCacheInfo

preMatch

public boolean preMatch(Context context,
                        ITemplateHolder template)

Specified by:

preMatch in interface IEntryCacheInfo

getHead

public IObjectInfo<IEntryCacheInfo> getHead()

Description copied from interface: IStoredList

Returns the first element in the list (fifo)

Specified by:

getHead in interface IStoredList<IEntryCacheInfo>

Returns:

the head of the list

getObjectFromHead

public IEntryCacheInfo getObjectFromHead()

Description copied from interface: IStoredList

Returns the value of the first element in the list (fifo)

Specified by:

getObjectFromHead in interface IStoredList<IEntryCacheInfo>

Returns:

the value of the head of the list

freeSLHolder

public void freeSLHolder(IStoredListIterator slh)

Description copied from interface: IStoredList

Called by an outside scan that wants to quit the scan and return the slholder to the resource pool.

Specified by:

freeSLHolder in interface IStoredList<IEntryCacheInfo>

Parameters:

slh - Holder resource to return to pool; can be null.

remove

public void remove(IObjectInfo oi)

Description copied from interface: IStoredList

Remove an element described by ObjectInfo. [Tail] - .. - [beforeOi] - [oi] - [afterOi] - .. - [Head]

Specified by:

remove in interface IStoredList<IEntryCacheInfo>

Parameters:

oi - an existing element between Tail and Head

removeUnlocked

public void removeUnlocked(IObjectInfo oi)

Description copied from interface: IStoredList

Remove an element described by ObjectInfo, while the SL is unlocked. [Tail] - .. - [beforeOi] - [oi] - [afterOi] - .. - [Head]

Specified by:

removeUnlocked in interface IStoredList<IEntryCacheInfo>

Parameters:

oi - an existing element between Tail and Head

invalidate

public boolean invalidate()

Description copied from interface: IStoredList

Sets an indication that this StoredList is invalid. if isEmpty() returns true, the indication is set; otherwise the indication remains false. Called by PersistentGC when scanning for empty StoredList that can be garbage collected.

Specified by:

invalidate in interface IStoredList<IEntryCacheInfo>

Returns:

true if StoredList was set to invalid; false otherwise.

dump

public void dump(Logger logger,
                 String msg)

Description copied from interface: IStoredList

Dump list content, used for Debug.

Specified by:

dump in interface IStoredList<IEntryCacheInfo>

Parameters:

logger - logger to use

msg - message to add in log

size

public int size()

Description copied from interface: ICollection

Returns the amount of elements in the StoredList.

Specified by:

size in interface ICollection<IEntryCacheInfo>

Returns:

size of the StoredList

See Also:

ICollection.isEmpty()

isEmpty

public boolean isEmpty()

Description copied from interface: ICollection

Returns true if this list is empty, i.e. has no elements. [Tail] - [Head]

Specified by:

isEmpty in interface ICollection<IEntryCacheInfo>

Returns:

true if list is empty; false otherwise.

establishListScan

public IStoredListIterator<IEntryCacheInfo> establishListScan(boolean random_scan)

Description copied from interface: ICollection

establish a scan position. if random scan is supported we select a random position; otherwise we return the first resource by scanning from head to tail.

Specified by:

establishListScan in interface ICollection<IEntryCacheInfo>

Parameters:

random_scan - true enable random scan; false start from head.

Returns:

a Holder for this scan. This Resource should be released if scan ended prematurely.

next

public IStoredListIterator<IEntryCacheInfo> next(IStoredListIterator<IEntryCacheInfo> slh)

Description copied from interface: ICollection

Returns the next element in the scan order. Calling this method until it returns null, will return each element as part of the SLHolders subject.

Specified by:

next in interface ICollection<IEntryCacheInfo>

Parameters:

slh - Holder representing a pivot position.

Returns:

the next pivot position in this scan; null if reached end of scan.

add

public IObjectInfo<IEntryCacheInfo> add(IEntryCacheInfo subject)

Description copied from interface: ICollection

Store an element in the list. New elements are inserted at the tail.

Specified by:

add in interface ICollection<IEntryCacheInfo>

Parameters:

subject - element to store.

Returns:

an information node representing the inserted element; null if StoredList has been invalidated.

addUnlocked

public IObjectInfo<IEntryCacheInfo> addUnlocked(IEntryCacheInfo subject)

Description copied from interface: IStoredList

Store an element in the list, while the SL is unlocked . New elements are inserted at the tail.

Specified by:

addUnlocked in interface IStoredList<IEntryCacheInfo>

Parameters:

subject - element to store.

Returns:

an information node representing the inserted element; null if StoredList has been invalidated.

removeByObject

public boolean removeByObject(IEntryCacheInfo obj)

Description copied from interface: ICollection

Given an element scan the list, find it and remove it.

Specified by:

removeByObject in interface ICollection<IEntryCacheInfo>

Parameters:

obj - element to remove

Returns:

true if object was removed; false otherwise (if element wasn't found)

contains

public boolean contains(IEntryCacheInfo obj)

Description copied from interface: ICollection

Checks whether it contains the specified element.

Specified by:

contains in interface ICollection<IEntryCacheInfo>

Parameters:

obj - the element to search for

Returns:

true if element exists in the StoredList; false otherwise.

setSubject

public void setSubject(IEntryCacheInfo subject)

Description copied from interface: IObjectInfo

Sets the subject for this node.

Specified by:

setSubject in interface IObjectInfo<IEntryCacheInfo>

Specified by:

setSubject in interface IStoredListIterator<IEntryCacheInfo>

Parameters:

subject - The subject to set.

getSubject

public IEntryCacheInfo getSubject()

Description copied from interface: IStoredListIterator

Gets the subject pointed to by the cursor's scan.

Specified by:

getSubject in interface IObjectInfo<IEntryCacheInfo>

Specified by:

getSubject in interface IStoredListIterator<IEntryCacheInfo>

Returns:

Returns the subject at this node.

isMultiObjectCollection

public boolean isMultiObjectCollection()

Description copied from interface: ICollection

is it an actual multi object container.

Specified by:

isMultiObjectCollection in interface ICollection<IEntryCacheInfo>

Returns:

true if its an actual list; false otherwise

optimizeScanForSingleObject

public boolean optimizeScanForSingleObject()

return true if we can save iterator creation and get a single entry

Specified by:

optimizeScanForSingleObject in interface IStoredList<IEntryCacheInfo>

Returns:

true if we can optimize

hasNext

public boolean hasNext()
                throws SAException

Specified by:

hasNext in interface IScanListIterator<IEntryCacheInfo>

Throws:

SAException

next

public IEntryCacheInfo next()
                     throws SAException

Specified by:

next in interface IScanListIterator<IEntryCacheInfo>

Throws:

SAException

releaseScan

public void releaseScan()
                 throws SAException

release SLHolder for this scan

Specified by:

releaseScan in interface IScanListIterator<IEntryCacheInfo>

Throws:

SAException

getAlreadyMatchedFixedPropertyIndexPos

public int getAlreadyMatchedFixedPropertyIndexPos()

if the scan is on a property index, currently supported for extended index

Specified by:

getAlreadyMatchedFixedPropertyIndexPos in interface IScanListIterator<IEntryCacheInfo>

getAlreadyMatchedIndexPath

public String getAlreadyMatchedIndexPath()

Specified by:

getAlreadyMatchedIndexPath in interface IScanListIterator<IEntryCacheInfo>

isAlreadyMatched

public boolean isAlreadyMatched()

is the entry returned already matched against the searching template currently is true if the underlying scan made by CacheManager::EntriesIter

Specified by:

isAlreadyMatched in interface IScanListIterator<IEntryCacheInfo>

isIterator

public boolean isIterator()

Description copied from interface: IObjectsList

is the list an iterator or basic list ?

Specified by:

isIterator in interface IObjectsList

getSpaceTypeDescriptor

public SpaceTypeDescriptor getSpaceTypeDescriptor()

Gets the entry's type descriptor.

Specified by:

getSpaceTypeDescriptor in interface ServerEntry

Returns:

Current entry's type descriptor.

getFixedPropertyValue

public Object getFixedPropertyValue(int position)

Gets the specified fixed property's value.

Specified by:

getFixedPropertyValue in interface ServerEntry

Parameters:

position - Position of requested property.

Returns:

Requested property's value in current entry.

getPropertyValue

public Object getPropertyValue(String name)

Gets the specified property's value.

Specified by:

getPropertyValue in interface ServerEntry

Parameters:

name - Name of requested property.

Returns:

Requested property's value in current entry.

getPathValue

public Object getPathValue(String path)

Description copied from interface: ServerEntry

Gets the specified path's value. The returned value is a reference to the actual property kept in the space.

Specified by:

getPathValue in interface ServerEntry

Parameters:

path - Path pointing to the requested property.

Returns:

Requested path's value in current entry.

getVersion

public int getVersion()

Gets the entry version.

Specified by:

getVersion in interface ServerEntry

Returns:

the entry version.

Since:

9.0.0

getExpirationTime

public long getExpirationTime()

Gets the entry expiration time.

Specified by:

getExpirationTime in interface ServerEntry

Returns:

the entry expiration time.

Since:

9.0.0

getHashCode

public int getHashCode(int id)

Specified by:

getHashCode in interface IHashEntry<Object,IStoredList<IEntryCacheInfo>>

getKey

public Object getKey(int id)

Specified by:

getKey in interface IHashEntry<Object,IStoredList<IEntryCacheInfo>>

getValue

public IStoredList<IEntryCacheInfo> getValue(int id)

Specified by:

getValue in interface IHashEntry<Object,IStoredList<IEntryCacheInfo>>

isNativeHashEntry

public boolean isNativeHashEntry()

Specified by:

isNativeHashEntry in interface IHashEntry<Object,IStoredList<IEntryCacheInfo>>

Returns:

true if this is a native hashmap entry

release

public void release()

Description copied from interface: IStoredListIterator

Release of this SLHolder resource

Specified by:

release in interface IStoredListIterator<IEntryCacheInfo>

See Also:

Resource.release()