com.arakelian.elastic.model.search.RangeQuery Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.arakelian.elastic.model.search;

import org.immutables.value.Value;

import com.arakelian.core.feature.Nullable;
import com.arakelian.elastic.model.enums.ShapeRelation;
import com.arakelian.elastic.search.QueryVisitor;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.google.common.base.Preconditions;

/**
 * @see Range
 *      Query
 */
@Value.Immutable(copy = false)
@JsonSerialize(as = ImmutableRangeQuery.class)
@JsonDeserialize(builder = ImmutableRangeQuery.Builder.class)
@JsonTypeName(Query.RANGE_QUERY)
@Value.Style(from = "using", get = { "is*", "get*" }, depluralize = true)
public interface RangeQuery extends StandardQuery {
    @Value.Check
    public default void checkType() {
        final Object lower = getLower();
        final Object upper = getUpper();
        if (lower == null || upper == null) {
            return;
        }
        Preconditions.checkState(lower.getClass().isInstance(upper) || upper.getClass().isInstance(lower));
    }

    public String getFieldName();

    @JsonProperty("from")
    @Nullable
    public Object getLower();

    @Nullable
    public ShapeRelation getRelation();

    @JsonProperty("to")
    @Nullable
    public Object getUpper();

    @Value.Default
    public default boolean isIncludeLower() {
        return true;
    }

    @Value.Default
    public default boolean isIncludeUpper() {
        return true;
    }

    @Override
    default void accept(final QueryVisitor visitor) {
        if (!visitor.enter(this)) {
            return;
        }
        try {
            if (visitor.enterRangeQuery(this)) {
                visitor.leaveRangeQuery(this);
            }
        } finally {
            visitor.leave(this);
        }
    }

    @Override
    default boolean isEmpty() {
        return getLower() == null && getUpper() == null;
    }
}