org.springframework.xd.store

Class AbstractRedisRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

java.lang.Object

org.springframework.xd.store.AbstractRedisRepository<T,ID>

Type Parameters:

T - the type of things to store

ID - a "primary key" to the things

All Implemented Interfaces:

org.springframework.data.repository.CrudRepository<T,ID>, org.springframework.data.repository.PagingAndSortingRepository<T,ID>, org.springframework.data.repository.Repository<T,ID>, RangeCapableRepository<T,ID>

Direct Known Subclasses:

RedisCounterRepository

public abstract class AbstractRedisRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>
extends java.lang.Object
implements org.springframework.data.repository.PagingAndSortingRepository<T,ID>, RangeCapableRepository<T,ID>

Base implementation for a store, using Redis behind the scenes. This implementation requires a repoPrefix, that is used in two ways:

• a sorted set is stored under that exact key that tracks the entity ids this repository is responsible for,
• each entity is stored serialized under key repoPrefix.<id>

Author:

Eric Bottard

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.data.redis.core.RedisOperations<java.lang.String,java.lang.String>	redisOperations
protected java.lang.String	repoPrefix
protected org.springframework.data.redis.core.BoundZSetOperations<java.lang.String,java.lang.String>	zSetOperations

Constructor Summary

Constructors

Constructor and Description
AbstractRedisRepository(java.lang.String repoPrefix, org.springframework.data.redis.core.RedisOperations<java.lang.String,java.lang.String> redisOperations)

Method Summary

Methods

Modifier and Type	Method and Description
long	count()
void	delete(ID id)
void	delete(java.lang.Iterable<? extends T> entities)
void	delete(T entity)
void	deleteAll()
protected abstract T	deserialize(ID id, java.lang.String v) Deserialize from the String representation to the domain object.
protected abstract ID	deserializeId(java.lang.String string) Deserialize an entity id from its String representation.
boolean	exists(ID id)
java.lang.Iterable<T>	findAll()
java.lang.Iterable<T>	findAll(java.lang.Iterable<ID> ids)
org.springframework.data.domain.Page<T>	findAll(org.springframework.data.domain.Pageable pageable)
java.lang.Iterable<T>	findAll(org.springframework.data.domain.Sort sort)
java.lang.Iterable<T>	findAllInRange(ID from, boolean fromInclusive, ID to, boolean toInclusive) Return entities whose ids range between from and to.
T	findOne(ID id)
protected java.lang.String	getPrefix()
protected ID	idFromRedisKey(java.lang.String redisKey)
protected abstract ID	keyFor(T entity) Return the entity id for the given domain object.
protected java.lang.String	redisKeyFromId(ID id)
<S extends T> java.lang.Iterable<S>	save(java.lang.Iterable<S> entities)
<S extends T> S	save(S entity)
protected abstract java.lang.String	serialize(T entity) Provide a String representation of the domain entity.
protected abstract java.lang.String	serializeId(ID id) Return a String representation of the domain ID.
void	setPrefix(java.lang.String string) Change the prefix after creation.
protected void	trackMembership(java.lang.String redisKey) Perform bookkeeping of entities managed by this repository.

Methods inherited from class java.lang.Object

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

Field Detail

repoPrefix

protected java.lang.String repoPrefix

zSetOperations

protected org.springframework.data.redis.core.BoundZSetOperations<java.lang.String,java.lang.String> zSetOperations

redisOperations

protected org.springframework.data.redis.core.RedisOperations<java.lang.String,java.lang.String> redisOperations

Constructor Detail

AbstractRedisRepository

public AbstractRedisRepository(java.lang.String repoPrefix,
                       org.springframework.data.redis.core.RedisOperations<java.lang.String,java.lang.String> redisOperations)

Method Detail

count

public long count()

Specified by:

count in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

delete

public void delete(ID id)

Specified by:

delete in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

delete

public void delete(java.lang.Iterable<? extends T> entities)

Specified by:

delete in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

delete

public void delete(T entity)

Specified by:

delete in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

deleteAll

public void deleteAll()

Specified by:

deleteAll in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

exists

public boolean exists(ID id)

Specified by:

exists in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

findAll

public java.lang.Iterable<T> findAll()

Specified by:

findAll in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

findAll

public java.lang.Iterable<T> findAll(java.lang.Iterable<ID> ids)

Specified by:

findAll in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

findAll

public org.springframework.data.domain.Page<T> findAll(org.springframework.data.domain.Pageable pageable)

Specified by:

findAll in interface org.springframework.data.repository.PagingAndSortingRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

findAll

public java.lang.Iterable<T> findAll(org.springframework.data.domain.Sort sort)

Specified by:

findAll in interface org.springframework.data.repository.PagingAndSortingRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

findOne

public T findOne(ID id)

Specified by:

findOne in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

save

public <S extends T> S save(S entity)

Specified by:

save in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

findAllInRange

public java.lang.Iterable<T> findAllInRange(ID from,
                                   boolean fromInclusive,
                                   ID to,
                                   boolean toInclusive)

Description copied from interface: RangeCapableRepository

Return entities whose ids range between from and to. Note that it is possible that entities with those exact ids do not exist. If they do exist, the two boolean parameters control whether to include those results or not. A query from x to x returns an empty result, unless both fromInclusive and toInclusive are true.

Specified by:

findAllInRange in interface RangeCapableRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

trackMembership

protected void trackMembership(java.lang.String redisKey)

Perform bookkeeping of entities managed by this repository. Uses a redis sorted set with a dummy value, which happens to guarantee that keys for a given score are in sorted order.

save

public <S extends T> java.lang.Iterable<S> save(java.lang.Iterable<S> entities)

Specified by:

save in interface org.springframework.data.repository.CrudRepository<T,ID extends java.io.Serializable & java.lang.Comparable<ID>>

deserialize

protected abstract T deserialize(ID id,
            java.lang.String v)

Deserialize from the String representation to the domain object.

Parameters:

id - the entity id

v - the serialized representation of the domain object

serialize

protected abstract java.lang.String serialize(T entity)

Provide a String representation of the domain entity.

keyFor

protected abstract ID keyFor(T entity)

Return the entity id for the given domain object.

serializeId

protected abstract java.lang.String serializeId(ID id)

Return a String representation of the domain ID. Note that order should be preserved between ID domain and String representation.

deserializeId

protected abstract ID deserializeId(java.lang.String string)

Deserialize an entity id from its String representation.

redisKeyFromId

protected java.lang.String redisKeyFromId(ID id)

idFromRedisKey

protected ID idFromRedisKey(java.lang.String redisKey)

setPrefix

public void setPrefix(java.lang.String string)

Change the prefix after creation. Mainly intented for testing.

getPrefix

protected java.lang.String getPrefix()