org.apache.hadoop.hbase.rest.model.ColumnSchemaModel Maven / Gradle / Ivy

Go to download
/*
 *
 * 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.hadoop.hbase.rest.model;

import java.io.Serializable;
import java.util.LinkedHashMap;
import java.util.Map;

import javax.xml.bind.annotation.XmlAnyAttribute;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.namespace.QName;

import org.apache.hadoop.hbase.classification.InterfaceAudience;
import org.apache.hadoop.hbase.HColumnDescriptor;
import org.apache.hadoop.hbase.HConstants;
import org.codehaus.jackson.annotate.JsonAnyGetter;
import org.codehaus.jackson.annotate.JsonAnySetter;

/**
 * Representation of a column family schema.
 * 
 *  * <complexType name="ColumnSchema">
 *   <attribute name="name" type="string"></attribute>
 *   <anyAttribute></anyAttribute>
 * </complexType>
 * 
 */
@XmlRootElement(name="ColumnSchema")
@InterfaceAudience.Private
public class ColumnSchemaModel implements Serializable {
  private static final long serialVersionUID = 1L;
  private static QName BLOCKCACHE = new QName(HColumnDescriptor.BLOCKCACHE);
  private static QName BLOCKSIZE = new QName(HColumnDescriptor.BLOCKSIZE);
  private static QName BLOOMFILTER = new QName(HColumnDescriptor.BLOOMFILTER);
  private static QName COMPRESSION = new QName(HColumnDescriptor.COMPRESSION);
  private static QName IN_MEMORY = new QName(HConstants.IN_MEMORY);
  private static QName TTL = new QName(HColumnDescriptor.TTL);
  private static QName VERSIONS = new QName(HConstants.VERSIONS);

  private String name;
  private Map attrs = new LinkedHashMap();

  /**
   * Default constructor
   */
  public ColumnSchemaModel() {}

  /**
   * Add an attribute to the column family schema
   * @param name the attribute name
   * @param value the attribute value
   */
  @JsonAnySetter
  public void addAttribute(String name, Object value) {
    attrs.put(new QName(name), value);
  }

  /**
   * @param name the attribute name
   * @return the attribute value
   */
  public String getAttribute(String name) {
    Object o = attrs.get(new QName(name));
    return o != null ? o.toString(): null;
  }

  /**
   * @return the column name
   */
  @XmlAttribute
  public String getName() {
    return name;
  }

  /**
   * @return the map for holding unspecified (user) attributes
   */
  @XmlAnyAttribute
  @JsonAnyGetter
  public Map getAny() {
    return attrs;
  }

  /**
   * @param name the table name
   */
  public void setName(String name) {
    this.name = name;
  }

  /* (non-Javadoc)
   * @see java.lang.Object#toString()
   */
  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("{ NAME => '");
    sb.append(name);
    sb.append('\'');
    for (Map.Entry e: attrs.entrySet()) {
      sb.append(", ");
      sb.append(e.getKey().getLocalPart());
      sb.append(" => '");
      sb.append(e.getValue().toString());
      sb.append('\'');
    }
    sb.append(" }");
    return sb.toString();
  }

  // getters and setters for common schema attributes

  // cannot be standard bean type getters and setters, otherwise this would
  // confuse JAXB

  /**
   * @return true if the BLOCKCACHE attribute is present and true
   */
  public boolean __getBlockcache() {
    Object o = attrs.get(BLOCKCACHE);
    return o != null ? 
      Boolean.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_BLOCKCACHE;
  }

  /**
   * @return the value of the BLOCKSIZE attribute or its default if it is unset
   */
  public int __getBlocksize() {
    Object o = attrs.get(BLOCKSIZE);
    return o != null ? 
      Integer.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_BLOCKSIZE;
  }

  /**
   * @return the value of the BLOOMFILTER attribute or its default if unset
   */
  public String __getBloomfilter() {
    Object o = attrs.get(BLOOMFILTER);
    return o != null ? o.toString() : HColumnDescriptor.DEFAULT_BLOOMFILTER;
  }

  /**
   * @return the value of the COMPRESSION attribute or its default if unset
   */
  public String __getCompression() {
    Object o = attrs.get(COMPRESSION);
    return o != null ? o.toString() : HColumnDescriptor.DEFAULT_COMPRESSION;
  }

  /**
   * @return true if the IN_MEMORY attribute is present and true
   */
  public boolean __getInMemory() {
    Object o = attrs.get(IN_MEMORY);
    return o != null ? 
      Boolean.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_IN_MEMORY;
  }

  /**
   * @return the value of the TTL attribute or its default if it is unset
   */
  public int __getTTL() {
    Object o = attrs.get(TTL);
    return o != null ? 
      Integer.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_TTL;
  }

  /**
   * @return the value of the VERSIONS attribute or its default if it is unset
   */
  public int __getVersions() {
    Object o = attrs.get(VERSIONS);
    return o != null ? 
      Integer.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_VERSIONS;
  }

  /**
   * @param value the desired value of the BLOCKSIZE attribute
   */
  public void __setBlocksize(int value) {
    attrs.put(BLOCKSIZE, Integer.toString(value));
  }

  /**
   * @param value the desired value of the BLOCKCACHE attribute
   */
  public void __setBlockcache(boolean value) {
    attrs.put(BLOCKCACHE, Boolean.toString(value));
  }

  public void __setBloomfilter(String value) {
    attrs.put(BLOOMFILTER, value);
  }

  /**
   * @param value the desired value of the COMPRESSION attribute
   */
  public void __setCompression(String value) {
    attrs.put(COMPRESSION, value); 
  }

  /**
   * @param value the desired value of the IN_MEMORY attribute
   */
  public void __setInMemory(boolean value) {
    attrs.put(IN_MEMORY, Boolean.toString(value));
  }

  /**
   * @param value the desired value of the TTL attribute
   */
  public void __setTTL(int value) {
    attrs.put(TTL, Integer.toString(value));
  }

  /**
   * @param value the desired value of the VERSIONS attribute
   */
  public void __setVersions(int value) {
    attrs.put(VERSIONS, Integer.toString(value));
  }
}