IndicatorVariable.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.indicator;
 
import java.io.Serializable;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import org.turro.string.Strings;
 
public class IndicatorVariable implements Serializable {
 
  private final String root, name;
  private final boolean preprocess, reversed;
  private final VariableType type;
  private final Set<String> avoid;
 
  public IndicatorVariable(String root, String name, boolean preprocess, VariableType type) {
    this(root, name, preprocess, type, false, null);
  }
 
  public IndicatorVariable(String root, String name, boolean preprocess, VariableType type, boolean reversed) {
    this(root, name, preprocess, type, reversed, null);
  }
 
  public IndicatorVariable(String root, String name, boolean preprocess, VariableType type, String avoid) {
    this(root, name, preprocess, type, false, avoid);
  }
 
  public IndicatorVariable(String root, String name, boolean preprocess, VariableType type, boolean reversed, String avoid) {
    this.root = root;
    this.name = name;
    this.preprocess = preprocess;
    this.type = type;
    this.reversed = reversed;
    this.avoid = Strings.isBlank(avoid) ? null : new HashSet<>(Strings.csvToList(avoid));
  }
 
  @Override
  public String toString() {
    return getFullName();
  }
 
  public String getFullName() {
    return root + ":" + getName();
  }
  
  public String getRoot() {
    return root;
  }
 
  public String getName() {
    return name;
  }
 
  public boolean isPreprocess() {
    return preprocess;
  }
 
  public VariableType getType() {
    return type;
  }
 
  public boolean isReversed() {
    return reversed;
  }
 
  public Set<String> getAvoid() {
    return avoid;
  }
 
  public boolean permits(String root) {
    return avoid == null || !avoid.contains(root);
  }
 
  public long getMissingValue() {
    return isReversed() ? Long.MAX_VALUE : 0;
  }
  
  public static IndicatorVariable result(String root, VariableType type) {
    return new IndicatorVariable(root, "*", false, type);
  }
 
  @Override
  public int hashCode() {
    int hash = 3;
    hash = 97 * hash + Objects.hashCode(this.root);
    hash = 97 * hash + Objects.hashCode(this.name);
    hash = 97 * hash + (this.preprocess ? 1 : 0);
    hash = 97 * hash + Objects.hashCode(this.type);
    return hash;
  }
 
  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final IndicatorVariable other = (IndicatorVariable) obj;
    if (this.preprocess != other.preprocess) {
      return false;
    }
    if (!Objects.equals(this.root, other.root)) {
      return false;
    }
    if (!Objects.equals(this.name, other.name)) {
      return false;
    }
    if (this.type != other.type) {
      return false;
    }
    return true;
  }
 
}