/*
 * 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.phoenix.schema.tuple;

import java.util.List;
import org.apache.hadoop.hbase.Cell;
import org.apache.hadoop.hbase.KeyValue;
import org.apache.hadoop.hbase.io.ImmutableBytesWritable;
import org.apache.phoenix.hbase.index.util.GenericKeyValueBuilder;
import org.apache.phoenix.util.PhoenixKeyValueUtil;

/**
 * Tuple that can be used to represent a list of cells. It is imperative that the list of cells
 * passed in are sorted using the {@link KeyValue#COMPARATOR} otherwise doing binary search to find
 * a particular cell will fail.
 */
public class MultiKeyValueTuple extends BaseTuple {
  private List<Cell> values;

  public MultiKeyValueTuple(List<Cell> values) {
    setKeyValues(values);
  }

  public MultiKeyValueTuple() {
  }

  /** Caller must not modify the list that is passed here */
  @Override
  public void setKeyValues(List<Cell> values) {
    this.values = values;
  }

  @Override
  public void getKey(ImmutableBytesWritable ptr) {
    Cell value = values.get(0);
    ptr.set(value.getRowArray(), value.getRowOffset(), value.getRowLength());
  }

  @Override
  public boolean isImmutable() {
    return true;
  }

  @Override
  public Cell getValue(byte[] family, byte[] qualifier) {
    return PhoenixKeyValueUtil.getColumnLatest(GenericKeyValueBuilder.INSTANCE, values, family,
      qualifier);
  }

  @Override
  public String toString() {
    return values.toString();
  }

  @Override
  public int size() {
    return values.size();
  }

  @Override
  public Cell getValue(int index) {
    return values.get(index);
  }

  @Override
  public boolean getValue(byte[] family, byte[] qualifier, ImmutableBytesWritable ptr) {
    Cell kv = getValue(family, qualifier);
    if (kv == null) return false;
    ptr.set(kv.getValueArray(), kv.getValueOffset(), kv.getValueLength());
    return true;
  }

  @Override
  public long getSerializedSize() {
    if (values == null || values.isEmpty()) {
      return 0;
    }
    long totalSize = 0;
    for (Cell cell : values) {
      totalSize += cell.getSerializedSize();
    }
    return totalSize;
  }
}
