AndValidator.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2013 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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 org.pentaho.di.job.entry.validator;

import java.util.List;

import org.pentaho.di.core.CheckResultInterface;
import org.pentaho.di.core.CheckResultSourceInterface;

/**
 * Boolean ANDs the results of all validators. If one validator fails, <code>false</code> is immediately returned. The
 * validators list (a <code>List<JobEntryValidator></code>) should be stored under the <code>KEY_VALIDATORS</code>
 * key.
 *
 * @author mlowery
 */
public class AndValidator implements JobEntryValidator {

  public static final AndValidator INSTANCE = new AndValidator();

  private static final String KEY_VALIDATORS = "validators";

  private static final String VALIDATOR_NAME = "and";

  public boolean validate( CheckResultSourceInterface source, String propertyName,
    List<CheckResultInterface> remarks, ValidatorContext context ) {
    // Object o = context.get(KEY_VALIDATORS);

    Object[] validators = (Object[]) context.get( KEY_VALIDATORS );
    for ( Object validator : validators ) {
      if ( !( (JobEntryValidator) validator ).validate( source, propertyName, remarks, context ) ) {
        // failure remarks have already been saved
        return false;
      }
    }
    JobEntryValidatorUtils.addOkRemark( source, propertyName, remarks );
    return true;
  }

  public String getName() {
    return VALIDATOR_NAME;
  }

  public String getKeyValidators() {
    return KEY_VALIDATORS;
  }

  /**
   * Uses varargs to conveniently add validators to the list of validators consumed by <code>AndValidator</code>. This
   * method creates and returns a new context.
   *
   * @see #putValidators(ValidatorContext, JobEntryValidator[])
   */
  public static ValidatorContext putValidators( JobEntryValidator... validators ) {
    ValidatorContext context = new ValidatorContext();
    context.put( AndValidator.KEY_VALIDATORS, validators );
    return context;
  }

  /**
   * Uses varargs to conveniently add validators to the list of validators consumed by <code>AndValidator</code>. This
   * method adds to an existing map.
   *
   * @see #putValidators(JobEntryValidator[])
   */
  public static void putValidators( ValidatorContext context, JobEntryValidator... validators ) {
    context.put( AndValidator.KEY_VALIDATORS, validators );
  }

}