com.stratio.cassandra.lucene.search.condition.builder.DateRangeConditionBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-lucene-index-plugin Show documentation
Cassandra Lucene Index plugin
The newest version!
/*
 * Copyright (C) 2014 Stratio (http://stratio.com)
 *
 * 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.stratio.cassandra.lucene.search.condition.builder;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.stratio.cassandra.lucene.search.condition.DateRangeCondition;

/**
 * {@link ConditionBuilder} for building a new {@link DateRangeCondition}.
 *
 * @author Andres de la Pena {@literal }
 */
public class DateRangeConditionBuilder extends ConditionBuilder {

    /** The name of the field to be matched. */
    @JsonProperty("field")
    private final String field;

    /** The lower accepted date. Maybe null meaning no lower limit. */
    @JsonProperty("from")
    private Object from;

    /** The upper accepted date. Maybe null meaning no upper limit. */
    @JsonProperty("to")
    private Object to;

    /** The spatial operation to be performed. */
    @JsonProperty("operation")
    private String operation;

    /**
     * Returns a new {@link DateRangeConditionBuilder} with the specified field reference point.
     *
     * @param field the name of the field to be matched
     */
    @JsonCreator
    public DateRangeConditionBuilder(@JsonProperty("field") String field) {
        this.field = field;
    }

    /**
     * Sets the lower accepted date. Maybe null meaning no lower limit.
     *
     * @param from the lower accepted date, or {@code null} if there is no lower limit
     * @return this with the specified lower limit
     */
    public DateRangeConditionBuilder from(Object from) {
        this.from = from;
        return this;
    }

    /**
     * Sets the upper accepted date. Maybe null meaning no lower limit.
     *
     * @param to the upper accepted date, or {@code null} if there is no upper limit
     * @return this with the specified upper limit
     */
    public DateRangeConditionBuilder to(Object to) {
        this.to = to;
        return this;
    }

    /**
     * Sets the operation to be performed. Possible values are {@code intersects}, {@code is_within} and {@code
     * contains}. Defaults to {@code intersects}.
     *
     * @param operation the operation
     * @return This.
     */
    public DateRangeConditionBuilder operation(String operation) {
        this.operation = operation;
        return this;
    }

    /**
     * Returns the {@link DateRangeCondition} represented by this builder.
     *
     * @return a new date range condition
     */
    @Override
    public DateRangeCondition build() {
        return new DateRangeCondition(boost, field, from, to, operation);
    }
}