org.opentripplanner.netex.index.api.HMapValidationRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of application Show documentation

The newest version!

package org.opentripplanner.netex.index.api;

import org.opentripplanner.graph_builder.issue.api.DataImportIssue;

/**
 * This interface is used to make validation rules which can be passed to a hierarchical map. The
 * rule is applied to all local elements. Depending on the validation status on of 3 actions is
 * performed for each element in the map:
 * 
 *   
 *     OK - nothing is done
 *   
 *   
 *     WARN - A warning message is passed on to the log message consumer.
 *   
 *   
 *     DISCARD - The key/value pair is removed from the local map, and a waring is passed on to
 *     the log message consumer.
 *   
 * 
 */
public interface HMapValidationRule {
  /**
   * Validate and return status, the caller will take the appropriate acction according to  the
   * retuned status.
   */
  Status validate(V value);

  /**
   * The rule should provide a log message to use if the validation fails.
   */
  DataImportIssue logMessage(K key, V value);

  enum Status {
    /** Element is OK. */
    OK,
    /** Log warning */
    WARN,
    /** Log warning and remove element from HierarchicalMap. */
    DISCARD,
  }
}