RowLevelPolicy.java

/*
 * 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 gobblin.qualitychecker.row;

import java.io.Closeable;
import java.io.IOException;

import gobblin.configuration.ConfigurationKeys;
import gobblin.configuration.State;
import gobblin.util.FinalState;


/**
 * A policy that operates on each row
 * and executes a given check
 * @author stakiar
 */
public abstract class RowLevelPolicy implements Closeable, FinalState {
  protected final State state;
  private final Type type;

  public enum Type {
    FAIL, // Fail if the test does not pass
    ERR_FILE, // Write record to error file
    OPTIONAL // The test is optional
  }

  public enum Result {
    PASSED, // The test passed
    FAILED // The test failed
  }

  public RowLevelPolicy(State state, RowLevelPolicy.Type type) {
    this.state = state;
    this.type = type;
  }

  @Override
  public void close() throws IOException {}

  public State getTaskState() {
    return this.state;
  }

  public Type getType() {
    return this.type;
  }

  public String getErrFileLocation() {
    return this.state.getProp(ConfigurationKeys.ROW_LEVEL_ERR_FILE);
  }

  public abstract Result executePolicy(Object record);

  @Override
  public String toString() {
    return this.getClass().getName();
  }

  /**
   * Get final state for this object. By default this returns an empty {@link gobblin.configuration.State}, but
   * concrete subclasses can add information that will be added to the task state.
   * @return Empty {@link gobblin.configuration.State}.
   */
  @Override
  public State getFinalState() {
    return new State();
  }
}