DATAREDIS-425 - Update reference documentation, spelling fixes, minor improvements.

Author: mp911de

src/main/asciidoc/reference/redis-repositories.adoc

@@ -14,7 +14,7 @@ To access domain entities stored in a Redis you can leverage repository support
 ====
 [source,java]
 ----
-@RedisHash("persons");
+@RedisHash("persons")
 public class Person {
 
   @Id String id;
@@ -156,7 +156,7 @@ of Complex Type
 addresses.[work].city  = "...
 |===
 
-Mapping behavior can be customized by registering the according `Converter` in `CustomConversions`. Those converters can take care of converting from/to a single `byte[]` as well as `Map<String,byte[]>` whereas the first one is suitable for eg. converting one complex type to eg. a binary JSON representation that still uses the default mappings hash structure, whereas the second options offers full control over the resulting hash.
+Mapping behavior can be customized by registering the according `Converter` in `CustomConversions`. Those converters can take care of converting from/to a single `byte[]` as well as `Map<String,byte[]>` whereas the first one is suitable for eg. converting one complex type to eg. a binary JSON representation that still uses the default mappings hash structure. The second option offers full control over the resulting hash. Writing objects to a Redis hash will delete the content from the hash and re-create the whole hash, so not mapped data will be lost.
 
 .Sample byte[] Converters
 ====
@@ -306,15 +306,15 @@ public class ApplicationConfig {
 
 [[redis.repositories.indexes]]
 == Secondary Indexes
-http://redis.io/topics/indexes[Secondary indexes] are used to enable lookup operations based on native redis structures. Values are written to the according indexes on every save and are removed when objects are deleted or <<redis.repositories.expirations,expire>>.
+http://redis.io/topics/indexes[Secondary indexes] are used to enable lookup operations based on native Redis structures. Values are written to the according indexes on every save and are removed when objects are deleted or <<redis.repositories.expirations,expire>>.
 
 Given the sample `Person` entity we can create an index for _firstname_ by annotating the property with `@Indexed`. 
 
 .Annotation driven indexing
 ====
 [source,java]
 ----
-@RedisHash("persons");
+@RedisHash("persons")
 public class Person {
 
   @Id String id;
@@ -349,7 +349,7 @@ Further more the programmatic setup allows to define indexes on map keys and lis
 ====
 [source,java]
 ----
-@RedisHash("persons");
+@RedisHash("persons")
 public class Person {
 
   // ... other properties omitted
@@ -455,16 +455,19 @@ public class TimeToLiveOnMethod {
 The repository implementation ensures subscription to http://redis.io/topics/notifications[Redis keyspace notifications] via `RedisMessageListenerContainer`.
 
 When the expiration is set to a positive value the according `EXPIRE` command is executed. 
-Additionally to persisting the original, a _phantom_ copy is persisted in Redis and set to expire 5 minutes after the original one. This done to enable the Repository support to publish `RedisKeyExpiredEvent` holding the expired value via Springs `ApplicationEventPublisher` whenever a key expires even though the original values have already been gone.
+Additionally to persisting the original, a _phantom_ copy is persisted in Redis and set to expire 5 minutes after the original one. This is done to enable the Repository support to publish `RedisKeyExpiredEvent` holding the expired value via Springs `ApplicationEventPublisher` whenever a key expires even though the original values have already been gone. Expiry events
+will be received on all connected applications using Spring Data Redis repositories.
 
 The `RedisKeyExpiredEvent` will hold a copy of the actually expired domain object as well as the key. 
 
-NOTE: The keyspace notification message listener will alter `notify-keyspace-events` settings in Redis if those are not already set. Existing settings will not be overridden so it is left to the user to set those up correctly when not leaving them empty.
+NOTE: The keyspace notification message listener will alter `notify-keyspace-events` settings in Redis if those are not already set. Existing settings will not be overridden, so it is left to the user to set those up correctly when not leaving them empty.
+
+NOTE: Redis Pub/Sub messages are not persistent. If a key expires while the application is down the expiry event will not be processed which may lead to secondary indexes containing still references to the expired object.
 
 [[redis.repositories.references]]
 == Persisting References
-Marking properties with `@Reference` allows to store a simple key reference instead of copying the all values into the hash itself.
-On loading from Redis references are resolved automatically and mapped back into the object.
+Marking properties with `@Reference` allows storing a simple key reference instead of copying values into the hash itself.
+On loading from Redis, references are resolved automatically and mapped back into the object.
 
 .Sample Property Reference
 ====
@@ -497,9 +500,12 @@ public interface PersonRepository extends CrudRepository<Person, String> {
 ----
 ====
 
+
 NOTE: Please make sure properties used in finder methods are set up for indexing.
 
-Using derived finder methods might not always be sufficient to model the queries to execute. `RedisCallback` offers more control over the actual matching of index structures or even customly added ones. All it takes is providing a `RedisCallback` that returns a single or `Iterable` set of _id_ values. 
+NOTE: Query methods for Redis repositories support only queries for entities and collections of entities with paging.
+
+Using derived query methods might not always be sufficient to model the queries to execute. `RedisCallback` offers more control over the actual matching of index structures or even custom added ones. All it takes is providing a `RedisCallback` that returns a single or `Iterable` set of _id_ values.
 
 .Sample finder using RedisCallback
 ====
@@ -516,6 +522,20 @@ List<RedisSession> sessionsByUser = template.find(new RedisCallback<Set<byte[]>>
 ----
 ====
 
+Here's an overview of the keywords supported for Redis and what a method containing that keyword essentially translates to.
+====
+
+.Supported keywords inside method names
+[options = "header, autowidth"]
+|===============
+|Keyword|Sample|Redis snippet
+|`And`|`findByLastnameAndFirstname`|`SINTER …:firstname:rand …:lastname:al’thor`
+|`Or`|`findByLastnameOrFirstname`|`SUNION …:firstname:rand …:lastname:al’thor`
+|`Is,Equals`|`findByFirstname`,`findByFirstnameIs`,`findByFirstnameEquals`|`SINTER …:firstname:rand`
+|===============
+====
+
+
 
 
 

src/main/java/org/springframework/data/redis/core/RedisKeyExpiredEvent.java

@@ -29,6 +29,11 @@
  */
 public class RedisKeyExpiredEvent<T> extends RedisKeyspaceEvent {
 
+	/**
+	 * Use {@literal UTF-8} as default charset.
+	 */
+	public static final Charset CHARSET = Charset.forName("UTF-8");
+
 	private final byte[][] args;
 	private final Object value;
 
@@ -62,7 +67,7 @@ public RedisKeyExpiredEvent(byte[] key, Object value) {
 	public String getKeyspace() {
 
 		if (args.length >= 2) {
-			return new String(args[0], Charset.forName("UTF-8"));
+			return new String(args[0], CHARSET);
 		}
 
 		return null;

src/main/java/org/springframework/data/redis/core/RedisQueryEngine.java

@@ -66,6 +66,7 @@ public RedisQueryEngine(CriteriaAccessor<RedisOperationChain> criteriaAccessor,
 	 * (non-Javadoc)
 	 * @see org.springframework.data.keyvalue.core.QueryEngine#execute(java.lang.Object, java.lang.Object, int, int, java.io.Serializable, java.lang.Class)
 	 */
+	@Override
 	public <T> Collection<T> execute(final RedisOperationChain criteria, final Comparator<?> sort, final int offset,
 			final int rows, final Serializable keyspace, Class<T> type) {
 

src/main/java/org/springframework/data/redis/core/convert/Bucket.java

@@ -98,6 +98,13 @@ public boolean isEmpty() {
 		return data.isEmpty();
 	}
 
+	/**
+	 * @return the number of key-value mappings of the {@link Bucket}.
+	 */
+	public int size() {
+		return data.size();
+	}
+
 	/**
 	 * @return never {@literal null}.
 	 */
@@ -121,6 +128,12 @@ public Map<String, byte[]> asMap() {
 		return Collections.unmodifiableMap(this.data);
 	}
 
+	/**
+	 * Extracts a bucket containing key/value pairs with the {@code prefix}.
+	 * 
+	 * @param prefix
+	 * @return
+	 */
 	public Bucket extract(String prefix) {
 
 		Bucket partial = new Bucket();

src/main/java/org/springframework/data/redis/core/convert/MappingRedisConverter.java

@@ -144,6 +144,7 @@ public MappingRedisConverter(RedisMappingContext mappingContext, IndexResolver i
 	 * (non-Javadoc)
 	 * @see org.springframework.data.convert.EntityReader#read(java.lang.Class, java.lang.Object)
 	 */
+	@Override
 	public <R> R read(Class<R> type, final RedisData source) {
 		return readInternal("", type, source);
 	}
@@ -288,11 +289,11 @@ public void doWithAssociation(Association<KeyValuePersistentProperty> associatio
 
 				if (association.getInverse().isCollectionLike()) {
 
-					Collection<Object> target = CollectionFactory.createCollection(association.getInverse().getType(),
-							association.getInverse().getComponentType(), 10);
-
 					Bucket bucket = source.getBucket().extract(currentPath + ".[");
 
+					Collection<Object> target = CollectionFactory.createCollection(association.getInverse().getType(),
+							association.getInverse().getComponentType(), bucket.size());
+
 					for (Entry<String, byte[]> entry : bucket.entrySet()) {
 
 						String referenceKey = fromBytes(entry.getValue(), String.class);
@@ -333,6 +334,7 @@ public void doWithAssociation(Association<KeyValuePersistentProperty> associatio
 	 * (non-Javadoc)
 	 * @see org.springframework.data.convert.EntityWriter#write(java.lang.Object, java.lang.Object)
 	 */
+	@Override
 	@SuppressWarnings({ "rawtypes" })
 	public void write(Object source, final RedisData sink) {
 
@@ -408,8 +410,8 @@ public void doWithPersistentProperty(KeyValuePersistentProperty persistentProper
 					writeCollection(keyspace, propertyStringPath, (Collection<?>) accessor.getProperty(persistentProperty),
 							persistentProperty.getTypeInformation().getComponentType(), sink);
 				} else if (persistentProperty.isEntity()) {
-					writeInternal(keyspace, propertyStringPath, accessor.getProperty(persistentProperty), persistentProperty
-							.getTypeInformation().getActualType(), sink);
+					writeInternal(keyspace, propertyStringPath, accessor.getProperty(persistentProperty),
+							persistentProperty.getTypeInformation().getActualType(), sink);
 				} else {
 
 					Object propertyValue = accessor.getProperty(persistentProperty);
@@ -442,8 +444,8 @@ public void doWithAssociation(Association<KeyValuePersistentProperty> associatio
 
 				if (association.getInverse().isCollectionLike()) {
 
-					KeyValuePersistentEntity<?> ref = mappingContext.getPersistentEntity(association.getInverse()
-							.getTypeInformation().getComponentType().getActualType());
+					KeyValuePersistentEntity<?> ref = mappingContext
+							.getPersistentEntity(association.getInverse().getTypeInformation().getComponentType().getActualType());
 
 					String keyspace = ref.getKeySpace();
 					String propertyStringPath = (!path.isEmpty() ? path + "." : "") + association.getInverse().getName();
@@ -458,8 +460,8 @@ public void doWithAssociation(Association<KeyValuePersistentProperty> associatio
 
 				} else {
 
-					KeyValuePersistentEntity<?> ref = mappingContext.getPersistentEntity(association.getInverse()
-							.getTypeInformation());
+					KeyValuePersistentEntity<?> ref = mappingContext
+							.getPersistentEntity(association.getInverse().getTypeInformation());
 					String keyspace = ref.getKeySpace();
 
 					Object refId = ref.getPropertyAccessor(refObject).getProperty(ref.getIdProperty());
@@ -535,10 +537,10 @@ private void writeToBucket(String path, Object value, RedisData sink) {
 	private Collection<?> readCollectionOfSimpleTypes(String path, Class<?> collectionType, Class<?> valueType,
 			RedisData source) {
 
-		Collection<Object> target = CollectionFactory.createCollection(collectionType, valueType, 10);
-
 		Bucket partial = source.getBucket().extract(path + ".[");
 
+		Collection<Object> target = CollectionFactory.createCollection(collectionType, valueType, partial.size());
+
 		for (byte[] value : partial.values()) {
 			target.add(fromBytes(value, valueType));
 		}
@@ -555,10 +557,10 @@ private Collection<?> readCollectionOfSimpleTypes(String path, Class<?> collecti
 	private Collection<?> readCollectionOfComplexTypes(String path, Class<?> collectionType, Class<?> valueType,
 			Bucket source) {
 
-		Collection<Object> target = CollectionFactory.createCollection(collectionType, valueType, 10);
-
 		Set<String> keys = source.extractAllKeysFor(path);
 
+		Collection<Object> target = CollectionFactory.createCollection(collectionType, valueType, keys.size());
+
 		for (String key : keys) {
 
 			Bucket elementData = source.extract(key);
@@ -583,6 +585,7 @@ private Collection<?> readCollectionOfComplexTypes(String path, Class<?> collect
 	 * @param sink
 	 */
 	private void writeMap(String keyspace, String path, Class<?> mapValueType, Map<?, ?> source, RedisData sink) {
+
 		if (CollectionUtils.isEmpty(source)) {
 			return;
 		}
@@ -614,10 +617,10 @@ private void writeMap(String keyspace, String path, Class<?> mapValueType, Map<?
 	private Map<?, ?> readMapOfSimpleTypes(String path, Class<?> mapType, Class<?> keyType, Class<?> valueType,
 			RedisData source) {
 
-		Map<Object, Object> target = CollectionFactory.createMap(mapType, 10);
-
 		Bucket partial = source.getBucket().extract(path + ".[");
 
+		Map<Object, Object> target = CollectionFactory.createMap(mapType, partial.size());
+
 		for (Entry<String, byte[]> entry : partial.entrySet()) {
 
 			String regex = "^(" + Pattern.quote(path) + "\\.\\[)(.*?)(\\])";
@@ -645,10 +648,10 @@ private void writeMap(String keyspace, String path, Class<?> mapValueType, Map<?
 	private Map<?, ?> readMapOfComplexTypes(String path, Class<?> mapType, Class<?> keyType, Class<?> valueType,
 			RedisData source) {
 
-		Map<Object, Object> target = CollectionFactory.createMap(mapType, 10);
-
 		Set<String> keys = source.getBucket().extractAllKeysFor(path);
 
+		Map<Object, Object> target = CollectionFactory.createMap(mapType, keys.size());
+
 		for (String key : keys) {
 
 			String regex = "^(" + Pattern.quote(path) + "\\.\\[)(.*?)(\\])";
@@ -723,6 +726,7 @@ public void setIndexResolver(IndexResolver indexResolver) {
 	 * (non-Javadoc)
 	 * @see org.springframework.data.convert.EntityConverter#getMappingContext()
 	 */
+	@Override
 	public RedisMappingContext getMappingContext() {
 		return this.mappingContext;
 	}
@@ -731,6 +735,7 @@ public RedisMappingContext getMappingContext() {
 	 * (non-Javadoc)
 	 * @see org.springframework.data.convert.EntityConverter#getConversionService()
 	 */
+	@Override
 	public ConversionService getConversionService() {
 		return this.conversionService;
 	}

src/main/java/org/springframework/data/redis/core/convert/RedisConverter.java

@@ -20,7 +20,7 @@
 import org.springframework.data.keyvalue.core.mapping.KeyValuePersistentProperty;
 
 /**
- * Redis sepcific {@link EntityConverter}.
+ * Redis specific {@link EntityConverter}.
  * 
  * @author Christoph Strobl
  * @since 1.7

src/main/java/org/springframework/data/redis/core/index/IndexDefinition.java

@@ -22,7 +22,7 @@
 /**
  * {@link IndexDefinition} allow to set up a blueprint for creating secondary index structures in Redis. Setting up
  * conditions allows to define {@link Condition} that have to be passed in order to add a value to the index. This
- * allows to fine grained tune the I index structure. {@link IndexValueTransformer} gets applied to the raw value for
+ * allows to fine grained tune the index structure. {@link IndexValueTransformer} gets applied to the raw value for
  * creating the actual index entry.
  * 
  * @author Christoph Strobl

src/main/java/org/springframework/data/redis/repository/configuration/EnableRedisRepositories.java

@@ -53,7 +53,7 @@
 
 	/**
 	 * Alias for the {@link #basePackages()} attribute. Allows for more concise annotation declarations e.g.:
-	 * {@code @EnableJpaRepositories("org.my.pkg")} instead of {@code @EnableJpaRepositories(basePackages="org.my.pkg")}.
+	 * {@code @EnableRedisRepositories("org.my.pkg")} instead of {@code @EnableRedisRepositories(basePackages="org.my.pkg")}.
 	 */
 	String[] value() default {};
 

src/test/java/org/springframework/data/redis/repository/RedisRepositoryIntegrationTests.java

@@ -93,7 +93,7 @@ public void setUp() {
 	 * @see DATAREDIS-425
 	 */
 	@Test
-	public void simpleFindSouldReturnEntitiesCorrectly() {
+	public void simpleFindShouldReturnEntitiesCorrectly() {
 
 		Person rand = new Person();
 		rand.firstname = "rand";