001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021package org.biojava.bio.dp;
022
023import org.biojava.bio.BioException;
024
025/**
026 * Flags an object as being able to register itself with a model trainer.
027 *
028 * @author Matthew Pocock
029 */
030public interface Trainable {
031  /**
032   * Perform any registration that is necessary with mt.
033   * <p>
034   * This may include registering handlers for transition or emission counts,
035   * or registering other Trainable objects with the ModelTrainer.
036   *
037   * @param mt  the ModelTrainer that encapsulates the training environment
038   */
039  public void registerWithTrainer(ModelTrainer mt)
040  throws BioException;
041}