jasenmapstore.java

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

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

import org.jasen.core.engine.JasenMap;
import org.jasen.error.JasenException;

/**
 * <P>
 * 	The map store is responsible for loading and saving the JasenMap created during training.
 * </P>
 * <p>
 * 	Any map store can be used, however it is important to note that the map store is only loaded <em>ONCE</em>
 * </p>
 * <p>
 * 	This means that changes to the map store cannot occur after the engine has been initialised.
 * </p>
 * <p>
 * 	However, the auto update engine allows for the dynamic installation of updated map stores during live operation
 * </p>
 * <p>
 * 	It is recommended that regular updates to the JasenMap in use by the engine be made to ensure the engine has
 *  an up-to-date and accurate reference to common spam content at that time.
 * </p>
 * @author Jason Polites
 */
public interface JasenMapStore
{
    /**
     * Saves the map.
     * @param map
     * @param properties Any properties required by the store to save the map
     * @throws JasenException
     */
    public void save(JasenMap map, Object properties) throws JasenException;

    /**
     * Loads the map.
     * @return The loaded map containing word probabilities
     * @param properties Any properties required by the store to load the map
     * @throws JasenException
     */
    public JasenMap load(Object properties) throws JasenException;
}