Spring/spring-data-mongodb
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATADOC-108 - added findbyId(…) methods to MongoTemplate.

Browse Source 
Removed Criteria.whereId(…). Updated SimpleMongoRepository to use the new method and use more core template methods to prevent objects from being marshalled to find out whether a particular object exists.
This commit is contained in:
Oliver Gierke
2011-05-18 23:16:31 +02:00
parent 345e6ebf8b
commit 6287fa425d
6 changed files with 64 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
spring-data-mongodb/src/main/java/org/springframework/data/document/mongodb/MongoOperations.java
View File

@@ -332,6 +332,28 @@ public interface MongoOperations {
*/
<T> List<T> find(String collectionName, Query query, Class<T> targetClass, CursorPreparer preparer);
/**
* Returns a document with the given id mapped onto the given class. The collection the query is ran against will be
* derived from the given target class as well.
*
* @param <T>
* @param id the id of the document to return.
* @param targetClass the type the document shall be converted into.
* @return the document with the given id mapped onto the given target class.
*/
<T> T findById(Object id, Class<T> targetClass);
/**
* Returns the document with the given id from the given collection mapped onto the given target class.
*
* @param <T>
* @param collectionName the collection to query for the document
* @param id the id of the document to return
* @param targetClass the type to convert the document to
* @return
*/
<T> T findById(String collectionName, Object id, Class<T> targetClass);
/**
* Map the results of an ad-hoc query on the default MongoDB collection to a single instance of an object of the
* specified type. The first document that matches the query is returned and also removed from the collection in the

21
spring-data-mongodb/src/main/java/org/springframework/data/document/mongodb/MongoTemplate.java
View File

@@ -392,6 +392,18 @@ public class MongoTemplate implements MongoOperations, ApplicationEventPublisher
public <T> List<T> find(String collectionName, Query query, Class<T> targetClass, CursorPreparer preparer) {
return doFind(collectionName, query.getQueryObject(), query.getFieldsObject(), targetClass, preparer);
}
public <T> T findById(Object id, Class<T> targetClass) {
MongoPersistentEntity<?> persistentEntity = mappingContext.getPersistentEntity(targetClass);
return findById(persistentEntity.getCollection(), id, targetClass);
}
public <T> T findById(String collectionName, Object id, Class<T> targetClass) {
MongoPersistentEntity<?> persistentEntity = mappingContext.getPersistentEntity(targetClass);
MongoPersistentProperty idProperty = persistentEntity.getIdProperty();
String idKey = idProperty == null ? ID : idProperty.getName();
return doFindOne(collectionName, new BasicDBObject(idKey, id), null, targetClass);
}
// Find methods that take a Query to express the query and that return a single object that is
// also removed from the collection in the database.
@@ -724,8 +736,7 @@ public class MongoTemplate implements MongoOperations, ApplicationEventPublisher
}
public void remove(Object object) {
Object idValue = this.getIdValue(object);
remove(new Query(whereId().is(idValue)), object.getClass());
remove(new Query(where(getIdPropertyName(object)).is(getIdValue(object))), object.getClass());
}
public <T> void remove(Query query, Class<T> targetClass) {
@@ -959,6 +970,12 @@ public class MongoTemplate implements MongoOperations, ApplicationEventPublisher
throw new MappingException(e.getMessage(), e);
}
}
protected String getIdPropertyName(Object object) {
MongoPersistentEntity<?> persistentEntity = mappingContext.getPersistentEntity(object.getClass());
MongoPersistentProperty idProperty = persistentEntity.getIdProperty();
return idProperty == null ? ID : idProperty.getName();
}
/**
* Populates the id property of the saved object, if it's not set already.

4
spring-data-mongodb/src/main/java/org/springframework/data/document/mongodb/query/Criteria.java
View File

@@ -66,10 +66,6 @@ public class Criteria implements CriteriaDefinition {
return new Criteria(key);
}
public static Criteria whereId() {
return new Criteria("id");
}
/**
* Static factory method to create a Criteria using the provided key
*

24
spring-data-mongodb/src/main/java/org/springframework/data/document/mongodb/repository/SimpleMongoRepository.java
View File

@@ -22,6 +22,8 @@ import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.springframework.dao.DataAccessException;
import org.springframework.data.document.mongodb.CollectionCallback;
import org.springframework.data.document.mongodb.MongoOperations;
import org.springframework.data.document.mongodb.MongoTemplate;
import org.springframework.data.document.mongodb.query.Criteria;
@@ -33,6 +35,10 @@ import org.springframework.data.domain.Sort;
import org.springframework.data.repository.PagingAndSortingRepository;
import org.springframework.util.Assert;
import com.mongodb.BasicDBObject;
import com.mongodb.DBCollection;
import com.mongodb.MongoException;
/**
* Repository base implementation for Mongo.
*
@@ -95,8 +101,7 @@ public class SimpleMongoRepository<T, ID extends Serializable> implements Paging
* )
*/
public T findOne(ID id) {
return template.findOne(entityInformation.getCollectionName(), getIdQuery(id), entityInformation.getJavaType());
return template.findById(id, entityInformation.getJavaType());
}
private Query getIdQuery(Object id) {
@@ -114,9 +119,14 @@ public class SimpleMongoRepository<T, ID extends Serializable> implements Paging
* org.springframework.data.repository.Repository#exists(java.io.Serializable
* )
*/
public boolean exists(ID id) {
public boolean exists(final ID id) {
return template.execute(entityInformation.getCollectionName(), new CollectionCallback<Boolean>() {
return findOne(id) != null;
public Boolean doInCollection(DBCollection collection) throws MongoException, DataAccessException {
return collection.count(new BasicDBObject("_id", id)) > 0;
}
});
}
/*
@@ -134,7 +144,7 @@ public class SimpleMongoRepository<T, ID extends Serializable> implements Paging
* @see org.springframework.data.repository.Repository#delete(java.io.Serializable)
*/
public void delete(ID id) {
delete(findOne(id));
template.remove(entityInformation.getCollectionName(), getIdQuery(id), entityInformation.getJavaType());
}
/*
@@ -144,9 +154,7 @@ public class SimpleMongoRepository<T, ID extends Serializable> implements Paging
* org.springframework.data.repository.Repository#delete(java.lang.Object)
*/
public void delete(T entity) {
template.remove(entityInformation.getCollectionName(), getIdQuery(entityInformation.getId(entity)),
entity.getClass());
delete(entityInformation.getId(entity));
}
/*

15
spring-data-mongodb/src/test/java/org/springframework/data/document/mongodb/MongoTemplateMappingTests.java
View File

@@ -15,12 +15,9 @@
*/
package org.springframework.data.document.mongodb;
import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertThat;
import java.util.List;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
@@ -29,9 +26,6 @@ import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.dao.DataAccessException;
import org.springframework.data.document.mongodb.convert.MongoConverter;
import org.springframework.data.document.mongodb.query.Criteria;
import org.springframework.data.document.mongodb.query.Query;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@@ -98,11 +92,9 @@ public class MongoTemplateMappingTests {
person.setAge(25);
template.insert(person);
List<Person> result = template.find(new Query(Criteria.where("_id").is(person.getId())), Person.class);
assertThat(result.size(), is(1));
assertThat(result, hasItem(person));
assertThat(result.get(0).getFirstName(), is("Oliver"));
assertThat(result.get(0).getAge(), is(25));
Person result = template.findById(person.getId(), Person.class);
assertThat(result.getFirstName(), is("Oliver"));
assertThat(result.getAge(), is(25));
}
private void checkPersonPersisted(MongoTemplate template) {
@@ -114,5 +106,4 @@ public class MongoTemplateMappingTests {
}
});
}
}

17
spring-data-mongodb/src/test/java/org/springframework/data/document/mongodb/PersonExample.java
View File

@@ -15,7 +15,6 @@
*/
package org.springframework.data.document.mongodb;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.logging.Log;
@@ -24,12 +23,6 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.springframework.data.document.mongodb.query.Criteria.*;
import org.springframework.data.document.mongodb.query.Query;
import static org.springframework.data.document.mongodb.query.Query.query;
import org.springframework.data.document.mongodb.query.Update;
import static org.springframework.data.document.mongodb.query.Update.update;
public class PersonExample {
private static final Log log = LogFactory.getLog(PersonExample.class);
@@ -59,7 +52,7 @@ public class PersonExample {
log.debug("Saved: " + p);
p = mongoOps.findOne(query(whereId().is(p.getId())), PersonWithIdPropertyOfTypeString.class);
p = mongoOps.findById(p.getId(), PersonWithIdPropertyOfTypeString.class);
log.debug("Found: " + p);
@@ -67,15 +60,13 @@ public class PersonExample {
// mongoOps.updateFirst(new Query(where("firstName").is("Sven")), update("age", 24));
p = mongoOps.findOne(query(whereId().is(p.getId())), PersonWithIdPropertyOfTypeString.class);
p = mongoOps.findById(p.getId(), PersonWithIdPropertyOfTypeString.class);
log.debug("Updated: " + p);
List<PersonWithIdPropertyOfTypeString> folks = mongoOps.getCollection(PersonWithIdPropertyOfTypeString.class);
log.debug("Querying for all people...");
for (Iterator iterator = folks.iterator(); iterator.hasNext();) {
PersonWithIdPropertyOfTypeString personWithIdPropertyOfTypeString = (PersonWithIdPropertyOfTypeString) iterator
.next();
log.debug(personWithIdPropertyOfTypeString);
for (PersonWithIdPropertyOfTypeString element : folks) {
log.debug(element);
}
// mongoOps.remove( query(whereId().is(p.getId())), p.getClass());