DATAMONGO-1054 - Polishing.

Tweaked JavaDoc of the APIs to be less specific about implementation internals and rather point to the save(…) methods. Changed SimpleMongoRepository.save(…) methods to inspect the given entity/entities and use the optimized insert(All)-calls if all entities are considered new.

Original pull request: spring-projects#253.

Author: odrotbohm

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/MongoRepository.java

@@ -51,28 +51,24 @@ public interface MongoRepository<T, ID extends Serializable> extends PagingAndSo
 	List<T> findAll(Sort sort);
 
 	/**
-	 * Saves a given entity. Use the returned instance for further operations as the save operation might have changed the
-	 * entity instance completely.
-	 * <p>
-	 * This uses {@link org.springframework.data.mongodb.core.MongoTemplate#insert(Object)} for storing the given entity.
-	 * <p>
-	 * Note that this method does neither fire any save events nor performs any id population or version checking.
+	 * Inserts the given a given entity. Assumes the instance to be new to be able to apply insertion optimizations. Use
+	 * the returned instance for further operations as the save operation might have changed the entity instance
+	 * completely. Prefer using {@link #save(Object)} instead to avoid the usage of store-specific API.
 	 * 
-	 * @param entity
+	 * @param entity must not be {@literal null}.
 	 * @return the saved entity
+	 * @since 1.7
 	 */
 	<S extends T> S insert(S entity);
 
 	/**
-	 * Saves all given entities.
-	 * <p>
-	 * This uses {@link org.springframework.data.mongodb.core.MongoTemplate#insert(Object)} for storing the given entity.
-	 * <p>
-	 * Note that this method does neither fire any save events nor nor performs any id population or version checking.
+	 * Inserts the given entities. Assumes the given entities to have not been persisted yet and thus will optimize the
+	 * insert over a call to {@link #save(Iterable)}. Prefer using {@link #save(Iterable)} to avoid the usage of store
+	 * specific API.
 	 * 
-	 * @param entities
+	 * @param entities must not be {@literal null}.
 	 * @return the saved entities
-	 * @throws IllegalArgumentException in case the given entity is (@literal null}.
+	 * @since 1.7
 	 */
 	<S extends T> List<S> insert(Iterable<S> entities);
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/support/QueryDslMongoRepository.java

@@ -29,6 +29,7 @@
 import org.springframework.data.querydsl.EntityPathResolver;
 import org.springframework.data.querydsl.QueryDslPredicateExecutor;
 import org.springframework.data.querydsl.SimpleEntityPathResolver;
+import org.springframework.data.repository.core.EntityInformation;
 import org.springframework.data.repository.core.EntityMetadata;
 import org.springframework.util.Assert;
 
@@ -48,13 +49,15 @@ public class QueryDslMongoRepository<T, ID extends Serializable> extends SimpleM
 		QueryDslPredicateExecutor<T> {
 
 	private final PathBuilder<T> builder;
+	private final EntityInformation<T, ID> entityInformation;
+	private final MongoOperations mongoOperations;
 
 	/**
 	 * Creates a new {@link QueryDslMongoRepository} for the given {@link EntityMetadata} and {@link MongoTemplate}. Uses
 	 * the {@link SimpleEntityPathResolver} to create an {@link EntityPath} for the given domain class.
 	 * 
-	 * @param entityInformation
-	 * @param template
+	 * @param entityInformation must not be {@literal null}.
+	 * @param mongoOperations must not be {@literal null}.
 	 */
 	public QueryDslMongoRepository(MongoEntityInformation<T, ID> entityInformation, MongoOperations mongoOperations) {
 		this(entityInformation, mongoOperations, SimpleEntityPathResolver.INSTANCE);
@@ -64,17 +67,21 @@ public QueryDslMongoRepository(MongoEntityInformation<T, ID> entityInformation,
 	 * Creates a new {@link QueryDslMongoRepository} for the given {@link MongoEntityInformation}, {@link MongoTemplate}
 	 * and {@link EntityPathResolver}.
 	 * 
-	 * @param entityInformation
-	 * @param mongoOperations
-	 * @param resolver
+	 * @param entityInformation must not be {@literal null}.
+	 * @param mongoOperations must not be {@literal null}.
+	 * @param resolver must not be {@literal null}.
 	 */
 	public QueryDslMongoRepository(MongoEntityInformation<T, ID> entityInformation, MongoOperations mongoOperations,
 			EntityPathResolver resolver) {
 
 		super(entityInformation, mongoOperations);
+
 		Assert.notNull(resolver);
 		EntityPath<T> path = resolver.createPath(entityInformation.getJavaType());
+
 		this.builder = new PathBuilder<T>(path.getType(), path.getMetadata());
+		this.entityInformation = entityInformation;
+		this.mongoOperations = mongoOperations;
 	}
 
 	/*
@@ -139,9 +146,9 @@ public long count(Predicate predicate) {
 	 */
 	private MongodbQuery<T> createQueryFor(Predicate... predicate) {
 
-		Class<T> domainType = getEntityInformation().getJavaType();
+		Class<T> domainType = entityInformation.getJavaType();
 
-		MongodbQuery<T> query = new SpringDataMongodbQuery<T>(getMongoOperations(), domainType);
+		MongodbQuery<T> query = new SpringDataMongodbQuery<T>(mongoOperations, domainType);
 		return query.where(predicate);
 	}
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/support/SimpleMongoRepository.java

@@ -72,7 +72,12 @@ public <S extends T> S save(S entity) {
 
 		Assert.notNull(entity, "Entity must not be null!");
 
-		mongoOperations.save(entity, entityInformation.getCollectionName());
+		if (entityInformation.isNew(entity)) {
+			mongoOperations.insert(entity, entityInformation.getCollectionName());
+		} else {
+			mongoOperations.save(entity, entityInformation.getCollectionName());
+		}
+
 		return entity;
 	}
 
@@ -84,11 +89,22 @@ public <S extends T> List<S> save(Iterable<S> entities) {
 
 		Assert.notNull(entities, "The given Iterable of entities not be null!");
 
-		List<S> result = new ArrayList<S>(tryDetermineRealSizeOrReturn(entities, 10));
+		List<S> result = convertIterableToList(entities);
+		boolean allNew = true;
 
 		for (S entity : entities) {
-			save(entity);
-			result.add(entity);
+			if (allNew && !entityInformation.isNew(entity)) {
+				allNew = false;
+			}
+		}
+
+		if (allNew) {
+			mongoOperations.insertAll(result);
+		} else {
+
+			for (S entity : result) {
+				save(entity);
+			}
 		}
 
 		return result;
@@ -211,32 +227,8 @@ public List<T> findAll(Sort sort) {
 		return findAll(new Query().with(sort));
 	}
 
-	private List<T> findAll(Query query) {
-
-		if (query == null) {
-			return Collections.emptyList();
-		}
-
-		return mongoOperations.find(query, entityInformation.getJavaType(), entityInformation.getCollectionName());
-	}
-
-	/**
-	 * Returns the underlying {@link MongoOperations} instance.
-	 * 
-	 * @return
-	 */
-	protected MongoOperations getMongoOperations() {
-		return this.mongoOperations;
-	}
-
-	/**
-	 * @return the entityInformation
-	 */
-	protected MongoEntityInformation<T, ID> getEntityInformation() {
-		return entityInformation;
-	}
-
-	/* (non-Javadoc)
+	/* 
+	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.repository.MongoRepository#insert(java.lang.Object)
 	 */
 	@Override
@@ -248,7 +240,8 @@ public <S extends T> S insert(S entity) {
 		return entity;
 	}
 
-	/* (non-Javadoc)
+	/* 
+	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.repository.MongoRepository#insert(java.lang.Iterable)
 	 */
 	@Override
@@ -266,27 +259,36 @@ public <S extends T> List<S> insert(Iterable<S> entities) {
 		return list;
 	}
 
-	private <S extends T> List<S> convertIterableToList(Iterable<S> entities) {
+	private List<T> findAll(Query query) {
+
+		if (query == null) {
+			return Collections.emptyList();
+		}
+
+		return mongoOperations.find(query, entityInformation.getJavaType(), entityInformation.getCollectionName());
+	}
+
+	private static <T> List<T> convertIterableToList(Iterable<T> entities) {
 
 		if (entities instanceof List) {
-			return (List<S>) entities;
+			return (List<T>) entities;
 		}
 
 		int capacity = tryDetermineRealSizeOrReturn(entities, 10);
 
 		if (capacity == 0 || entities == null) {
-			return Collections.<S> emptyList();
+			return Collections.<T> emptyList();
 		}
 
-		List<S> list = new ArrayList<S>(capacity);
-		for (S entity : entities) {
+		List<T> list = new ArrayList<T>(capacity);
+		for (T entity : entities) {
 			list.add(entity);
 		}
 
 		return list;
 	}
 
-	private int tryDetermineRealSizeOrReturn(Iterable<?> iterable, int defaultSize) {
+	private static int tryDetermineRealSizeOrReturn(Iterable<?> iterable, int defaultSize) {
 		return iterable == null ? 0 : (iterable instanceof Collection) ? ((Collection<?>) iterable).size() : defaultSize;
 	}
 }

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/support/SimpleMongoRepositoryTests.java

@@ -123,9 +123,9 @@ public void shouldInsertSingle() {
 	public void shouldInsertMutlipleFromList() {
 
 		String randomId = UUID.randomUUID().toString();
-
 		Map<String, Person> idToPerson = new HashMap<String, Person>();
 		List<Person> persons = new ArrayList<Person>();
+
 		for (int i = 0; i < 10; i++) {
 			Person person = new Person("First" + i + randomId, "Last" + randomId + i, 42 + i);
 			idToPerson.put(person.getId(), person);
@@ -135,7 +135,6 @@ public void shouldInsertMutlipleFromList() {
 		List<Person> saved = repository.insert(persons);
 
 		assertThat(saved, hasSize(persons.size()));
-
 		assertThatAllReferencePersonsWereStoredCorrectly(idToPerson, saved);
 	}
 
@@ -146,9 +145,9 @@ public void shouldInsertMutlipleFromList() {
 	public void shouldInsertMutlipleFromSet() {
 
 		String randomId = UUID.randomUUID().toString();
-
 		Map<String, Person> idToPerson = new HashMap<String, Person>();
 		Set<Person> persons = new HashSet<Person>();
+
 		for (int i = 0; i < 10; i++) {
 			Person person = new Person("First" + i + randomId, "Last" + i + randomId, 42 + i);
 			idToPerson.put(person.getId(), person);
@@ -158,7 +157,6 @@ public void shouldInsertMutlipleFromSet() {
 		List<Person> saved = repository.insert(persons);
 
 		assertThat(saved, hasSize(persons.size()));
-
 		assertThatAllReferencePersonsWereStoredCorrectly(idToPerson, saved);
 	}