Package com.alachisoft.ncache.runtime.datasourceprovider

Class ProviderItemBase

java.lang.Object

com.alachisoft.ncache.runtime.datasourceprovider.ProviderItemBase

Direct Known Subclasses:

ProviderCacheItem, ProviderDataStructureItem

public class ProviderItemBase
extends java.lang.Object

ProviderCacheItem is just like a CacheItem , but it has some limited fields

Constructor Summary

Constructors

Constructor	Description
ProviderItemBase()

Method Summary

Modifier and Type	Method	Description
CacheDependency	getDependency()	Gets the Cache Dependency instance that contains all dependencies associated with provider cache item.
Expiration	getExpiration()	Gets the expiration mechanism for provider cache item.
java.lang.String	getGroup()	Gets the group associated with the provider cache item.
boolean	getIsJavaReadThrough()	Gets a boolean value that indicates that whether ReadThruProvider is Java based or not.
CacheItemPriority	getItemPriority()	Gets the relative priority for provider cache item which is kept under consideration whenever cache starts to free up space and evicts items.
NamedTagsDictionary	getNamedTags()	Gets the NamedTags information associated with the provider cache item, it can be queried on the basis of NamedTags provided.
boolean	getResyncItemOnExpiration()	Gets the flag which indicates whether item should be reloaded on expiration if ReadThru provider is specified.
ResyncOptions	getResyncOptions()	Gets the ResyncOptions specific to the provider cache item.
java.lang.String	getResyncProviderName()	Gets the ReadThru provider name for re-synchronization of cache.
java.util.List<Tag>	getTags()	Gets the tags information associated with the provider cache item, it can be queried on the basis of Tags provided.
void	setDependency(CacheDependency value)	Sets the Cache Dependency instance that contains all dependencies associated with provider cache item.
void	setExpiration(Expiration value)	Sets the expiration mechanism for provider cache item.
void	setGroup(java.lang.String value)	Sets the group associated with the provider cache item.
void	setIsJavaReadThrough(boolean value)	Sets a boolean value that indicates that whether ReadThruProvider is Java based or not.
void	setItemPriority(CacheItemPriority value)	Sets the relative priority for provider cache item which is kept under consideration whenever cache starts to free up space and evicts items.
void	setNamedTags(NamedTagsDictionary value)	Sets the NamedTags information associated with the provider item, it can be queried on the basis of NamedTags provided.
void	setResyncOptions(ResyncOptions value)	Sets the ResyncOptions specific to the provider cache item.
void	setTags(java.util.List<Tag> value)	Sets the tags information associated with the provider cache item, it can be queried on the basis of Tags provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderItemBase

public ProviderItemBase()

Method Detail

getGroup

public final java.lang.String getGroup()

Gets the group associated with the provider cache item. It can be queryed on the basis of Groups.

Returns:

The group associated with provider cache item.

setGroup

public final void setGroup(java.lang.String value)

Sets the group associated with the provider cache item. It can be queryed on the basis of Groups.

Parameters:

value - The group to be associated with provider cache item.

getTags

public final java.util.List<Tag> getTags()

Gets the tags information associated with the provider cache item, it can be queried on the basis of Tags provided.

Returns:

List of Tags associated with provider cache item.

setTags

public final void setTags(java.util.List<Tag> value)

Sets the tags information associated with the provider cache item, it can be queried on the basis of Tags provided.

Parameters:

value - List of Tags to be associated with provider cache item.

getNamedTags

public final NamedTagsDictionary getNamedTags()

Gets the NamedTags information associated with the provider cache item, it can be queried on the basis of NamedTags provided.

Returns:

NamedTags associated with provider cache item.

setNamedTags

public final void setNamedTags(NamedTagsDictionary value)

Sets the NamedTags information associated with the provider item, it can be queried on the basis of NamedTags provided.

Parameters:

value - NamedTags to be associated with provider cache item.

getResyncItemOnExpiration

public final boolean getResyncItemOnExpiration()

Gets the flag which indicates whether item should be reloaded on expiration if ReadThru provider is specified.

Returns:

True if item is to be resynced on expiration otherwise false.

getDependency

public final CacheDependency getDependency()

Gets the Cache Dependency instance that contains all dependencies associated with provider cache item.

Returns:

The Cache Dependency instance associated with provider cache item.

setDependency

public final void setDependency(CacheDependency value)

Sets the Cache Dependency instance that contains all dependencies associated with provider cache item.

Parameters:

value - The Cache Dependency instance to be associated with provider cache item.

getItemPriority

public final CacheItemPriority getItemPriority()

Gets the relative priority for provider cache item which is kept under consideration whenever cache starts to free up space and evicts items.

Returns:

CacheItemPriority associated with provider cache item.

setItemPriority

public final void setItemPriority(CacheItemPriority value)

Sets the relative priority for provider cache item which is kept under consideration whenever cache starts to free up space and evicts items.

Parameters:

value - CacheItemPriority to be associated with provider cache item.

getResyncProviderName

public final java.lang.String getResyncProviderName()

Gets the ReadThru provider name for re-synchronization of cache.

Returns:

The resync provider name.

getIsJavaReadThrough

public final boolean getIsJavaReadThrough()

Gets a boolean value that indicates that whether ReadThruProvider is Java based or not.

Returns:

True if ReadThruProvider is java based otherwise false.

setIsJavaReadThrough

public final void setIsJavaReadThrough(boolean value)

Sets a boolean value that indicates that whether ReadThruProvider is Java based or not.

Parameters:

value - A boolean value to specify that provider is Java based or not.

getExpiration

public final Expiration getExpiration()

Gets the expiration mechanism for provider cache item.

Returns:

Expiration instance that contains info about provider cache item expiration mechanism.

setExpiration

public final void setExpiration(Expiration value)

Sets the expiration mechanism for provider cache item.

Parameters:

value - Expiration object that specifies the expiration mechanism for provider cache item.

getResyncOptions

public final ResyncOptions getResyncOptions()

Gets the ResyncOptions specific to the provider cache item.

Returns:

ResyncOptions specific to the provider cache item.

setResyncOptions

public final void setResyncOptions(ResyncOptions value)

Sets the ResyncOptions specific to the provider cache item.

Parameters:

value - ResyncOptions specific to the provider cache item.