DATAMONGO-899 - Ensure proper creation of index structures for nested entities.

Index creation did not consider the properties path when creating the index. This lead to broken index creation when nesting entities that might require index structures.

Off now index creation traverses the entities property path for all top level entities (namely those holding the @document annotation) and creates the index using the full property path.

This is a breaking change as having an entity to carry the @document annotation has not been required by now.

Original Pull Request: spring-projects#168

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/CompoundIndexDefinition.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2014 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.mongodb.core.index;
+
+import com.mongodb.BasicDBObject;
+import com.mongodb.DBObject;
+
+/**
+ * @author Christoph Strobl
+ * @since 1.5
+ */
+public class CompoundIndexDefinition extends Index {
+
+	private DBObject keys;
+
+	public CompoundIndexDefinition(DBObject keys) {
+		this.keys = keys;
+	}
+
+	@Override
+	public DBObject getIndexKeys() {
+
+		BasicDBObject dbo = new BasicDBObject();
+		dbo.putAll(this.keys);
+		dbo.putAll(super.getIndexKeys());
+		return dbo;
+	}
+
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/GeospatialIndex.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2013 the original author or authors.
+ * Copyright 2010-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,6 +27,7 @@
  * @author Jon Brisbin
  * @author Oliver Gierke
  * @author Laurent Canet
+ * @author Christoph Strobl
  */
 public class GeospatialIndex implements IndexDefinition {
 
@@ -38,6 +39,7 @@ public class GeospatialIndex implements IndexDefinition {
 	private GeoSpatialIndexType type = GeoSpatialIndexType.GEO_2D;
 	private Double bucketSize = 1.0;
 	private String additionalField;
+	private String collection;
 
 	/**
 	 * Creates a new {@link GeospatialIndex} for the given field.
@@ -120,6 +122,23 @@ public GeospatialIndex withAdditionalField(String fieldName) {
 		return this;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.index.IndexDefinition#getCollection()
+	 */
+	@Override
+	public String getCollection() {
+		return collection;
+	}
+
+	/**
+	 * @param collection
+	 * @since 1.5
+	 */
+	public void setCollection(String collection) {
+		this.collection = collection;
+	}
+
 	public DBObject getIndexKeys() {
 
 		DBObject dbo = new BasicDBObject();

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/Index.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2013 the original author or authors.
+ * Copyright 2010-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,13 +17,19 @@
 
 import java.util.LinkedHashMap;
 import java.util.Map;
+import java.util.concurrent.TimeUnit;
 
 import org.springframework.data.domain.Sort.Direction;
 import org.springframework.data.mongodb.core.query.Order;
+import org.springframework.util.Assert;
 
 import com.mongodb.BasicDBObject;
 import com.mongodb.DBObject;
 
+/**
+ * @author Oliver Gierke
+ * @author Christoph Strobl
+ */
 @SuppressWarnings("deprecation")
 public class Index implements IndexDefinition {
 
@@ -41,6 +47,12 @@ public enum Duplicates {
 
 	private boolean sparse = false;
 
+	private boolean background = false;
+
+	private long expire = -1;
+
+	private String collection;
+
 	public Index() {}
 
 	public Index(String key, Direction direction) {
@@ -104,6 +116,61 @@ public Index sparse() {
 		return this;
 	}
 
+	/**
+	 * Build the index in background (non blocking).
+	 * 
+	 * @return
+	 * @since 1.5
+	 */
+	public Index background() {
+
+		this.background = true;
+		return this;
+	}
+
+	/**
+	 * Specifies TTL in seconds.
+	 * 
+	 * @param value
+	 * @return
+	 * @since 1.5
+	 */
+	public Index expire(long value) {
+		return expire(value, TimeUnit.SECONDS);
+	}
+
+	/**
+	 * Specifies TTL with given {@link TimeUnit}.
+	 * 
+	 * @param value
+	 * @param unit
+	 * @return
+	 * @since 1.5
+	 */
+	public Index expire(long value, TimeUnit unit) {
+
+		Assert.notNull(unit, "TimeUnit for expiration must not be null.");
+		this.expire = unit.toSeconds(value);
+		return this;
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.index.IndexDefinition#getCollection()
+	 */
+	@Override
+	public String getCollection() {
+		return collection;
+	}
+
+	/**
+	 * @param collection
+	 * @since 1.5
+	 */
+	public void setCollection(String collection) {
+		this.collection = collection;
+	}
+
 	/**
 	 * @see http://docs.mongodb.org/manual/core/index-creation/#index-creation-duplicate-dropping
 	 * @param duplicates
@@ -125,9 +192,11 @@ public DBObject getIndexKeys() {
 	}
 
 	public DBObject getIndexOptions() {
+
 		if (name == null && !unique) {
 			return null;
 		}
+
 		DBObject dbo = new BasicDBObject();
 		if (name != null) {
 			dbo.put("name", name);
@@ -141,6 +210,12 @@ public DBObject getIndexOptions() {
 		if (sparse) {
 			dbo.put("sparse", true);
 		}
+		if (background) {
+			dbo.put("background", true);
+		}
+		if (expire >= 0) {
+			dbo.put("expireAfterSeconds", expire);
+		}
 		return dbo;
 	}
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/IndexDefinition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011 by the original author(s).
+ * Copyright (c) 2011-2014 by the original author(s).
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,11 +20,19 @@
 
 /**
  * @author Jon Brisbin <jbrisbin@vmware.com>
+ * @author Christoph Strobl
  */
 public interface IndexDefinition {
 
 	DBObject getIndexKeys();
 
 	DBObject getIndexOptions();
 
+	/**
+	 * Get the collection name for the index.
+	 * 
+	 * @return
+	 * @since 1.5
+	 */
+	String getCollection();
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/IndexResolver.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2014 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.mongodb.core.index;
+
+/**
+ * {@link IndexResolver} finds those {@link IndexDefinition}s to be created for a given class.
+ * 
+ * @author Christoph Strobl
+ * @since 1.5
+ */
+public interface IndexResolver {
+
+	/**
+	 * Find and create {@link IndexDefinition}s for properties of given {@code type}. {@link IndexDefinition}s are created
+	 * for properties and types with {@link Indexed}, {@link CompoundIndexes} or {@link GeoSpatialIndexed}.
+	 * 
+	 * @param type
+	 * @return Empty {@link Iterable} in case no {@link IndexDefinition} could be resolved for type.
+	 */
+	Iterable<? extends IndexDefinition> resolveIndexForClass(Class<?> type);
+
+}