com.cinchapi.concourse.lang.sort.OrderComponent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of concourse-driver-java Show documentation

Concourse is a self-tuning database that is designed for both ad hoc analytics and high volume transactions at scale. Developers use Concourse to quickly build mission critical software while also benefiting from real time insight into their most important data. With Concourse, end-to-end data management requires no extra infrastructure, no prior configuration and no additional coding–all of which greatly reduce costs and allow developers to focus on core business problems.

There is a newer version: 0.11.2

Show newest version

/*
 * Copyright (c) 2013-2019 Cinchapi Inc.
 *
 * 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.cinchapi.concourse.lang.sort;

import java.util.Objects;

import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import com.cinchapi.concourse.Timestamp;

/**
 * An {@link OrderComponent} describes a consideration for ordering a result
 * set.
 *
 * @author Jeff Nelson
 */
@Immutable
public class OrderComponent {

    /**
     * The order key.
     */
    private final String key;

    /**
     * The order timestamp.
     */
    @Nullable
    private final Timestamp timestamp;

    /**
     * The order direction
     */
    private final Direction direction;

    /**
     * Construct a new instance.
     * 
     * @param key
     * @param direction
     */
    public OrderComponent(String key, Direction direction) {
        this(key, null, direction);
    }

    /**
     * Construct a new instance.
     * 
     * @param key
     * @param timestamp
     * @param direction
     */
    public OrderComponent(String key, @Nullable Timestamp timestamp,
            Direction direction) {
        this.key = key;
        this.timestamp = timestamp;
        this.direction = direction;
    }

    /**
     * Return the order direction.
     * 
     * @return the direction
     */
    public Direction direction() {
        return direction;
    }

    public boolean equals(Object obj) {
        if(obj instanceof OrderComponent) {
            return Objects.equals(key, ((OrderComponent) obj).key())
                    && Objects.equals(direction,
                            ((OrderComponent) obj).direction())
                    && Objects.equals(timestamp,
                            ((OrderComponent) obj).timestamp());
        }
        else {
            return false;
        }

    }

    @Override
    public int hashCode() {
        return Objects.hash(key, timestamp, direction);
    }

    /**
     * Return the order key.
     * 
     * @return the key
     */
    public String key() {
        return key;
    }

    /**
     * Return the order timestamp.
     * 
     * @return the timestamp
     */
    @Nullable
    public Timestamp timestamp() {
        return timestamp;
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append(key);
        if(timestamp != null) {
            sb.append(" at ").append(timestamp);
        }
        sb.append(" ").append(direction);
        return sb.toString();
    }

}