/*
 * @(#)FilterException.java    1.0  18 February 2001
 *
 * Copyright 2004
 * College of Computer and Information Science
 * Northeastern University
 * Boston, MA  02115
 *
 * The Java Power Tools software may be used for educational
 * purposes as long as this copyright notice is retained intact
 * at the top of all source files.
 *
 * To discuss possible commercial use of this software, 
 * contact Richard Rasala at Northeastern University, 
 * College of Computer and Information Science,
 * 617-373-2462 or rasala@ccs.neu.edu.
 *
 * The Java Power Tools software has been designed and built
 * in collaboration with Viera Proulx and Jeff Raab.
 *
 * Should this software be modified, the words "Modified from 
 * Original" must be included as a comment below this notice.
 *
 * All publication rights are retained.  This software or its 
 * documentation may not be published in any media either
 * in whole or in part without explicit permission.
 *
 * This software was created with support from Northeastern 
 * University and from NSF grant DUE-9950829.
 */

package edu.neu.ccs.filter;

import edu.neu.ccs.*;

/**
 * <P>Exception to be thrown by a filter
 * when the object to be filtered
 * does not meet the criteria for the filter.</P>
 *
 * @author  Jeff Raab
 * @version 2.2
 * @since   1.0
 */
public class FilterException extends Exception {

    /** 
     * The <CODE>Stringable</CODE> object that failed 
     * the filtering process, with its state set to the value
     * that was current at the time the exception was thrown.
     */
    protected Stringable obj = null;

    /**
     * Constructs a filter exception 
     * with the given model and no detail messsage.
     *
     * @param model the data model that failed the filter process
     * @see #FilterException(Stringable, String)
     */
    public FilterException(Stringable model) {
        this(model, null);
    }
    
    /**
     * Constructs a filter exception 
     * with the given model and detail messsage.
     *
     * @param model the data model that failed the filter process
     * @param message the error message for this exception
     * @see #FilterException(Stringable)
     */
    public FilterException(Stringable model, String message) {
        super(message);
        obj = model;
    }
    
    /**
     * Returns the model object that failed the filtering process
     * with its state set to the value that was current
     * at the time the exception was thrown.
     */
    public Stringable getModel() {
        return obj;
    }
}