pointtestresult.java

spam source codejasen-0.9jASEN - java Anti Spam ENgine.zip 如标题所示

/*
 * @(#)PointTestResult.java	30/10/2004
 *
 * Copyright (c) 2004, 2005  jASEN.org
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the distribution.
 *
 *   3. The names of the authors may not be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 *   4. Any modification or additions to the software must be contributed back
 *      to the project.
 *
 *   5. Any investigation or reverse engineering of source code or binary to
 *      enable emails to bypass the filters, and hence inflict spam and or viruses
 *      onto users who use or do not use jASEN could subject the perpetrator to
 *      criminal and or civil liability.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JASEN.ORG,
 * OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jasen.core;

/**
 * <P>
 * 	Returned from a test when the test is intended to contribute to a total number of spam "points".
 * </P>
 * <P>
 * 	Once all point based tests are run for a single message, the ultimate probability for these
 * 	point tests is computed based on the points return and their corresponding weights
 * </P>
 * <p>
 * 	A point based test will accrue points during testing such that the higher the number of points scored,
 *  the greater the indication of spam.
 * </p>
 * <p>
 * 	A point based test may accrue any number of points such that the number of points is:<br><br>
 * 	0 <= points <= Integer.MAX_VALUE
 * </p>
 * @author Jason Polites
 * @see org.jasen.core.ProbabilityTestResult
 */
public class PointTestResult extends AbstractTestResult
{
    private int points = 0;
    private float min = 0.1f;
    private float max = 0.9f;
    private int threshold = 1;

    /**
     *
     */
    public PointTestResult() {
        super ();
    }

    /**
     * Constructs a new PointTestResult.
     * @param min The lowest possible probablity.
     * @param max The highest possible probablity.
     * @param threshold The threshold of points at which the max probability is returned.
     */
    public PointTestResult(float min, float max, int threshold) {
        super ();
        this.min = min;
        this.max = max;
        this.threshold = threshold;
    }

    /**
     * Gets the number of points scored for the test form which this result was returned.
     * @return
     */
    public int getPoints() {
        return points;
    }

    /**
     * Sets the number of points as a discrete value.  This value MUST be >= 0.
     * @param points
     */
    public void setPoints(int points) {
        this.points = points;
    }

    /**
     * Adds a point to the total number in the result.
     */
    public void addPoint() {
        points ++;
    }

    /**
     * Gets the max probablity allowed.
     * @return Returns the max.
     */
    public float getMax() {
        return max;
    }
    
    /**
     * Sets the max probablity allowed.
     * @param max The max to set.
     */
    public void setMax(float max) {
        this.max = max;
    }
    
    /**
     * Gets the min probablity allowed.
     * @return Returns the min.
     */
    public float getMin() {
        return min;
    }
    
    /**
     * Sets the max probablity allowed.
     * @param min The min to set.
     */
    public void setMin(float min) {
        this.min = min;
    }

    /**
     * Gets the number of point observations which imply max probability.
     * @return Returns the threshold.
     */
    public int getThreshold() {
        return threshold;
    }

    /**
     * Sets the number of point observations which imply max probability.
     * @param threshold The threshold to set.
     */
    public void setThreshold(int threshold) {
        this.threshold = threshold;
    }

    /*
     * (non-Javadoc)
     * @see org.jasen.interfaces.JasenTestResult#calculateProbability()
     */
    public float calculateProbability() {

        float prob = min;

        if(points > 0) {

            if(points > threshold) {
                prob = max;
            }
            else
            {
                prob = ((float)points / (float)threshold) * (max - min) + min;

                //prob = min + ((max - min / (float)threshold) * points);
            }
        }

        return prob;
    }
}