com.communote.server.core.property

Class UserNotePropertyCacheKey

java.lang.Object

com.communote.server.core.property.UserNotePropertyCacheKey

All Implemented Interfaces:

CacheKey

public class UserNotePropertyCacheKey
extends Object
implements CacheKey

Key to cache the UserNoteProperty instances added to a note. The properties are cached per property group and key combination.

Author:

Communote GmbH - http://www.communote.com/

See Also:

UserNotePropertyCacheElementProvider

Constructor Summary

Constructors

Constructor and Description
UserNotePropertyCacheKey(Long noteId, String propertyKeyGroup, String propertyKey) Create a new cache key

Method Summary

Modifier and Type	Method and Description
String	getCacheKeyString() String representation of the cache key which will be used for caching.
Long	getNoteId()
String	getPropertyKey()
String	getPropertyKeyGroup()
boolean	isUniquePerClient() Returns true if the cache key should be treated as client specific.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserNotePropertyCacheKey

public UserNotePropertyCacheKey(Long noteId,
                                String propertyKeyGroup,
                                String propertyKey)

Create a new cache key

Parameters:

noteId - the ID of the note for which the properties are cached

propertyKeyGroup - the key group of the property for which the property values and users are cached

propertyKey - the key of the property for which the property values and users are cached

Method Detail

getCacheKeyString

public String getCacheKeyString()

Description copied from interface: CacheKey

String representation of the cache key which will be used for caching.

Specified by:

getCacheKeyString in interface CacheKey

Returns:

the string representation

getNoteId

public Long getNoteId()

Returns:

the ID of the note for which the properties are cached

getPropertyKey

public String getPropertyKey()

Returns:

the key of the property for which the property values and users are cached

getPropertyKeyGroup

public String getPropertyKeyGroup()

Returns:

the key group of the property for which the property values and users are cached

isUniquePerClient

public boolean isUniquePerClient()

Description copied from interface: CacheKey

Returns true if the cache key should be treated as client specific. Using such a cache key will result in caching an element per client. A return value of false indicates that the data will be cached application wide.

Specified by:

isUniquePerClient in interface CacheKey

Returns:

whether the cache key should be treated as client specific