org.apache.fluo.api.data.Column 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 for Apache Fluo. 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.
There is a newer version: 2.0.0
Show newest version
/*
 * 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.fluo.api.data;

import java.io.Serializable;
import java.util.Objects;

/**
 * Represents all or a subset of the column family, column qualifier, and column visibility fields.
 * A column with no fields set is represented by Column.EMPTY. Column is immutable after it is
 * created.
 *
 * @since 1.0.0
 */
public final class Column implements Comparable, Serializable {

  private static final long serialVersionUID = 1L;
  private static final Bytes UNSET = Bytes.of(new byte[0]);

  private Bytes family = UNSET;
  private Bytes qualifier = UNSET;
  private Bytes visibility = UNSET;

  public static final Column EMPTY = new Column();

  /**
   * Creates an empty Column where family, qualifier and visibility are not set
   */
  public Column() {}

  /**
   * Creates Column with only a family.
   */
  public Column(Bytes family) {
    Objects.requireNonNull(family, "Family must not be null");
    this.family = family;
  }

  /**
   * Creates Column with only a family. String parameter will be encoded as UTF-8.
   */
  public Column(CharSequence family) {
    this(Bytes.of(family));
  }

  /**
   * Creates Column with a family and qualifier.
   */
  public Column(Bytes family, Bytes qualifier) {
    Objects.requireNonNull(family, "Family must not be null");
    Objects.requireNonNull(qualifier, "Qualifier must not be null");
    this.family = family;
    this.qualifier = qualifier;
  }

  /**
   * Creates Column with a family and qualifier. String parameters will be encoded as UTF-8.
   */
  public Column(CharSequence family, CharSequence qualifier) {
    this(Bytes.of(family), Bytes.of(qualifier));
  }

  /**
   * Creates Column with family, qualifier, and visibility
   */
  public Column(Bytes family, Bytes qualifier, Bytes visibility) {
    Objects.requireNonNull(family, "Family must not be null");
    Objects.requireNonNull(qualifier, "Qualifier must not be null");
    Objects.requireNonNull(visibility, "Visibility must not be null");
    this.family = family;
    this.qualifier = qualifier;
    this.visibility = visibility;
  }

  /**
   * Creates Column with family, qualifier, and visibility. String parameters will be encoded as
   * UTF-8.
   */
  public Column(CharSequence family, CharSequence qualifier, CharSequence visibility) {
    this(Bytes.of(family), Bytes.of(qualifier), Bytes.of(visibility));
  }

  /**
   * Returns true if family is set
   */
  public boolean isFamilySet() {
    return family != UNSET;
  }

  /**
   * Retrieves Column Family (in Bytes). Returns Bytes.EMPTY if not set.
   */
  public Bytes getFamily() {
    if (!isFamilySet()) {
      return Bytes.EMPTY;
    }
    return family;
  }

  /**
   * Get the column family as a string using UTF-8 encoding.
   */
  public String getsFamily() {
    return getFamily().toString();
  }

  /**
   * Returns true if qualifier is set
   */
  public boolean isQualifierSet() {
    return qualifier != UNSET;
  }

  /**
   * Retrieves Column Qualifier (in Bytes). Returns Bytes.EMPTY if not set.
   */
  public Bytes getQualifier() {
    if (!isQualifierSet()) {
      return Bytes.EMPTY;
    }
    return qualifier;
  }

  /**
   * Get the column family as a string using UTF-8 encoding.
   */
  public String getsQualifier() {
    return getQualifier().toString();
  }

  /**
   * Returns true if visibility is set.
   */
  public boolean isVisibilitySet() {
    return visibility != UNSET;
  }

  /**
   * Retrieves Column Visibility (in Bytes). Returns Bytes.EMPTY if not set.
   */
  public Bytes getVisibility() {
    if (!isVisibilitySet()) {
      return Bytes.EMPTY;
    }
    return visibility;
  }

  /**
   * Get the column visibility as a string using UTF-8 encoding.
   */
  public String getsVisibility() {
    return getVisibility().toString();
  }

  @Override
  public String toString() {
    return family + " " + qualifier + " " + visibility;
  }

  @Override
  public int hashCode() {
    return Objects.hash(family, qualifier, visibility);
  }

  @Override
  public int compareTo(Column other) {
    int result = family.compareTo(other.family);
    if (result == 0) {
      result = qualifier.compareTo(other.qualifier);
      if (result == 0) {
        result = visibility.compareTo(other.visibility);
      }
    }
    return result;
  }

  @Override
  public boolean equals(Object o) {
    if (o instanceof Column) {
      Column oc = (Column) o;
      return family.equals(oc.getFamily()) && qualifier.equals(oc.getQualifier())
          && visibility.equals(oc.getVisibility());
    }
    return false;
  }
}