standardscanresult.java

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

/*
 * @(#)StandardScanResult.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;

import org.jasen.interfaces.JasenScanResult;

/**
 * <P>
 * 	Captures the information relating to the results of a  scan.  Namely the probability that the message is a spam email
 * </P>
 * @author Jason Polites
 */
public class StandardScanResult implements JasenScanResult
{
    private double probability;
    private String extractedText;

    private String[][] testResults;

    private boolean parseError = false;

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

    /* (non-Javadoc)
     * @see org.jasen.interfaces.JasenScanResult#getProbability()
     */
    public double getProbability() {
        return probability;
    }

    /**
     * Sets the probability value to return from this result
     * @param probability A value between 0.0 and 1.0
     */
    public void setProbability(double probability) {
        this.probability = probability;
    }

    /**
     * Gets the plain text extracted from the HTML after it was parsed
     * @return The plain text as a String
     */
    public String getExtractedText() {
        return extractedText;
    }

    /**
     * Sets the plain text extracted from the HTML after it was parsed
     * @param extractedText The plain text as a String
     */
    public void setExtractedText(String extractedText) {
        this.extractedText = extractedText;
    }

   /*
    *  (non-Javadoc)
    * @see org.jasen.interfaces.JasenScanResult#getTestResults()
    */
    public String[][] getTestResults() {
        return testResults;
    }
    
    /**
     * Sets the list of test results for debugging
     * @param testResults The testResults to set.
     */
    public void setTestResults(String[][] testResults) {
        this.testResults = testResults;
    }

    /**
     * Tells us if there was an error whilst parsing the message
     * @return true if the message could not be parsed, false otherwise
     */
    public boolean isParseError() {
        return parseError;
    }

    /**
     * Flags the message as having a parse error during parsing
     * @param parseError true if the message could not be parsed, false otherwise
     */
    public void setParseError(boolean parseError) {
        this.parseError = parseError;
    }

   /*
    * (non-Javadoc)
    * @see org.jasen.interfaces.JasenScanResult#completed()
    */
    public boolean completed() {
        return !parseError;
    }
}