/**
 * Copyright (C) 2014-2016 LinkedIn Corp. (pinot-core@linkedin.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.linkedin.pinot.common.utils;

import com.linkedin.pinot.common.response.ProcessingException;
import java.io.IOException;
import java.util.Map;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;


/**
 * Data table is used to transfer data from server to broker.
 */
public interface DataTable {
  String EXCEPTION_METADATA_KEY = "Exception";
  String NUM_DOCS_SCANNED_METADATA_KEY = "numDocsScanned";
  String NUM_ENTRIES_SCANNED_IN_FILTER_METADATA_KEY = "numEntriesScannedInFilter";
  String NUM_ENTRIES_SCANNED_POST_FILTER_METADATA_KEY = "numEntriesScannedPostFilter";
  String TOTAL_DOCS_METADATA_KEY = "totalDocs";
  String TIME_USED_MS_METADATA_KEY = "timeUsedMs";
  String TRACE_INFO_METADATA_KEY = "traceInfo";
  String REQUEST_ID_METADATA_KEY = "requestId";

  void addException(@Nonnull ProcessingException processingException);

  @Nonnull
  byte[] toBytes()
      throws IOException;

  @Nonnull
  Map<String, String> getMetadata();

  @Nullable
  DataSchema getDataSchema();

  int getNumberOfRows();

  boolean getBoolean(int rowId, int colId);

  char getChar(int rowId, int colId);

  byte getByte(int rowId, int colId);

  short getShort(int rowId, int colId);

  int getInt(int rowId, int colId);

  long getLong(int rowId, int colId);

  float getFloat(int rowId, int colId);

  double getDouble(int rowId, int colId);

  @Nonnull
  String getString(int rowId, int colId);

  @Nonnull
  <T> T getObject(int rowId, int colId);

  @Nonnull
  byte[] getByteArray(int rowId, int colId);

  @Nonnull
  char[] getCharArray(int rowId, int colId);

  @Nonnull
  short[] getShortArray(int rowId, int colId);

  @Nonnull
  int[] getIntArray(int rowId, int colId);

  @Nonnull
  long[] getLongArray(int rowId, int colId);

  @Nonnull
  float[] getFloatArray(int rowId, int colId);

  @Nonnull
  double[] getDoubleArray(int rowId, int colId);

  @Nonnull
  String[] getStringArray(int rowId, int colId);
}