DATACOUCH-12: Refactor mapping layer to accomodate complex types.

This changeset is a complete refactor of the mapping layer to make
sure that _class complex type mapping works. It also decouples
the actual JSON mapping and abstracts it into a CouchbaseDocument
mapping. This ensures forward compatibility by potentially swapping
out JSON to a different format.

Author: daschl

README.md

@@ -9,14 +9,14 @@ Full documentation is still in the making, so this README outlines the basic ste
 
  - Templates
  - JavaConfig
+ - Mapping of arbitrary Objects (Value Objects)
+ - View support in template
  - CRUD Repository (aside *All and count methods, see planned)
  - Basic Auditing (JMX) 
  - Additional: transparent @Cacheable support
 
 ### Planned (before 1.0)
 
- - Mapping of arbitrary Objects (Value Objects)
- - View support in template
  - XML Config (namespace for template + repositories)
  - find*-based methods on repositories through Views
  - @View annotation for customization

src/main/java/org/springframework/data/couchbase/core/CouchbaseTemplate.java

@@ -26,9 +26,12 @@
 
 import org.springframework.data.couchbase.core.convert.CouchbaseConverter;
 import org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter;
-import org.springframework.data.couchbase.core.mapping.ConvertedCouchbaseDocument;
+import org.springframework.data.couchbase.core.convert.translation.JacksonTranslationService;
+import org.springframework.data.couchbase.core.convert.translation.TranslationService;
+import org.springframework.data.couchbase.core.mapping.CouchbaseDocument;
 import org.springframework.data.couchbase.core.mapping.CouchbasePersistentEntity;
 import org.springframework.data.couchbase.core.mapping.CouchbasePersistentProperty;
+import org.springframework.data.couchbase.core.mapping.CouchbaseStorable;
 import org.springframework.data.mapping.context.MappingContext;
 
 import com.couchbase.client.CouchbaseClient;
@@ -45,6 +48,7 @@ public class CouchbaseTemplate implements CouchbaseOperations {
   private static final Collection<String> ITERABLE_CLASSES;
   private final CouchbaseExceptionTranslator exceptionTranslator = 
   		new CouchbaseExceptionTranslator();
+  private final TranslationService<Object> translationService;
 
 	static {
 		Set<String> iterableClasses = new HashSet<String>();
@@ -61,8 +65,9 @@ public CouchbaseTemplate(final CouchbaseClient client) {
   public CouchbaseTemplate(final CouchbaseClient client,
     final CouchbaseConverter converter) {
     this.client = client;
-    this.couchbaseConverter = converter == null ? getDefaultConverter(client) : converter;
-    this.mappingContext = this.couchbaseConverter.getMappingContext();
+    couchbaseConverter = converter == null ? getDefaultConverter(client) : converter;
+    mappingContext = couchbaseConverter.getMappingContext();
+    translationService = new JacksonTranslationService();
   }
 
   private CouchbaseConverter getDefaultConverter(final CouchbaseClient client) {
@@ -72,40 +77,47 @@ private CouchbaseConverter getDefaultConverter(final CouchbaseClient client) {
     return converter;
   }
 
+  private Object translateEncode(final CouchbaseStorable source) {
+    return translationService.encode(source);
+  }
+
+  private CouchbaseStorable translateDecode(final String source, final CouchbaseStorable target) {
+    return translationService.decode(source, target);
+  }
+
   public final void insert(final Object objectToSave) {
   	ensureNotIterable(objectToSave);
 
-    final ConvertedCouchbaseDocument converted =
-      new ConvertedCouchbaseDocument();
+    final CouchbaseDocument converted = new CouchbaseDocument();
     couchbaseConverter.write(objectToSave, converted);
+
     execute(new BucketCallback<OperationFuture<Boolean>>() {
       @Override
       public OperationFuture<Boolean> doInBucket() {
         return client.add(
-          converted.getId(), converted.getExpiry(), converted.getRawValue());
+          converted.getId(), converted.getExpiration(), translateEncode(converted));
       }
     });
   }
 
   public final void insert(final Collection<? extends Object> batchToSave) {
   	Iterator<? extends Object> iter = batchToSave.iterator();
-  	while(iter.hasNext()) {
+  	while (iter.hasNext()) {
   		insert(iter.next());
   	}
   }
 
   public void save(final Object objectToSave) {
   	ensureNotIterable(objectToSave);
 
-    final ConvertedCouchbaseDocument converted =
-      new ConvertedCouchbaseDocument();
+    final CouchbaseDocument converted = new CouchbaseDocument();
     couchbaseConverter.write(objectToSave, converted);
 
     execute(new BucketCallback<OperationFuture<Boolean>>() {
       @Override
       public OperationFuture<Boolean> doInBucket() {
         return client.set(
-          converted.getId(), converted.getExpiry(), converted.getRawValue());
+          converted.getId(), converted.getExpiration(), translateEncode(converted));
       }
     });
   }
@@ -120,15 +132,14 @@ public void save(final Collection<? extends Object> batchToSave) {
   public void update(final Object objectToSave) {
   	ensureNotIterable(objectToSave);
 
-    final ConvertedCouchbaseDocument converted =
-      new ConvertedCouchbaseDocument();
+    final CouchbaseDocument converted = new CouchbaseDocument();
     couchbaseConverter.write(objectToSave, converted);
 
     execute(new BucketCallback<OperationFuture<Boolean>>() {
       @Override
       public OperationFuture<Boolean> doInBucket() {
         return client.replace(
-          converted.getId(), converted.getExpiry(), converted.getRawValue());
+          converted.getId(), converted.getExpiration(), translateEncode(converted));
       }
     });
 
@@ -152,9 +163,9 @@ public String doInBucket() {
   	if (result == null) {
   		return null;
   	}
-  	
-  	ConvertedCouchbaseDocument converted = new ConvertedCouchbaseDocument(id, result);
-  	return couchbaseConverter.read(entityClass, converted);
+
+    CouchbaseDocument converted = new CouchbaseDocument(id);
+  	return couchbaseConverter.read(entityClass, (CouchbaseDocument) translateDecode(result, converted));
   }
 
 
@@ -173,9 +184,9 @@ public <T> List<T> findByView(final String designName, final String viewName,
 
     List<T> result = new ArrayList<T>(response.size());
     for (ViewRow row : response) {
-      ConvertedCouchbaseDocument converted =
-        new ConvertedCouchbaseDocument(row.getId(), (String) row.getDocument());
-      result.add(couchbaseConverter.read(entityClass, converted));
+      CouchbaseDocument converted = new CouchbaseDocument(row.getId());
+      result.add(couchbaseConverter.read(entityClass,
+        (CouchbaseDocument) translateDecode((String) row.getDocument(), converted)));
     }
 
     return result;
@@ -206,7 +217,7 @@ public OperationFuture<Boolean> doInBucket() {
       return;
     }
 
-    final ConvertedCouchbaseDocument converted = new ConvertedCouchbaseDocument();
+    final CouchbaseDocument converted = new CouchbaseDocument();
     couchbaseConverter.write(objectToRemove, converted);
 
     execute(new BucketCallback<OperationFuture<Boolean>>() {
@@ -257,7 +268,7 @@ protected final void ensureNotIterable(Object o) {
 	}
 
 	private RuntimeException potentiallyConvertRuntimeException(final RuntimeException ex) {
-		RuntimeException resolved = this.exceptionTranslator.translateExceptionIfPossible(ex);
+		RuntimeException resolved = exceptionTranslator.translateExceptionIfPossible(ex);
 		return resolved == null ? ex : resolved;
 	}
 

src/main/java/org/springframework/data/couchbase/core/convert/AbstractCouchbaseConverter.java

@@ -29,6 +29,7 @@ public abstract class AbstractCouchbaseConverter implements CouchbaseConverter,
 
   protected final GenericConversionService conversionService;
   protected EntityInstantiators instantiators = new EntityInstantiators();
+  protected CustomConversions conversions = new CustomConversions();
 
   public AbstractCouchbaseConverter(
     GenericConversionService conversionService) {

src/main/java/org/springframework/data/couchbase/core/convert/CouchbaseConverter.java

@@ -18,7 +18,7 @@
 
 import org.springframework.data.convert.EntityConverter;
 import org.springframework.data.convert.EntityReader;
-import org.springframework.data.couchbase.core.mapping.ConvertedCouchbaseDocument;
+import org.springframework.data.couchbase.core.mapping.CouchbaseDocument;
 import org.springframework.data.couchbase.core.mapping.CouchbasePersistentEntity;
 import org.springframework.data.couchbase.core.mapping.CouchbasePersistentProperty;
 
@@ -27,7 +27,7 @@
  */
 public interface CouchbaseConverter extends
   EntityConverter<CouchbasePersistentEntity<?>,
-    CouchbasePersistentProperty, Object, ConvertedCouchbaseDocument>,
-  CouchbaseWriter<Object, ConvertedCouchbaseDocument>,
-  EntityReader<Object, ConvertedCouchbaseDocument> {
+    CouchbasePersistentProperty, Object, CouchbaseDocument>,
+  CouchbaseWriter<Object, CouchbaseDocument>,
+  EntityReader<Object, CouchbaseDocument> {
 }

src/main/java/org/springframework/data/couchbase/core/convert/CouchbaseDocumentPropertyAccessor.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2013 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.couchbase.core.convert;
+
+import org.springframework.context.expression.MapAccessor;
+import org.springframework.data.couchbase.core.mapping.CouchbaseDocument;
+import org.springframework.expression.EvaluationContext;
+import org.springframework.expression.TypedValue;
+
+import java.util.Map;
+
+/**
+ * @author Michael Nitschinger
+ */
+public class CouchbaseDocumentPropertyAccessor extends MapAccessor {
+
+  static MapAccessor INSTANCE = new CouchbaseDocumentPropertyAccessor();
+
+  @Override
+  public Class<?>[] getSpecificTargetClasses() {
+    return new Class[] {CouchbaseDocument.class};
+  }
+
+  @Override
+  public boolean canRead(EvaluationContext context, Object target, String name) {
+    return true;
+  }
+
+  @Override
+  public TypedValue read(EvaluationContext contect, Object target, String name) {
+    Map<String, Object> source = (Map<String, Object>) target;
+
+    Object value = source.get(name);
+    return value == null ? TypedValue.NULL : new TypedValue(value);
+  }
+}

src/main/java/org/springframework/data/couchbase/core/convert/CouchbaseTypeMapper.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2013 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.couchbase.core.convert;
+
+import org.springframework.data.convert.TypeMapper;
+import org.springframework.data.couchbase.core.mapping.CouchbaseDocument;
+
+/**
+ * @author Michael Nitschinger
+ */
+public interface CouchbaseTypeMapper extends TypeMapper<CouchbaseDocument> {
+
+}

src/main/java/org/springframework/data/couchbase/core/convert/CustomConversions.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2013 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.couchbase.core.convert;
+
+import org.springframework.data.mapping.model.SimpleTypeHolder;
+import org.springframework.util.Assert;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Value object to capture custom conversion.
+ *
+ * Types that can be mapped directly onto JSON are considered simple ones,
+ * because they neither need deeper inspection nor nested conversion.
+ *
+ * @author Michael Nitschinger
+ */
+public class CustomConversions {
+
+  private final SimpleTypeHolder simpleTypeHolder;
+
+  CustomConversions() {
+    this(new ArrayList<Object>());
+  }
+
+  public CustomConversions(final List<?> converters) {
+    Assert.notNull(converters);
+
+    simpleTypeHolder = new SimpleTypeHolder();
+  }
+
+  public boolean isSimpleType(Class<?> type) {
+    return simpleTypeHolder.isSimpleType(type);
+  }
+
+}

src/main/java/org/springframework/data/couchbase/core/convert/DefaultCouchbaseTypeMapper.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2013 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.couchbase.core.convert;
+
+import org.springframework.data.convert.DefaultTypeMapper;
+import org.springframework.data.convert.TypeAliasAccessor;
+import org.springframework.data.couchbase.core.mapping.CouchbaseDocument;
+
+/**
+ * @author Michael Nitschinger
+ */
+public class DefaultCouchbaseTypeMapper extends DefaultTypeMapper<CouchbaseDocument> implements CouchbaseTypeMapper {
+
+  public static final String DEFAULT_TYPE_KEY = "_class";
+
+  public DefaultCouchbaseTypeMapper(final String typeKey) {
+    super(new CouchbaseDocumentTypeAliasAccessor(typeKey));
+  }
+
+  public static final class CouchbaseDocumentTypeAliasAccessor implements TypeAliasAccessor<CouchbaseDocument> {
+
+    private final String typeKey;
+
+    public CouchbaseDocumentTypeAliasAccessor(final String typeKey) {
+      this.typeKey = typeKey;
+    }
+
+    @Override
+    public Object readAliasFrom(final CouchbaseDocument source) {
+      return source.get(typeKey);
+    }
+
+    @Override
+    public void writeTypeTo(final CouchbaseDocument sink, final Object alias) {
+      if (typeKey != null) {
+        sink.put(typeKey, alias);
+      }
+    }
+  }
+
+}