io.fluo.api.config.ScannerConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fluo-api Show documentation

This module contains all API code. External dependencies should be limited. Any changes to public methods should be avoided. While the API module does not have compile time dependency on fluo-core, you must include fluo-core as a run-time dependency.

The newest version!

/*
 * Copyright 2014 Fluo authors (see AUTHORS)
 * 
 * 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 io.fluo.api.config;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import com.google.common.base.Preconditions;
import io.fluo.api.client.SnapshotBase;
import io.fluo.api.data.Bytes;
import io.fluo.api.data.Column;
import io.fluo.api.data.Span;

/**
 * Contains configuration for a {@link io.fluo.api.client.Snapshot} scanner. Passed to
 * {@link SnapshotBase#get(ScannerConfiguration)}.
 */
public class ScannerConfiguration implements Cloneable {

  private Span span = new Span();
  private Set columns = new HashSet<>();

  /**
   * Sets {@link Span} for ScannerConfiguration
   */
  public ScannerConfiguration setSpan(Span span) {
    Preconditions.checkNotNull(span);
    this.span = span;
    return this;
  }

  /**
   * Retrieves {@link Span} for ScannerConfiguration
   */
  public Span getSpan() {
    return span;
  }

  /**
   * List of all {@link Column}s that scanner will retrieve
   */
  public Set getColumns() {
    return Collections.unmodifiableSet(columns);
  }

  /**
   * Configures scanner to retrieve column with the given family
   */
  public ScannerConfiguration fetchColumnFamily(Bytes fam) {
    Preconditions.checkNotNull(fam);
    columns.add(new Column(fam));
    return this;
  }

  /**
   * Configures scanner to retrieve column with the given family and qualifier
   */
  public ScannerConfiguration fetchColumn(Bytes fam, Bytes qual) {
    Preconditions.checkNotNull(fam, qual);
    columns.add(new Column(fam, qual));
    return this;
  }

  /**
   * Clears all fetched column settings
   */
  public void clearColumns() {
    columns.clear();
  }

  @Override
  @SuppressWarnings("unchecked")
  public Object clone() throws CloneNotSupportedException {
    ScannerConfiguration sc = (ScannerConfiguration) super.clone();

    sc.columns = (Set) ((HashSet) columns).clone();
    sc.span = span;

    return sc;
  }
}