jasentoken.java

来自「spam source codejasen-0.9jASEN - java An」· Java 代码 · 共 113 行

/*
 * @(#)JasenToken.java	3/11/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.engine;

import java.io.Serializable;

/**
 * <P>
 * 	A "token" is essentially a word.  Tokens are stored inside the JasenMap and have various counts associated
 * </P>
 *
 * @author Jason Polites
 */
public class JasenToken implements Serializable
{
    static final long serialVersionUID = -5467086125915806103L;

    private int spamCount = 0;
    private int hamCount = 0;

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



    /**
     * Returns the number of times this token was discovered in a Ham email
     * @return Returns the hamCount.
     */
    public int getHamCount() {
        return hamCount;
    }

    /**
     * Sets the number of times this token was discovered in a Ham email
     * @param hamCount The hamCount to set.
     */
    public void setHamCount(int hamCount) {
        this.hamCount = hamCount;
    }

    /**
     * Returns the number of times this token was discovered in a Spam email
     * @return Returns the spamCount.
     */
    public int getSpamCount() {
        return spamCount;
    }

    /**
     * Sets the number of times this token was discovered in a Spam email
     * @param spamCount The spamCount to set.
     */
    public void setSpamCount(int spamCount) {
        this.spamCount = spamCount;
    }

    /**
     * Conventience method to increment the ham count by 1
     */
    public void incrementHam() {
        hamCount++;
    }
    
    /**
     * Conventience method to increment the spam count by 1
     */
    public void incrementSpam() {
        spamCount++;
    }
}