processing/src/main/java/org/apache/druid/segment/IndexableAdapter.java

/*
 * 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 org.apache.druid.segment;

import com.google.errorprone.annotations.MustBeClosed;
import org.apache.druid.segment.column.ColumnCapabilities;
import org.apache.druid.segment.data.BitmapValues;
import org.apache.druid.segment.data.CloseableIndexed;
import org.joda.time.Interval;

import javax.annotation.Nullable;
import java.util.List;

/**
 * An adapter to an index
 */
public interface IndexableAdapter
{
  Interval getDataInterval();

  int getNumRows();

  List<String> getDimensionNames();

  List<String> getMetricNames();

  @MustBeClosed
  @Nullable
  <T extends Comparable<? super T>> CloseableIndexed<T> getDimValueLookup(String dimension);

  TransformableRowIterator getRows();

  BitmapValues getBitmapValues(String dimension, int dictId);

  String getMetricType(String metric);

  ColumnCapabilities getCapabilities(String column);

  Metadata getMetadata();
}