test/src/main/java/org/apache/accumulo/test/HardListIterator.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.accumulo.test;

import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.SortedMap;
import java.util.TreeMap;

import org.apache.accumulo.core.data.ByteSequence;
import org.apache.accumulo.core.data.Key;
import org.apache.accumulo.core.data.PartialKey;
import org.apache.accumulo.core.data.Range;
import org.apache.accumulo.core.data.Value;
import org.apache.accumulo.core.iterators.IteratorEnvironment;
import org.apache.accumulo.core.iterators.IteratorUtil;
import org.apache.accumulo.core.iterators.SortedKeyValueIterator;
import org.apache.accumulo.core.util.PeekingIterator;
import org.apache.hadoop.io.Text;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A wrapper making a list of hardcoded data into a SKVI. For testing.
 */
public class HardListIterator implements SortedKeyValueIterator<Key,Value> {
  private static final Logger log = LoggerFactory.getLogger(HardListIterator.class);
  public static final SortedMap<Key,Value> allEntriesToInject;
  static {
    SortedMap<Key,Value> t = new TreeMap<>();
    t.put(new Key(new Text("a1"), new Text("colF3"), new Text("colQ3"), System.currentTimeMillis()),
        new Value("1"));
    t.put(new Key(new Text("c1"), new Text("colF3"), new Text("colQ3"), System.currentTimeMillis()),
        new Value("1"));
    t.put(new Key(new Text("m1"), new Text("colF3"), new Text("colQ3"), System.currentTimeMillis()),
        new Value("1"));
    allEntriesToInject = Collections.unmodifiableSortedMap(t); // for safety
  }

  private PeekingIterator<Map.Entry<Key,Value>> inner;
  private Range seekRng;

  @Override
  public void init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options,
      IteratorEnvironment env) {
    if (source != null) {
      log.info("HardListIterator ignores/replaces parent source passed in init(): {}", source);
    }

    IteratorUtil.IteratorScope scope = env.getIteratorScope();
    log.debug("{}: init on scope {}{}", this.getClass(), scope,
        scope == IteratorUtil.IteratorScope.majc ? " fullScan=" + env.isFullMajorCompaction() : "");

    // define behavior before seek as seek to start at negative infinity
    inner = new PeekingIterator<>(allEntriesToInject.entrySet().iterator());
  }

  @Override
  public SortedKeyValueIterator<Key,Value> deepCopy(IteratorEnvironment env) {
    HardListIterator newInstance;
    try {
      newInstance = HardListIterator.class.getDeclaredConstructor().newInstance();
    } catch (Exception e) {
      throw new RuntimeException(e);
    }
    newInstance.inner = new PeekingIterator<>(
        allEntriesToInject.tailMap(inner.peek().getKey()).entrySet().iterator());

    return newInstance;
  }

  @Override
  public boolean hasTop() {
    if (!inner.hasNext()) {
      return false;
    }
    Key k = inner.peek().getKey();
    return seekRng.contains(k); // do not return entries past the seek() range
  }

  @Override
  public void next() {
    inner.next();
  }

  @Override
  public void seek(Range range, Collection<ByteSequence> columnFamilies, boolean inclusive) {
    seekRng = range;
    // seek to first entry inside range
    if (range.isInfiniteStartKey()) {
      inner = new PeekingIterator<>(allEntriesToInject.entrySet().iterator());
    } else if (range.isStartKeyInclusive()) {
      inner = new PeekingIterator<>(
          allEntriesToInject.tailMap(range.getStartKey()).entrySet().iterator());
    } else {
      inner = new PeekingIterator<>(allEntriesToInject
          .tailMap(range.getStartKey().followingKey(PartialKey.ROW_COLFAM_COLQUAL_COLVIS_TIME))
          .entrySet().iterator());
    }
  }

  @Override
  public Key getTopKey() {
    return hasTop() ? inner.peek().getKey() : null;
  }

  @Override
  public Value getTopValue() {
    return hasTop() ? inner.peek().getValue() : null;
  }
}