io.cdap.delta.api.assessment.Problem Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of delta-api Show documentation
There is a newer version: 0.9.0
/*
 * Copyright © 2020 Cask Data, Inc.
 *
 * 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.cdap.delta.api.assessment;

import java.util.Objects;

/**
 * An assessment about some type of entity.
 */
public class Problem {
  private final String name;
  private final String description;
  private final String suggestion;
  private final String impact;
  private final Severity severity;
  private final String table;
  private final String column;


  public Problem(String name, String description, String suggestion, String impact) {
    this(name, description, suggestion, impact, Severity.ERROR);
  }
  public Problem(String name, String description, String suggestion, String impact, Severity severity) {
    this(name, description, suggestion, impact, severity, null, null);
  }

  public Problem(String name, String description, String suggestion, String impact, Severity severity, String table,
                 String column) {
    this.name = name;
    this.description = description;
    this.suggestion = suggestion;
    this.impact = impact;
    this.severity = severity;
    this.table = table;
    this.column = column;
  }


  /**
   * @return name of the entity that is being assessed
   */
  public String getName() {
    return name;
  }

  /**
   * @return description of what might be wrong
   */
  public String getDescription() {
    return description;
  }

  /**
   * @return suggestion for what to do next to fix the potential problem
   */
  public String getSuggestion() {
    return suggestion;
  }

  /**
   * @return impact of the potential problem
   */
  public String getImpact() {
    return impact;
  }

  /**
   * @return severity of the potential problem
   */
  public Severity getSeverity() {
    return severity;
  }

  /**
   * @return the table name if the error is at a table level
   */
  public String getTable() {
    return table;
  }

  /**
   * @return the column name if the error is at a table + column level
   */
  public String getColumn() {
    return column;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Problem that = (Problem) o;
    return Objects.equals(name, that.name) &&
      Objects.equals(description, that.description) &&
      Objects.equals(suggestion, that.suggestion) &&
      Objects.equals(impact, that.impact) &&
      Objects.equals(severity, that.severity) &&
      Objects.equals(table, that.table) &&
      Objects.equals(column, that.column);
  }

  @Override
  public int hashCode() {
    return Objects.hash(name, description, suggestion, impact, severity, table, column);
  }

  /**
   * The severity of the problem
   */
  public enum Severity {
    ERROR,
    WARNING
  }
}