001package org.biopax.paxtools.model.level3;
002
003
004/**
005 * <b>Definition:</b> A score associated with a publication reference describing how the score was
006 * determined, the name of the method and a comment briefly describing the method.
007 *
008 * <b>Usage:</b>  The xref must contain at least one publication that describes the method used to
009 * determine the score value. There is currently no standard way of describing  values, so any
010 * string is valid.
011 *
012 * <b>Examples:</b> The statistical significance of a result, e.g. "p&lt;0.05".
013 */
014public interface Score extends UtilityClass, XReferrable
015{
016
017        /**
018         * This property defines the value of the score. This can be a numerical or categorical value.
019         *
020         * @return Numerical or categorical value of the score
021         */
022        public String getValue();
023
024        /**
025         * This property defines the value of the score. This can be a numerical or categorical value.
026         *
027         * @param value Numerical or categorical value of the score
028         */
029        public void setValue(String value);
030
031        /**
032         * This property defines the source of the scoring methodology.
033         *
034         * @return A publication or web site describing the scoring methodology and the range of values.
035         */
036        public Provenance getScoreSource();
037
038        /**
039         * This property defines the source of the scoring methodology.
040         *
041         * @param scoreSource publication or web site describing the scoring methodology and the range of
042         *                    values.
043         */
044        public void setScoreSource(Provenance scoreSource);
045}