com.marklogic.samplestack.dbclient.DateFacetBuilder.java Source code

Introduction

Here is the source code for com.marklogic.samplestack.dbclient.DateFacetBuilder.java

Source

/*
 * Copyright 2012-2015 MarkLogic Corporation
 *
 * 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 com.marklogic.samplestack.dbclient;

import org.joda.time.DateTime;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;

/**
 * A builder for date buckets, to make dynamically-generated
 * time-series histograms.
 * 
 * For EA-3 this DateFacetBuilder is only used to construct facets by Month.
 * 
 * {constraint:{
 *   name:name,
 *   type:xs:dateTime,
 *   facet:true,
 *   bucket:[
 *   ]
 *   }
 */
public class DateFacetBuilder {

    /** This interval is used for calculations to make buckets */
    public enum BucketInterval {
        BY_DAY, BY_WEEK, BY_MONTH;

        /** returns (approximate) the bucket duration in milliseconds */
        public long bucketDuration() {
            if (this == BY_DAY) {
                return 1000 * 60 * 60 * 24;
            } else if (this == BY_WEEK) {
                return 1000 * 60 * 60 * 24 * 7;
            } else {
                // by month
                return 1000 * 60 * 60 * 24 * 30;
            }
        }
    };

    private ObjectNode facetNode;
    private ObjectNode constraintNode;
    private ArrayNode bucketNode;

    public DateFacetBuilder(ObjectMapper mapper) {
        this.facetNode = mapper.createObjectNode();
        this.constraintNode = facetNode.putObject("constraint");
        ObjectNode rangeNode = this.constraintNode.putObject("range");
        rangeNode.put("type", "xs:dateTime");
        rangeNode.put("facet", true);
        rangeNode.put("json-property", "lastActivityDate");
        rangeNode.put("facet-option", "empties");
        this.bucketNode = rangeNode.putArray("bucket");
    }

    private DateFacetBuilder name(String name) {
        this.constraintNode.put("name", name);
        return this;
    }

    /**
     * This attribute produces invalid options markup.  It is removed from the payload and used in search response decoration.
     */
    private DateFacetBuilder period(String period) {
        this.facetNode.put("period", period);
        return this;
    }

    private DateFacetBuilder bucket(DateTime ge, DateTime lt) {
        ObjectNode thisBucket = this.bucketNode.addObject();
        thisBucket.put("ge", ge.toString());
        thisBucket.put("lt", lt.toString());
        thisBucket.put("name", ge.toString());
        thisBucket.put("label", ge.toString());
        return this;
    }

    public static ObjectNode dateFacet(DateTime min, DateTime max) {
        DateFacetBuilder fb = new DateFacetBuilder(new CustomObjectMapper());
        fb.name("date");
        /*
        long interval = max.getMillis() - min.getMillis();
        if (interval / BucketInterval.BY_DAY.bucketDuration() < 40) {
           fb.period("DAY");
           DateTime bucketStart = min.minus(min.getMillisOfDay());
           while (bucketStart.isBefore(max)) {
        DateTime bucketEnd = bucketStart.plusDays(1);
        fb.bucket(bucketStart, bucketEnd);
        bucketStart = bucketStart.plusDays(1);
           }
        }
        else if (interval / BucketInterval.BY_WEEK.bucketDuration() < 40) {
           fb.period("WEEK");
           DateTime bucketStart = min.minusDays(min.getDayOfWeek()).minus(min.getMillisOfDay());
           while (bucketStart.isBefore(max)) {
        DateTime bucketEnd = bucketStart.plusWeeks(1);
        fb.bucket(bucketStart, bucketEnd);
        bucketStart = bucketStart.plusWeeks(1);
           }
        } else {
        */
        // for 8.0-1 we are only doing facets by month
        fb.period("MONTH");
        DateTime bucketStart = min.minusDays(min.getDayOfMonth() - 1).minus(min.getMillisOfDay());
        bucketStart = new DateTime(bucketStart);
        while (bucketStart.isBefore(max)) {
            DateTime bucketEnd = bucketStart.plusMonths(1);
            fb.bucket(bucketStart, bucketEnd);
            bucketStart = bucketStart.plusMonths(1);
        }
        // }
        return fb.facetNode;
    }

}