com.yahoo.bard.webservice.metadata.SegmentInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fili-core Show documentation
Fili web service library provides core capabilities for RESTful aggregation navigation, query planning and metadata
There is a newer version: 1.1.13
// Copyright 2017 Yahoo Inc.
// Licensed under the terms of the Apache license. Please see LICENSE.md file distributed with this work for terms.
package com.yahoo.bard.webservice.metadata;

import com.yahoo.bard.webservice.druid.model.metadata.NumberedShardSpec;

import org.joda.time.Interval;

import io.druid.timeline.DataSegment;
import io.druid.timeline.partition.NoneShardSpec;
import io.druid.timeline.partition.ShardSpec;

import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * A class that holds the useful information of a partition of a druid segment in bard.
 */
public class SegmentInfo {
    private final String dataSource;
    private final Interval interval;
    private final List dimensions;
    private final List metrics;
    private final String version;
    private final NumberedShardSpec shardSpec;
    private final long size;
    private final String identifier;

    /**
     * Given a druid data segment constructs an object to hold the information of this partition.
     *
     * @param segment  The druid data segments that corresponds to a specific partition of a druid segment.
     */
    public SegmentInfo(DataSegment segment) {
        this.dataSource = segment.getDataSource();
        this.interval = segment.getInterval();
        this.dimensions = segment.getDimensions();
        this.metrics = segment.getMetrics();
        this.version = segment.getVersion();
        ShardSpec spec = segment.getShardSpec();
        this.shardSpec = spec instanceof NumberedShardSpec ?
                (NumberedShardSpec) spec :
                new NumberedShardSpec((NoneShardSpec) spec);
        this.size = segment.getSize();
        this.identifier = segment.getIdentifier();
    }

    /**
     * Getter for the datasource of this segment partition.
     *
     * @return The datasource.
     */
    public String getDataSource() {
        return dataSource;
    }

    /**
     * Getter for the interval that this segment partition is referring to.
     *
     * @return The interval.
     */
    public Interval getInterval() {
        return interval;
    }

    /**
     * Getter for the dimensions in this segment.
     *
     * @return The list of dimension names
     */
    public List getDimensions() {
        return dimensions;
    }

    /**
     * Getter for the metrics in this segment.
     *
     * @return The list of metric names
     */
    public List getMetrics() {
        return metrics;
    }

    /**
     * Getter for list of dimension and metric names.
     *
     * @return The list of dimension and metric names
     */
    public List getColumnNames() {
        return Stream.concat(
                getDimensions().stream(),
                getMetrics().stream()
        ).collect(Collectors.toList());
    }

    /**
     * Getter for the version of this segment partition.
     *
     * @return The version.
     */
    public String getVersion() {
        return version;
    }

    /**
     * Getter for the shard spec of this segment partition.
     *
     * @return The shard spec.
     */
    public NumberedShardSpec getShardSpec() {
        return shardSpec;
    }

    /**
     * Getter for the size of this segment partition.
     *
     * @return The shard spec.
     */
    public long getSize() {
        return size;
    }

    /**
     * Getter for the identifier of this segment partition.
     *
     * @return The identifier.
     */
    public String getIdentifier() {
        return identifier;
    }

    @Override
    public String toString() {
        return getIdentifier();
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) { return true; }
        if (!(o instanceof SegmentInfo)) { return false; }

        final SegmentInfo that = (SegmentInfo) o;

        return
                size == that.size &&
                Objects.equals(identifier, that.identifier);
    }

    @Override
    public int hashCode() {
        return Objects.hash(size, identifier);
    }
}