com.hazelcast.map.impl.querycache.subscriber

Class NullQueryCache

java.lang.Object

com.hazelcast.map.impl.querycache.subscriber.NullQueryCache

All Implemented Interfaces:

InternalQueryCache, QueryCache

public final class NullQueryCache
extends Object
implements InternalQueryCache

Object for neutral InternalQueryCache implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static InternalQueryCache	NULL_QUERY_CACHE Null query cache implementation.

Method Summary

Modifier and Type	Method and Description
String	addEntryListener(MapListener listener, boolean includeValue)
String	addEntryListener(MapListener listener, Object key, boolean includeValue)
String	addEntryListener(MapListener listener, Predicate predicate, boolean includeValue)
String	addEntryListener(MapListener listener, Predicate predicate, Object key, boolean includeValue)
void	addIndex(String attribute, boolean ordered)
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
void	delete(Object key, EntryEventType eventType)
void	destroy() Destroys this cache.
Set<Map.Entry>	entrySet()
Set<Map.Entry>	entrySet(Predicate predicate)
Object	get(Object key)
Map	getAll(Set keys)
String	getCacheId()
IMap	getDelegate()
Extractors	getExtractors()
Indexes	getIndexes()
String	getName() Returns the name of this QueryCache.
String	getPublisherListenerId()
boolean	isEmpty()
Set	keySet()
Set	keySet(Predicate predicate)
void	prepopulate(Object key, Object value) Used during initial population of query cache.
boolean	reachedMaxCapacity() Used to quit pre-population when max size is reached.
void	recreate() Recreates this query cache.
int	removeEntriesOf(int partitionId) Scans all entries in this QueryCache to remove matching ones with supplied partitionId
boolean	removeEntryListener(String id)
void	set(Object key, Object value, EntryEventType eventType)
void	setPublisherListenerId(String publisherListenerId)
int	size()
boolean	tryRecover() This method can be used to recover from a possible event loss situation.
Collection	values()
Collection	values(Predicate predicate)

Methods inherited from class java.lang.Object

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

Field Detail

NULL_QUERY_CACHE

public static final InternalQueryCache NULL_QUERY_CACHE

Null query cache implementation.

Method Detail

set

public void set(Object key,
                Object value,
                EntryEventType eventType)

Specified by:

set in interface InternalQueryCache

prepopulate

public void prepopulate(Object key,
                        Object value)

Description copied from interface: InternalQueryCache

Used during initial population of query cache. Initially fetched data from cluster will be written to query cache by the help of this method.

Specified by:

prepopulate in interface InternalQueryCache

delete

public void delete(Object key,
                   EntryEventType eventType)

Specified by:

delete in interface InternalQueryCache

removeEntriesOf

public int removeEntriesOf(int partitionId)

Description copied from interface: InternalQueryCache

Scans all entries in this QueryCache to remove matching ones with supplied partitionId

Specified by:

removeEntriesOf in interface InternalQueryCache

Returns:

number of entries removed

getDelegate

public IMap getDelegate()

Specified by:

getDelegate in interface InternalQueryCache

getIndexes

public Indexes getIndexes()

Specified by:

getIndexes in interface InternalQueryCache

clear

public void clear()

Specified by:

clear in interface InternalQueryCache

setPublisherListenerId

public void setPublisherListenerId(String publisherListenerId)

Specified by:

setPublisherListenerId in interface InternalQueryCache

getPublisherListenerId

public String getPublisherListenerId()

Specified by:

getPublisherListenerId in interface InternalQueryCache

getCacheId

public String getCacheId()

Specified by:

getCacheId in interface InternalQueryCache

Returns:

internally used ID for this query cache

reachedMaxCapacity

public boolean reachedMaxCapacity()

Description copied from interface: InternalQueryCache

Used to quit pre-population when max size is reached.

Specified by:

reachedMaxCapacity in interface InternalQueryCache

Returns:

true if this query cache is at its max capacity, otherwise return false

See Also:

QueryCacheConfig.isPopulate()

getExtractors

public Extractors getExtractors()

Specified by:

getExtractors in interface InternalQueryCache

Returns:

extractors of this query cache instance.

recreate

public void recreate()

Description copied from interface: InternalQueryCache

Recreates this query cache. Recreation steps are:

• Reset local subscribers' state, clear all cache entries so far.
• Recreate/reset publisher (server) side resources by using this subscribers'metadata e.g. on server restart we can recreate server side resources.

Specified by:

recreate in interface InternalQueryCache

get

public Object get(Object key)

Specified by:

get in interface QueryCache

See Also:

IMap.get(Object)

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface QueryCache

See Also:

IMap.containsKey(Object)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface QueryCache

See Also:

IMap.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface QueryCache

See Also:

Map.isEmpty()

size

public int size()

Specified by:

size in interface QueryCache

See Also:

Map.size()

addIndex

public void addIndex(String attribute,
                     boolean ordered)

Specified by:

addIndex in interface QueryCache

See Also:

IMap.addIndex(String, boolean)

getAll

public Map getAll(Set keys)

Specified by:

getAll in interface QueryCache

See Also:

IMap.getAll(Set)

keySet

public Set keySet()

Specified by:

keySet in interface QueryCache

See Also:

IMap.keySet()

keySet

public Set keySet(Predicate predicate)

Specified by:

keySet in interface QueryCache

See Also:

IMap.keySet(Predicate)

entrySet

public Set<Map.Entry> entrySet()

Specified by:

entrySet in interface QueryCache

See Also:

IMap.entrySet()

entrySet

public Set<Map.Entry> entrySet(Predicate predicate)

Specified by:

entrySet in interface QueryCache

See Also:

IMap.entrySet(Predicate)

values

public Collection values()

Specified by:

values in interface QueryCache

See Also:

IMap.values()

values

public Collection values(Predicate predicate)

Specified by:

values in interface QueryCache

See Also:

IMap.values(Predicate)

addEntryListener

public String addEntryListener(MapListener listener,
                               boolean includeValue)

Specified by:

addEntryListener in interface QueryCache

See Also:

IMap.addEntryListener(MapListener, boolean)

addEntryListener

public String addEntryListener(MapListener listener,
                               Object key,
                               boolean includeValue)

Specified by:

addEntryListener in interface QueryCache

See Also:

IMap.addEntryListener(MapListener, Object, boolean)

addEntryListener

public String addEntryListener(MapListener listener,
                               Predicate predicate,
                               boolean includeValue)

Specified by:

addEntryListener in interface QueryCache

See Also:

IMap.addEntryListener(MapListener, Predicate, boolean)

addEntryListener

public String addEntryListener(MapListener listener,
                               Predicate predicate,
                               Object key,
                               boolean includeValue)

Specified by:

addEntryListener in interface QueryCache

See Also:

IMap.addEntryListener(MapListener, Predicate, Object, boolean)

removeEntryListener

public boolean removeEntryListener(String id)

Specified by:

removeEntryListener in interface QueryCache

See Also:

IMap.removeEntryListener(String)

getName

public String getName()

Description copied from interface: QueryCache

Returns the name of this QueryCache. The returned value will never be null.

Specified by:

getName in interface QueryCache

Returns:

the name of this QueryCache.

tryRecover

public boolean tryRecover()

Description copied from interface: QueryCache

This method can be used to recover from a possible event loss situation. You can detect event loss via EventLostListener

This method tries to make consistent the data in this QueryCache with the data in the underlying IMap by replaying the events after last consistently received ones. As a result of this replaying logic, same event may appear more than once to the QueryCache listeners.

This method returns false if the event is not in the buffer of event publisher side. That means recovery is not possible.

Specified by:

tryRecover in interface QueryCache

Returns:

true if the QueryCache content will be eventually consistent, otherwise false.

See Also:

QueryCacheConfig.bufferSize

destroy

public void destroy()

Description copied from interface: QueryCache

Destroys this cache. Clears and releases all local and remote resources created for this cache.

Specified by:

destroy in interface QueryCache