Range Field Histogram Aggregation

server/src/main/java/org/elasticsearch/index/fielddata/plain/DocValuesIndexFieldData.java

@@ -30,6 +30,7 @@
 import org.elasticsearch.index.mapper.IdFieldMapper;
 import org.elasticsearch.index.mapper.MappedFieldType;
 import org.elasticsearch.index.mapper.MapperService;
+import org.elasticsearch.index.mapper.RangeType;
 import org.elasticsearch.indices.breaker.CircuitBreakerService;
 
 import java.util.Set;
@@ -71,6 +72,7 @@ public static class Builder implements IndexFieldData.Builder {
 
         private NumericType numericType;
         private Function<SortedSetDocValues, ScriptDocValues<?>> scriptFunction = AbstractAtomicOrdinalsFieldData.DEFAULT_SCRIPT_FUNCTION;
+        private RangeType rangeType;
 
         public Builder numericType(NumericType type) {
             this.numericType = type;
@@ -82,12 +84,17 @@ public Builder scriptFunction(Function<SortedSetDocValues, ScriptDocValues<?>> s
             return this;
         }
 
+        public Builder setRangeType(RangeType rangeType) {
+            this.rangeType = rangeType;
+            return this;
+        }
+
         @Override
         public IndexFieldData<?> build(IndexSettings indexSettings, MappedFieldType fieldType, IndexFieldDataCache cache,
                                        CircuitBreakerService breakerService, MapperService mapperService) {
             // Ignore Circuit Breaker
             final String fieldName = fieldType.name();
-            if (BINARY_INDEX_FIELD_NAMES.contains(fieldName)) {
+            if (BINARY_INDEX_FIELD_NAMES.contains(fieldName) || rangeType != null) {
                 assert numericType == null;
                 return new BinaryDVIndexFieldData(indexSettings.getIndex(), fieldName);
             } else if (numericType != null) {

server/src/main/java/org/elasticsearch/index/mapper/RangeFieldMapper.java

@@ -41,6 +41,8 @@
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
 import org.elasticsearch.common.xcontent.support.XContentMapValues;
+import org.elasticsearch.index.fielddata.IndexFieldData;
+import org.elasticsearch.index.fielddata.plain.DocValuesIndexFieldData;
 import org.elasticsearch.index.query.QueryShardContext;
 
 import java.io.IOException;
@@ -210,6 +212,8 @@ public static final class RangeFieldType extends MappedFieldType {
             }
         }
 
+        public RangeType rangeType() { return rangeType; }
+
         @Override
         public MappedFieldType clone() {
             return new RangeFieldType(this);
@@ -230,6 +234,12 @@ public int hashCode() {
             return Objects.hash(super.hashCode(), rangeType, dateTimeFormatter);
         }
 
+        @Override
+        public IndexFieldData.Builder fielddataBuilder(String fullyQualifiedIndexName) {
+            failIfNoDocValues();
+            return new DocValuesIndexFieldData.Builder().setRangeType(rangeType);
+        }
+
         @Override
         public String typeName() {
             return rangeType.name;
@@ -468,6 +478,14 @@ public String toString() {
             sb.append(includeTo ? ']' : ')');
             return sb.toString();
         }
+
+        public Object getFrom() {
+            return from;
+        }
+
+        public Object getTo() {
+            return to;
+        }
     }
 
     static class BinaryRangesDocValuesField extends CustomDocValuesField {

server/src/main/java/org/elasticsearch/index/mapper/RangeType.java

@@ -108,6 +108,11 @@ public List<RangeFieldMapper.Range> decodeRanges(BytesRef bytes) {
             throw new UnsupportedOperationException();
         }
 
+        @Override
+        public Double doubleValue (Object endpointValue) {
+            throw new UnsupportedOperationException("IP ranges cannot be safely converted to doubles");
+        }
+
         @Override
         public Query dvRangeQuery(String field, BinaryDocValuesRangeQuery.QueryType queryType, Object from, Object to, boolean includeFrom,
                                   boolean includeTo) {
@@ -208,6 +213,11 @@ public List<RangeFieldMapper.Range> decodeRanges(BytesRef bytes) {
             return LONG.decodeRanges(bytes);
         }
 
+        @Override
+        public Double doubleValue (Object endpointValue) {
+            return LONG.doubleValue(endpointValue);
+        }
+
         @Override
         public Query dvRangeQuery(String field, BinaryDocValuesRangeQuery.QueryType queryType, Object from, Object to, boolean includeFrom,
                                   boolean includeTo) {
@@ -274,6 +284,12 @@ public List<RangeFieldMapper.Range> decodeRanges(BytesRef bytes) {
             return BinaryRangeUtil.decodeFloatRanges(bytes);
         }
 
+        @Override
+        public Double doubleValue(Object endpointValue) {
+            assert endpointValue instanceof Float;
+            return ((Float) endpointValue).doubleValue();
+        }
+
         @Override
         public Query dvRangeQuery(String field, BinaryDocValuesRangeQuery.QueryType queryType, Object from, Object to, boolean includeFrom,
                                   boolean includeTo) {
@@ -339,6 +355,12 @@ public List<RangeFieldMapper.Range> decodeRanges(BytesRef bytes) {
             return BinaryRangeUtil.decodeDoubleRanges(bytes);
         }
 
+        @Override
+        public Double doubleValue(Object endpointValue) {
+            assert endpointValue instanceof Double;
+            return (Double)endpointValue;
+        }
+
         @Override
         public Query dvRangeQuery(String field, BinaryDocValuesRangeQuery.QueryType queryType, Object from, Object to, boolean includeFrom,
                                   boolean includeTo) {
@@ -407,6 +429,11 @@ public List<RangeFieldMapper.Range> decodeRanges(BytesRef bytes) {
             return LONG.decodeRanges(bytes);
         }
 
+        @Override
+        public Double doubleValue (Object endpointValue) {
+            return LONG.doubleValue(endpointValue);
+        }
+
         @Override
         public Query dvRangeQuery(String field, BinaryDocValuesRangeQuery.QueryType queryType, Object from, Object to, boolean includeFrom,
                                   boolean includeTo) {
@@ -461,6 +488,12 @@ public List<RangeFieldMapper.Range> decodeRanges(BytesRef bytes) {
             return BinaryRangeUtil.decodeLongRanges(bytes);
         }
 
+        @Override
+        public Double doubleValue(Object endpointValue) {
+            assert endpointValue instanceof Long;
+            return ((Long) endpointValue).doubleValue();
+        }
+
         @Override
         public Query dvRangeQuery(String field, BinaryDocValuesRangeQuery.QueryType queryType, Object from, Object to, boolean includeFrom,
                                   boolean includeTo) {
@@ -621,6 +654,19 @@ public Query rangeQuery(String field, boolean hasDocValues, Object from, Object
     public abstract BytesRef encodeRanges(Set<RangeFieldMapper.Range> ranges) throws IOException;
     public abstract List<RangeFieldMapper.Range> decodeRanges(BytesRef bytes);
 
+    /**
+     * Given the Range.to or Range.from Object value from a Range instance, converts that value into a Double.  Before converting, it
+     * asserts that the object is of the expected type.  Operation is not supported on IP ranges (because of loss of precision)
+     *
+     * @param endpointValue Object value for Range.to or Range.from
+     * @return endpointValue as a Double
+     */
+    public abstract Double doubleValue(Object endpointValue);
+
+    public boolean isNumeric() {
+        return numberType != null;
+    }
+
     public abstract Query dvRangeQuery(String field, BinaryDocValuesRangeQuery.QueryType queryType, Object from, Object to,
                                        boolean includeFrom, boolean includeTo);
 

server/src/main/java/org/elasticsearch/search/aggregations/bucket/histogram/HistogramAggregationBuilder.java

@@ -32,9 +32,7 @@
 import org.elasticsearch.search.aggregations.InternalOrder;
 import org.elasticsearch.search.aggregations.InternalOrder.CompoundOrder;
 import org.elasticsearch.search.aggregations.bucket.MultiBucketAggregationBuilder;
-import org.elasticsearch.search.aggregations.support.ValueType;
 import org.elasticsearch.search.aggregations.support.ValuesSource;
-import org.elasticsearch.search.aggregations.support.ValuesSource.Numeric;
 import org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder;
 import org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory;
 import org.elasticsearch.search.aggregations.support.ValuesSourceConfig;
@@ -48,9 +46,10 @@
 import java.util.Objects;
 
 /**
- * A builder for histograms on numeric fields.
+ * A builder for histograms on numeric fields.  This builder can operate on either base numeric fields, or numeric range fields.  IP range
+ * fields are unsupported, and will throw at the factory layer.
  */
-public class HistogramAggregationBuilder extends ValuesSourceAggregationBuilder<ValuesSource.Numeric, HistogramAggregationBuilder>
+public class HistogramAggregationBuilder extends ValuesSourceAggregationBuilder<ValuesSource, HistogramAggregationBuilder>
         implements MultiBucketAggregationBuilder {
     public static final String NAME = "histogram";
 
@@ -65,7 +64,7 @@ public class HistogramAggregationBuilder extends ValuesSourceAggregationBuilder<
     private static final ObjectParser<HistogramAggregationBuilder, Void> PARSER;
     static {
         PARSER = new ObjectParser<>(HistogramAggregationBuilder.NAME);
-        ValuesSourceParserHelper.declareNumericFields(PARSER, true, true, false);
+        ValuesSourceParserHelper.declareAnyFields(PARSER, true, true);
 
         PARSER.declareDouble(HistogramAggregationBuilder::interval, Histogram.INTERVAL_FIELD);
 
@@ -97,7 +96,7 @@ public static HistogramAggregationBuilder parse(String aggregationName, XContent
 
     /** Create a new builder with the given name. */
     public HistogramAggregationBuilder(String name) {
-        super(name, ValuesSourceType.NUMERIC, ValueType.DOUBLE);
+        super(name, ValuesSourceType.ANY, null);
     }
 
     protected HistogramAggregationBuilder(HistogramAggregationBuilder clone, Builder factoriesBuilder, Map<String, Object> metaData) {
@@ -118,7 +117,7 @@ protected AggregationBuilder shallowCopy(Builder factoriesBuilder, Map<String, O
 
     /** Read from a stream, for internal use only. */
     public HistogramAggregationBuilder(StreamInput in) throws IOException {
-        super(in, ValuesSourceType.NUMERIC, ValueType.DOUBLE);
+        super(in, ValuesSourceType.ANY);
         order = InternalOrder.Streams.readHistogramOrder(in);
         keyed = in.readBoolean();
         minDocCount = in.readVLong();
@@ -128,6 +127,11 @@ public HistogramAggregationBuilder(StreamInput in) throws IOException {
         maxBound = in.readDouble();
     }
 
+    @Override
+    protected boolean serializeTargetValueType() {
+        return true;
+    }
+
     @Override
     protected void innerWriteTo(StreamOutput out) throws IOException {
         InternalOrder.Streams.writeHistogramOrder(order, out);
@@ -295,7 +299,7 @@ public String getType() {
     }
 
     @Override
-    protected ValuesSourceAggregatorFactory<Numeric, ?> innerBuild(SearchContext context, ValuesSourceConfig<Numeric> config,
+    protected ValuesSourceAggregatorFactory<ValuesSource, ?> innerBuild(SearchContext context, ValuesSourceConfig<ValuesSource> config,
             AggregatorFactory<?> parent, Builder subFactoriesBuilder) throws IOException {
         return new HistogramAggregatorFactory(name, config, interval, offset, order, keyed, minDocCount, minBound, maxBound,
                 context, parent, subFactoriesBuilder, metaData);

server/src/main/java/org/elasticsearch/search/aggregations/bucket/histogram/HistogramAggregatorFactory.java

@@ -22,10 +22,9 @@
 import org.elasticsearch.search.aggregations.Aggregator;
 import org.elasticsearch.search.aggregations.AggregatorFactories;
 import org.elasticsearch.search.aggregations.AggregatorFactory;
-import org.elasticsearch.search.aggregations.pipeline.PipelineAggregator;
 import org.elasticsearch.search.aggregations.BucketOrder;
+import org.elasticsearch.search.aggregations.pipeline.PipelineAggregator;
 import org.elasticsearch.search.aggregations.support.ValuesSource;
-import org.elasticsearch.search.aggregations.support.ValuesSource.Numeric;
 import org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory;
 import org.elasticsearch.search.aggregations.support.ValuesSourceConfig;
 import org.elasticsearch.search.internal.SearchContext;
@@ -34,15 +33,19 @@
 import java.util.List;
 import java.util.Map;
 
-public final class HistogramAggregatorFactory extends ValuesSourceAggregatorFactory<ValuesSource.Numeric, HistogramAggregatorFactory> {
+/**
+ * Constructs the per-shard aggregator instance for histogram aggregation.  Selects the numeric or range field implementation based on the
+ * field type.
+ */
+public final class HistogramAggregatorFactory extends ValuesSourceAggregatorFactory<ValuesSource, HistogramAggregatorFactory> {
 
     private final double interval, offset;
     private final BucketOrder order;
     private final boolean keyed;
     private final long minDocCount;
     private final double minBound, maxBound;
 
-    public HistogramAggregatorFactory(String name, ValuesSourceConfig<Numeric> config, double interval, double offset,
+    public HistogramAggregatorFactory(String name, ValuesSourceConfig<ValuesSource> config, double interval, double offset,
             BucketOrder order, boolean keyed, long minDocCount, double minBound, double maxBound,
             SearchContext context, AggregatorFactory<?> parent,
             AggregatorFactories.Builder subFactoriesBuilder, Map<String, Object> metaData) throws IOException {
@@ -61,24 +64,35 @@ public long minDocCount() {
     }
 
     @Override
-    protected Aggregator doCreateInternal(ValuesSource.Numeric valuesSource, Aggregator parent, boolean collectsFromSingleBucket,
+    protected Aggregator doCreateInternal(ValuesSource valuesSource, Aggregator parent, boolean collectsFromSingleBucket,
             List<PipelineAggregator> pipelineAggregators, Map<String, Object> metaData) throws IOException {
         if (collectsFromSingleBucket == false) {
             return asMultiBucketAggregator(this, context, parent);
         }
-        return createAggregator(valuesSource, parent, pipelineAggregators, metaData);
-    }
-
-    private Aggregator createAggregator(ValuesSource.Numeric valuesSource, Aggregator parent, List<PipelineAggregator> pipelineAggregators,
-            Map<String, Object> metaData) throws IOException {
-
-        return new HistogramAggregator(name, factories, interval, offset, order, keyed, minDocCount, minBound, maxBound, valuesSource,
-                config.format(), context, parent, pipelineAggregators, metaData);
+        if (valuesSource instanceof ValuesSource.Numeric) {
+            return new NumericHistogramAggregator(name, factories, interval, offset, order, keyed, minDocCount, minBound, maxBound,
+                (ValuesSource.Numeric) valuesSource, config.format(), context, parent, pipelineAggregators, metaData);
+        }
+        else if (valuesSource instanceof ValuesSource.Bytes.FieldData.RangeFieldData) {
+            ValuesSource.Bytes.FieldData.RangeFieldData rangeValueSource = (ValuesSource.Bytes.FieldData.RangeFieldData) valuesSource;
+            if (rangeValueSource.rangeType().isNumeric() == false) {
+                throw new IllegalArgumentException("Expected numeric range type but found non-numeric range ["
+                    + rangeValueSource.rangeType().name + "]");
+            }
+            return new RangeHistogramAggregator(name, factories, interval, offset, order, keyed, minDocCount, minBound, maxBound,
+                (ValuesSource.Bytes.FieldData.RangeFieldData) valuesSource, config.format(), context, parent, pipelineAggregators,
+                metaData);
+        }
+        else {
+            throw new IllegalArgumentException("Expected one of [Numeric, RangeFieldData] values source, found ["
+                + valuesSource.toString() + "]");
+        }
     }
 
     @Override
     protected Aggregator createUnmapped(Aggregator parent, List<PipelineAggregator> pipelineAggregators, Map<String, Object> metaData)
             throws IOException {
-        return createAggregator(null, parent, pipelineAggregators, metaData);
+        return new NumericHistogramAggregator(name, factories, interval, offset, order, keyed, minDocCount, minBound, maxBound,
+            null, config.format(), context, parent, pipelineAggregators, metaData);
     }
 }

server/src/main/java/org/elasticsearch/search/aggregations/bucket/histogram/HistogramAggregator.java → server/src/main/java/org/elasticsearch/search/aggregations/bucket/histogram/NumericHistogramAggregator.java

@@ -52,7 +52,7 @@
  * written as {@code interval * x + offset} and yet is less than or equal to
  * {@code value}.
  */
-class HistogramAggregator extends BucketsAggregator {
+class NumericHistogramAggregator extends BucketsAggregator {
 
     private final ValuesSource.Numeric valuesSource;
     private final DocValueFormat formatter;
@@ -64,11 +64,11 @@ class HistogramAggregator extends BucketsAggregator {
 
     private final LongHash bucketOrds;
 
-    HistogramAggregator(String name, AggregatorFactories factories, double interval, double offset,
-            BucketOrder order, boolean keyed, long minDocCount, double minBound, double maxBound,
-            @Nullable ValuesSource.Numeric valuesSource, DocValueFormat formatter,
-            SearchContext context, Aggregator parent,
-            List<PipelineAggregator> pipelineAggregators, Map<String, Object> metaData) throws IOException {
+    NumericHistogramAggregator(String name, AggregatorFactories factories, double interval, double offset,
+                               BucketOrder order, boolean keyed, long minDocCount, double minBound, double maxBound,
+                               @Nullable ValuesSource.Numeric valuesSource, DocValueFormat formatter,
+                               SearchContext context, Aggregator parent,
+                               List<PipelineAggregator> pipelineAggregators, Map<String, Object> metaData) throws IOException {
 
         super(name, factories, context, parent, pipelineAggregators, metaData);
         if (interval <= 0) {