VariableBean.java

/*
 * Copyright (c) 2017 OBiBa. All rights reserved.
 *
 * This program and the accompanying materials
 * are made available under the terms of the GNU Public License v3.0.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.obiba.magma;

import java.io.Serializable;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;

import javax.annotation.Nullable;
import javax.validation.constraints.NotNull;

import com.google.common.base.Function;
import com.google.common.base.Objects;
import com.google.common.collect.LinkedListMultimap;
import com.google.common.collect.ListMultimap;
import com.google.common.collect.Maps;

public class VariableBean extends AbstractAttributeAware implements Variable, Serializable {

  private static final long serialVersionUID = 1L;

  LinkedListMultimap<String, Attribute> attributes = LinkedListMultimap.create();

  String name;

  String entityType;

  String mimeType;

  String unit;

  ValueType valueType;

  String referencedEntityType;

  boolean repeatable;

  int index = 0;

  /**
   * Use a linked hash set to keep insertion order
   */
  @SuppressWarnings({ "CollectionDeclaredAsConcreteClass", "TypeMayBeWeakened" })
  @edu.umd.cs.findbugs.annotations.SuppressWarnings("SE_BAD_FIELD")
  final LinkedHashSet<Category> categories = new LinkedHashSet<>();

  String occurrenceGroup;

  transient Map<Value, Category> categoriesAsValue;

  @Override
  public String getName() {
    return name;
  }

  @Override
  public String getEntityType() {
    return entityType;
  }

  @Override
  public boolean isForEntityType(String type) {
    return getEntityType().equals(type);
  }

  @Override
  public String getMimeType() {
    return mimeType;
  }

  @Override
  public String getUnit() {
    return unit;
  }

  @Override
  public ValueType getValueType() {
    return valueType;
  }

  @Override
  public String getReferencedEntityType() {
    return referencedEntityType;
  }

  @Override
  public boolean isRepeatable() {
    return repeatable;
  }

  @Override
  public String getOccurrenceGroup() {
    return occurrenceGroup;
  }

  @Override
  public int getIndex() {
    return index;
  }

  @Override
  public Set<Category> getCategories() {
    return Collections.unmodifiableSet(categories);
  }

  @Nullable
  @Override
  public Category getCategory(String categoryName) {
    for(Category category : categories) {
      if(Objects.equal(category.getName(), categoryName)) {
        return category;
      }
    }
    return null;
  }

  @Override
  public boolean hasCategories() {
    return categories.size() > 0;
  }

  @Override
  protected ListMultimap<String, Attribute> getInstanceAttributes() {
    return attributes;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Variable other = (Variable) o;
    return Objects.equal(name, other.getName()) && Objects.equal(valueType, other.getValueType()) &&
        repeatable == other.isRepeatable() && Objects.equal(entityType, other.getEntityType());
  }

  @Override
  public int hashCode() {
    return Objects.hashCode(name, valueType, repeatable, entityType);
  }

  @Override
  public boolean isMissingValue(Value value) {
    if(value.isNull() || !hasCategories()) {
      return value.isNull();
    }
    Category c = categoryAsValue().get(value);
    return c != null && c.isMissing();
  }

  private Map<Value, Category> categoryAsValue() {
    if(categoriesAsValue == null) {
      categoriesAsValue = Maps.uniqueIndex(categories, new Function<Category, Value>() {

        @Override
        public Value apply(Category input) {
          return getValueType().valueOf(input.getName());
        }
      });
    }
    return categoriesAsValue;
  }

  @Override
  public boolean areAllCategoriesMissing() {
    for(Category category : getCategories()) {
      if(!category.isMissing()) return false;
    }
    return true;
  }

  @Override
  public String getVariableReference(@NotNull ValueTable table) {
    return Variable.Reference.getReference(table, this);
  }

  @Override
  public String toString() {
    return Objects.toStringHelper(this).add("name", name).add("valueType", valueType).add("repeatable", repeatable)
        .add("entityType", entityType).toString();
  }
}