org.jgap.supergenes.Validator Maven / Gradle / Ivy

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

net.sf.jgap

The newest version!

/*
 * This file is part of JGAP.
 *
 * JGAP offers a dual license model containing the LGPL as well as the MPL.
 *
 * For licensing information please see the file license.txt included with JGAP
 * or have a look at the top of class org.jgap.Chromosome which representatively
 * includes the JGAP license policy applicable for any file delivered with JGAP.
 */
package org.jgap.supergenes;

import org.jgap.*;

/**
 * The abstract supergeneValidator, hiding the getPersisten()
 * and setFromPersistent() methods that are not always required.
 *
 * @author Audrius Meskauskas
 * @since 2.0
 */
public abstract class Validator
    implements SupergeneValidator {
  /** String containing the CVS revision. Read out via reflection!*/
  private final static String CVS_REVISION = "$Revision: 1.9 $";

  private transient Configuration m_conf;

  public Validator(Configuration a_conf) {
    m_conf = a_conf;
  }

  /** {@inheritDoc} */
  public abstract boolean isValid(Gene[] a_genes, Supergene a_for_supergene);

  /** {@inheritDoc}
   * The default implementation returns an empty string. */
  public String getPersistent() {
    return "";
  }

  /** {@inheritDoc}
   * The default implementation does nothing. */
  public void setFromPersistent(final String a_from) {
  }

  /**
   * @return the configuration used
   *
   * @author Klaus Meffert
   * @since 3.0
   */
  public Configuration getConfiguration() {
    return m_conf;
  }
}