Add Java Bean support to the PojoCodec

JAVA-2555

Author: rozza

bson/src/main/org/bson/codecs/pojo/ClassModel.java

@@ -16,12 +16,11 @@
 
 package org.bson.codecs.pojo;
 
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 /**
- * This model represents the metadata for a class and all its fields.
+ * This model represents the metadata for a class and all its properties.
  *
  * @param <T> The type of the class the ClassModel represents
  * @since 3.5
@@ -34,25 +33,23 @@ public final class ClassModel<T> {
     private final boolean discriminatorEnabled;
     private final String discriminatorKey;
     private final String discriminator;
-    private final FieldModel<?> idField;
-    private final List<FieldModel<?>> fieldModels;
-    private final Map<String, TypeParameterMap> fieldNameToTypeParameterMap;
-    private final Map<String, FieldModel<?>> fieldMap;
+    private final PropertyModel<?> idProperty;
+    private final List<PropertyModel<?>> propertyModels;
+    private final Map<String, TypeParameterMap> propertyNameToTypeParameterMap;
 
-    ClassModel(final Class<T> clazz, final Map<String, TypeParameterMap> fieldNameToTypeParameterMap,
+    ClassModel(final Class<T> clazz, final Map<String, TypeParameterMap> propertyNameToTypeParameterMap,
                final InstanceCreatorFactory<T> instanceCreatorFactory, final Boolean discriminatorEnabled, final String discriminatorKey,
-               final String discriminator, final FieldModel<?> idField, final List<FieldModel<?>> fieldModels) {
+               final String discriminator, final PropertyModel<?> idProperty, final List<PropertyModel<?>> propertyModels) {
         this.name = clazz.getSimpleName();
         this.type = clazz;
         this.hasTypeParameters = clazz.getTypeParameters().length > 0;
-        this.fieldNameToTypeParameterMap = fieldNameToTypeParameterMap;
+        this.propertyNameToTypeParameterMap = propertyNameToTypeParameterMap;
         this.instanceCreatorFactory = instanceCreatorFactory;
         this.discriminatorEnabled = discriminatorEnabled;
         this.discriminatorKey = discriminatorKey;
         this.discriminator = discriminator;
-        this.idField = idField;
-        this.fieldModels = fieldModels;
-        this.fieldMap = generateFieldMap(fieldModels);
+        this.idProperty = idProperty;
+        this.propertyModels = propertyModels;
     }
 
     /**
@@ -113,31 +110,36 @@ public String getDiscriminator() {
     }
 
     /**
-     * Gets a field by the document field name.
+     * Gets a {@link PropertyModel} by the property name.
      *
-     * @param documentFieldName the fieldModel's document name
-     * @return the field or null if the field is not found
+     * @param propertyName the PropertyModel's property name
+     * @return the PropertyModel or null if the property is not found
      */
-    public FieldModel<?> getFieldModel(final String documentFieldName) {
-        return fieldMap.get(documentFieldName);
+    public PropertyModel<?> getPropertyModel(final String propertyName) {
+        for (PropertyModel<?> propertyModel : propertyModels) {
+            if (propertyModel.getName().equals(propertyName)) {
+                return propertyModel;
+            }
+        }
+        return null;
     }
 
     /**
-     * Returns all the fields on this model
+     * Returns all the properties on this model
      *
-     * @return the list of fields
+     * @return the list of properties
      */
-    public List<FieldModel<?>> getFieldModels() {
-        return fieldModels;
+    public List<PropertyModel<?>> getPropertyModels() {
+        return propertyModels;
     }
 
     /**
-     * Returns the {@link FieldModel} mapped as the id field for this ClassModel
+     * Returns the {@link PropertyModel} mapped as the id property for this ClassModel
      *
-     * @return the FieldModel for the id
+     * @return the PropertyModel for the id
      */
-    public FieldModel<?> getIdFieldModel() {
-        return idField;
+    public PropertyModel<?> getIdPropertyModel() {
+        return idProperty;
     }
 
     /**
@@ -183,13 +185,13 @@ public boolean equals(final Object o) {
         if (getDiscriminator() != null ? !getDiscriminator().equals(that.getDiscriminator()) : that.getDiscriminator() != null) {
             return false;
         }
-        if (idField != null ? !idField.equals(that.idField) : that.idField != null) {
+        if (idProperty != null ? !idProperty.equals(that.idProperty) : that.idProperty != null) {
             return false;
         }
-        if (!getFieldModels().equals(that.getFieldModels())) {
+        if (!getPropertyModels().equals(that.getPropertyModels())) {
             return false;
         }
-        if (!getFieldNameToTypeParameterMap().equals(that.getFieldNameToTypeParameterMap())) {
+        if (!getPropertyNameToTypeParameterMap().equals(that.getPropertyNameToTypeParameterMap())) {
             return false;
         }
 
@@ -203,26 +205,18 @@ public int hashCode() {
         result = 31 * result + (discriminatorEnabled ? 1 : 0);
         result = 31 * result + (getDiscriminatorKey() != null ? getDiscriminatorKey().hashCode() : 0);
         result = 31 * result + (getDiscriminator() != null ? getDiscriminator().hashCode() : 0);
-        result = 31 * result + (idField != null ? idField.hashCode() : 0);
-        result = 31 * result + getFieldModels().hashCode();
-        result = 31 * result + getFieldNameToTypeParameterMap().hashCode();
+        result = 31 * result + (idProperty != null ? idProperty.hashCode() : 0);
+        result = 31 * result + getPropertyModels().hashCode();
+        result = 31 * result + getPropertyNameToTypeParameterMap().hashCode();
         return result;
     }
 
     InstanceCreatorFactory<T> getInstanceCreatorFactory() {
         return instanceCreatorFactory;
     }
 
-    Map<String, TypeParameterMap> getFieldNameToTypeParameterMap() {
-        return fieldNameToTypeParameterMap;
-    }
-
-    private static Map<String, FieldModel<?>> generateFieldMap(final List<FieldModel<?>> fieldModels) {
-        Map<String, FieldModel<?>> fieldMap = new HashMap<String, FieldModel<?>>();
-        for (FieldModel<?> fieldModel : fieldModels) {
-            fieldMap.put(fieldModel.getDocumentFieldName(), fieldModel);
-        }
-        return fieldMap;
+    Map<String, TypeParameterMap> getPropertyNameToTypeParameterMap() {
+        return propertyNameToTypeParameterMap;
     }
 
 }

bson/src/main/org/bson/codecs/pojo/ClassModelBuilder.java

@@ -16,6 +16,8 @@
 
 package org.bson.codecs.pojo;
 
+import org.bson.codecs.configuration.CodecConfigurationException;
+
 import java.lang.annotation.Annotation;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -41,17 +43,17 @@
  * @see ClassModel
  */
 public class ClassModelBuilder<T> {
-    private static final String ID_FIELD_NAME = "_id";
-    private final List<FieldModelBuilder<?>> fields = new ArrayList<FieldModelBuilder<?>>();
+    private static final String ID_PROPERTY_NAME = "_id";
+    private final List<PropertyModelBuilder<?>> propertyModelBuilders = new ArrayList<PropertyModelBuilder<?>>();
     private InstanceCreatorFactory<T> instanceCreatorFactory;
     private Class<T> type;
-    private Map<String, TypeParameterMap> fieldNameToTypeParameterMap = emptyMap();
+    private Map<String, TypeParameterMap> propertyNameToTypeParameterMap = emptyMap();
     private List<Convention> conventions = DEFAULT_CONVENTIONS;
     private List<Annotation> annotations = emptyList();
     private boolean discriminatorEnabled;
     private String discriminator;
     private String discriminatorKey;
-    private String idField;
+    private String idPropertyName;
 
     ClassModelBuilder(final Class<T> type) {
         configureClassModelBuilder(this, notNull("type", type));
@@ -184,59 +186,56 @@ public Boolean useDiscriminator() {
     }
 
     /**
-     * Designates a field as the {@code _id} field for this type.  If another field is currently marked as the  {@code _id} field,
-     * that setting is cleared in favor of the named field.
+     * Designates a property as the {@code _id} property for this type.  If another property is currently marked as the  {@code _id}
+     * property, that setting is cleared in favor of the named property.
+     *
+     * @param idPropertyName the property name to use for the {@code _id} property
      *
-     * @param idField the FieldModel field name to use for the {@code _id} field
      * @return this
      */
-    public ClassModelBuilder<T> idField(final String idField) {
-        this.idField = notNull("idField", idField);
+    public ClassModelBuilder<T> idPropertyName(final String idPropertyName) {
+        this.idPropertyName = notNull("idPropertyName", idPropertyName);
         return this;
     }
 
     /**
-     * @return the designated {@code _id} field for this type or null if not set
+     * @return the designated {@code _id} property name for this type or null if not set
      */
-    public String getIdField() {
-        return idField;
+    public String getIdPropertyName() {
+        return idPropertyName;
     }
 
     /**
-     * Remove a field from the builder
+     * Remove a property from the builder
      *
-     * @param name the actual field name in the POJO and not the {@code documentFieldName}.
-     * @return returns true if the field matched and was removed
+     * @param propertyName the actual property name in the POJO and not the {@code documentPropertyName}.
+     * @return returns true if the property matched and was removed
      */
-    public boolean removeField(final String name) {
-        return fields.remove(getField(notNull("name", name)));
+    public boolean removeProperty(final String propertyName) {
+        return propertyModelBuilders.remove(getProperty(notNull("propertyName", propertyName)));
     }
 
     /**
-     * Gets a field by the given name.
-     *
-     * <p>
-     * Note: Searches against the actual field name in the POJO and not the {@code documentFieldName}.
-     * </p>
+     * Gets a property by the property name.
      *
-     * @param name the name of the field to find.
-     * @return the field or null if the field is not found
+     * @param propertyName the name of the property to find.
+     * @return the property or null if the property is not found
      */
-    public FieldModelBuilder<?> getField(final String name) {
-        notNull("name", name);
-        for (FieldModelBuilder<?> fieldModelBuilder : fields) {
-            if (fieldModelBuilder.getFieldName().equals(name)) {
-                return fieldModelBuilder;
+    public PropertyModelBuilder<?> getProperty(final String propertyName) {
+        notNull("propertyName", propertyName);
+        for (PropertyModelBuilder<?> propertyModelBuilder : propertyModelBuilders) {
+            if (propertyModelBuilder.getName().equals(propertyName)) {
+                return propertyModelBuilder;
             }
         }
         return null;
     }
 
     /**
-     * @return the fields on the modeled type
+     * @return the properties on the modeled type
      */
-    public List<FieldModelBuilder<?>> getFields() {
-        return Collections.unmodifiableList(fields);
+    public List<PropertyModelBuilder<?>> getPropertyModelBuilders() {
+        return Collections.unmodifiableList(propertyModelBuilders);
     }
 
     /**
@@ -245,8 +244,8 @@ public List<FieldModelBuilder<?>> getFields() {
      * @return the new instance
      */
     public ClassModel<T> build() {
-        List<FieldModel<?>> fieldModels = new ArrayList<FieldModel<?>>();
-        FieldModel<?> idFieldModel = null;
+        List<PropertyModel<?>> propertyModels = new ArrayList<PropertyModel<?>>();
+        PropertyModel<?> idPropertyModel = null;
 
         stateNotNull("type", type);
         for (Convention convention : conventions) {
@@ -259,72 +258,71 @@ public ClassModel<T> build() {
             stateNotNull("discriminator", discriminator);
         }
 
-        for (FieldModelBuilder<?> fieldModelBuilder : fields) {
-            boolean isIdField = fieldModelBuilder.getFieldName().equals(idField);
-            if (isIdField) {
-                fieldModelBuilder.documentFieldName(ID_FIELD_NAME);
+        for (PropertyModelBuilder<?> propertyModelBuilder : propertyModelBuilders) {
+            boolean isIdProperty = propertyModelBuilder.getName().equals(idPropertyName);
+            if (isIdProperty) {
+                propertyModelBuilder.readName(ID_PROPERTY_NAME).writeName(ID_PROPERTY_NAME);
             }
 
-            FieldModel<?> model = fieldModelBuilder.build();
-            fieldModels.add(model);
-            if (isIdField) {
-                idFieldModel = model;
+            PropertyModel<?> model = propertyModelBuilder.build();
+            propertyModels.add(model);
+            if (isIdProperty) {
+                idPropertyModel = model;
             }
         }
-        validateFieldModels(fieldModels);
+        validatePropertyModels(type.getSimpleName(), propertyModels);
 
 
-        return new ClassModel<T>(type, fieldNameToTypeParameterMap, instanceCreatorFactory, discriminatorEnabled, discriminatorKey,
-                discriminator, idFieldModel, unmodifiableList(fieldModels));
+        return new ClassModel<T>(type, propertyNameToTypeParameterMap, instanceCreatorFactory, discriminatorEnabled, discriminatorKey,
+                discriminator, idPropertyModel, unmodifiableList(propertyModels));
     }
 
     @Override
     public String toString() {
         return format("ClassModelBuilder{type=%s}", type);
     }
 
-    Map<String, TypeParameterMap> getFieldNameToTypeParameterMap() {
-        return fieldNameToTypeParameterMap;
+    Map<String, TypeParameterMap> getPropertyNameToTypeParameterMap() {
+        return propertyNameToTypeParameterMap;
     }
 
-    ClassModelBuilder<T> fieldNameToTypeParameterMap(final Map<String, TypeParameterMap> fieldNameToTypeParameterMap) {
-        this.fieldNameToTypeParameterMap = unmodifiableMap(new HashMap<String, TypeParameterMap>(fieldNameToTypeParameterMap));
+    ClassModelBuilder<T> propertyNameToTypeParameterMap(final Map<String, TypeParameterMap> propertyNameToTypeParameterMap) {
+        this.propertyNameToTypeParameterMap = unmodifiableMap(new HashMap<String, TypeParameterMap>(propertyNameToTypeParameterMap));
         return this;
     }
 
-    ClassModelBuilder<T> addField(final FieldModelBuilder<?> fieldModelBuilder) {
-        fields.add(notNull("fieldModelBuilder", fieldModelBuilder));
+    ClassModelBuilder<T> addProperty(final PropertyModelBuilder<?> propertyModelBuilder) {
+        propertyModelBuilders.add(notNull("propertyModelBuilder", propertyModelBuilder));
         return this;
     }
 
-    private void validateFieldModels(final List<FieldModel<?>> fieldModels) {
-        Map<String, Integer> fieldNameMap = new HashMap<String, Integer>();
-        Map<String, Integer> fieldDocumentNameMap = new HashMap<String, Integer>();
-        String duplicateFieldName = null;
-        String duplicateDocumentFieldName = null;
-
-        for (FieldModel<?> fieldModel : fieldModels) {
-            String fieldName = fieldModel.getFieldName();
-            if (fieldNameMap.containsKey(fieldName)) {
-                duplicateFieldName = fieldName;
-                break;
-            }
-            fieldNameMap.put(fieldName, 1);
+    private void validatePropertyModels(final String declaringClass, final List<PropertyModel<?>> propertyModels) {
+        Map<String, Integer> propertyNameMap = new HashMap<String, Integer>();
+        Map<String, Integer> propertyReadNameMap = new HashMap<String, Integer>();
+        Map<String, Integer> propertyWriteNameMap = new HashMap<String, Integer>();
 
-            String documentFieldName = fieldModel.getDocumentFieldName();
-            if (fieldDocumentNameMap.containsKey(documentFieldName)) {
-                duplicateDocumentFieldName = documentFieldName;
-                break;
+        for (PropertyModel<?> propertyModel : propertyModels) {
+            checkForDuplicates("property", propertyModel.getName(), propertyNameMap, declaringClass);
+            if (propertyModel.isReadable()) {
+                checkForDuplicates("read property", propertyModel.getReadName(), propertyReadNameMap, declaringClass);
+            }
+            if (propertyModel.isWritable()) {
+                checkForDuplicates("write property", propertyModel.getWriteName(), propertyWriteNameMap, declaringClass);
             }
-            fieldDocumentNameMap.put(documentFieldName, 1);
         }
-        if (idField != null && !fieldNameMap.containsKey(idField)) {
-            throw new IllegalStateException(format("Invalid id field, field named field '%s' can not be found.", idField));
-        } else if (duplicateFieldName != null) {
-            throw new IllegalStateException(format("Duplicate field named '%s' found.", duplicateFieldName));
-        } else if (duplicateDocumentFieldName != null) {
-            throw new IllegalStateException(format("Duplicate document field named '%s' found.", duplicateDocumentFieldName));
+
+        if (idPropertyName != null && !propertyNameMap.containsKey(idPropertyName)) {
+            throw new CodecConfigurationException(format("Invalid id property, property named '%s' can not be found.", idPropertyName));
+        }
+    }
+
+    private void checkForDuplicates(final String propertyType, final String propertyName, final Map<String, Integer> propertyNameMap,
+                                    final String declaringClass) {
+        if (propertyNameMap.containsKey(propertyName)) {
+            throw new CodecConfigurationException(format("Duplicate %s named '%s' found in %s.", propertyType, propertyName,
+                    declaringClass));
         }
+        propertyNameMap.put(propertyName, 1);
     }
 
 }