IdentificationAlgorithmParameter.java

package com.compomics.util.experiment.identification.identification_parameters;

import com.compomics.util.experiment.identification.Advocate;
import java.io.Serializable;

/**
 * Interface for the algorithm specific parameters.
 *
 * @author Marc Vaudel
 */
public interface IdentificationAlgorithmParameter extends Serializable {

    /**
     * Returns the identification algorithm.
     *
     * @return the identification algorithm
     */
    public Advocate getAlgorithm();

    /**
     * Indicates whether another identificationAlgorithmParameter has the same
     * parameters.
     *
     * @param identificationAlgorithmParameter the other
     * identificationAlgorithmParameter
     *
     * @return true if the algorithm and parameters are the same
     */
    public boolean equals(IdentificationAlgorithmParameter identificationAlgorithmParameter);

    /**
     * Returns the parameters as a string.
     *
     * @param html use HTML formatting
     * @return the parameters as a string
     */
    public String toString(boolean html);
}