Add object field annotation

Author: vuminhkh

elasticsearch-annotations/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>fr.lucboutier.elasticsearch</groupId>
         <artifactId>elasticsearch-mapping-parent</artifactId>
-        <version>1.4.0</version>
+        <version>1.5.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>elasticsearch-annotations</artifactId>

elasticsearch-annotations/src/main/java/org/elasticsearch/annotation/ObjectField.java

@@ -0,0 +1,26 @@
+package org.elasticsearch.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.FIELD, ElementType.METHOD })
+public @interface ObjectField {
+
+    /**
+     * Override the class of annotated field, helpful when annotate a map but use another object class to perform mapping creation
+     * 
+     * @return class to override the class of annotated field
+     */
+    Class<?> objectClass() default ObjectField.class;
+
+    /**
+     * The enabled flag allows to disable parsing and indexing a named object completely. This is handy when a portion of the JSON document contains arbitrary
+     * JSON which should not be indexed, nor added to the mapping
+     * 
+     * @return Yes or no (default is yes)
+     */
+    boolean enabled() default true;
+}

elasticsearch-mapping/pom.xml

@@ -3,7 +3,7 @@
     <parent>
         <groupId>fr.lucboutier.elasticsearch</groupId>
         <artifactId>elasticsearch-mapping-parent</artifactId>
-        <version>1.4.0</version>
+        <version>1.5.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>elasticsearch-mapping</artifactId>

elasticsearch-mapping/src/main/java/org/elasticsearch/mapping/FieldsMappingBuilder.java

@@ -296,9 +296,10 @@ private void processStringOrPrimitive(Class<?> clazz, Map<String, Object> proper
 
     private void processComplexType(Class<?> clazz, Map<String, Object> propertiesDefinitionMap, String pathPrefix, Indexable indexable,
             List<IFilterBuilderHelper> filters, List<IFacetBuilderHelper> facets) {
-        NestedObjectFieldAnnotationParser parser = new NestedObjectFieldAnnotationParser(this, filters, facets);
-        processFieldAnnotation(NestedObject.class, parser, propertiesDefinitionMap, pathPrefix, indexable);
-
+        NestedObjectFieldAnnotationParser nested = new NestedObjectFieldAnnotationParser(this, filters, facets);
+        processFieldAnnotation(NestedObject.class, nested, propertiesDefinitionMap, pathPrefix, indexable);
+        ObjectFieldAnnotationParser objectFieldAnnotationParser = new ObjectFieldAnnotationParser(this, filters, facets);
+        processFieldAnnotation(ObjectField.class, objectFieldAnnotationParser, propertiesDefinitionMap, pathPrefix, indexable);
     }
 
     @SuppressWarnings("unchecked")

elasticsearch-mapping/src/main/java/org/elasticsearch/mapping/parser/ObjectFieldAnnotationParser.java

@@ -0,0 +1,50 @@
+package org.elasticsearch.mapping.parser;
+
+import java.beans.IntrospectionException;
+import java.util.List;
+import java.util.Map;
+
+import org.elasticsearch.annotation.ObjectField;
+import org.elasticsearch.common.collect.Maps;
+import org.elasticsearch.common.logging.ESLogger;
+import org.elasticsearch.common.logging.Loggers;
+import org.elasticsearch.mapping.*;
+
+/**
+ * Parse a {@link org.elasticsearch.annotation.ObjectField} to enrich the mapping
+ */
+public class ObjectFieldAnnotationParser implements IPropertyAnnotationParser<ObjectField> {
+
+    private static final ESLogger LOGGER = Loggers.getLogger(MappingBuilder.class);
+
+    private final FieldsMappingBuilder fieldsMappingBuilder;
+    private final List<IFilterBuilderHelper> filters;
+    private final List<IFacetBuilderHelper> facets;
+
+    public ObjectFieldAnnotationParser(FieldsMappingBuilder fieldsMappingBuilder, List<IFilterBuilderHelper> filters, List<IFacetBuilderHelper> facets) {
+        this.fieldsMappingBuilder = fieldsMappingBuilder;
+        this.filters = filters;
+        this.facets = facets;
+    }
+
+    @Override
+    public void parseAnnotation(ObjectField annotation, Map<String, Object> fieldDefinition, String pathPrefix, Indexable indexable) {
+        if (fieldDefinition.get("type") != null) {
+            throw new MappingException("A field cannot have more than one Elastic Search type. Parsing ComplexObject on <" + indexable.getDeclaringClassName()
+                    + "." + indexable.getName() + "> type is already set to <" + fieldDefinition.get("type") + ">");
+        }
+
+        fieldDefinition.put("type", "object");
+        fieldDefinition.put("enabled", annotation.enabled());
+        if (annotation.enabled()) {
+            Map<String, SourceFetchContext> fetchContext = Maps.newHashMap();
+            // nested types can provide replacement class to be managed. This can be usefull to override map default type for example.
+            Class<?> replaceClass = annotation.objectClass().equals(ObjectField.class) ? indexable.getType() : annotation.objectClass();
+            try {
+                this.fieldsMappingBuilder.parseFieldMappings(replaceClass, fieldDefinition, facets, filters, fetchContext, indexable.getName() + ".");
+            } catch (IntrospectionException e) {
+                LOGGER.error("Fail to parse object class <" + replaceClass.getName() + ">", e);
+            }
+        }
+    }
+}

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>fr.lucboutier.elasticsearch</groupId>
     <artifactId>elasticsearch-mapping-parent</artifactId>
-    <version>1.4.0</version>
+    <version>1.5.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <name>Elastic search mapping parent</name>