package ecologylab.serialization;

import java.util.List;
import java.util.ArrayList;
import ecologylab.generic.Debug;
import ecologylab.net.ParsedURL;

/**
 * There are certain rules one has to follow while using this framework for
 * translation from Java to XML and back. This exception class enforces those
 * rules on the user. So, if the user fails to follow any of the rule, this
 * exception is thrown with appropriate error message encapsulated in it. This
 * exception is thrown in the following conditions:
 * <ul>
 * <li> If the user is translating a class which has some Collection type object
 * in it (e.g Vector, Hashtable)and the class does not overrides the methods
 * <code>getCollection()</code> and <code>addElement()</code> inherited from
 * <code>ElementState.</code> </li>
 * <li> If the user is translating a class which has some Collection type object
 * in it and the collection does not contain items of objects derived from
 * <code>ElementState</code> type. </li>
 * <li> The classes to be translated does not provide a constructor with zero
 * arguments. In this case the exception is thrown only when the user is
 * building Java classes from xml. </li>
 * <li> The class to be translated does not provide setter method for setting
 * the values of the primitive type variables which are translated. In this case
 * the exception is thrown only when the user is building Java classes from xml.
 * </li>
 * </ul>
 * 
 * @author Andruid Kerne
 * @author Madhur Khandelwal
 * @version 0.5
 */

public class SIMPLTranslationException extends Exception implements
        XMLTranslationExceptionTypes
{
    private static final long serialVersionUID = -8326348358064487418L;

    private int               exceptionType    = 0;

	private ArrayList<SimplIssue> simplIssues;

	private ArrayList<Exception> childExceptions;

    public SIMPLTranslationException()
    {
        super();
    	this.simplIssues = new ArrayList<SimplIssue>();
        this.childExceptions = new ArrayList<Exception>();
    }

    public SIMPLTranslationException(SimplIssue si)
    {
    	this();
    	this.simplIssues.add(si);
    }

    
    public SIMPLTranslationException(String msg)
    {
        super(msg);

    	this.simplIssues = new ArrayList<SimplIssue>();
        childExceptions = new ArrayList<Exception>();
    }

    public SIMPLTranslationException(String msg, Exception e)
    {
        super("XmlTranslationException\n" + msg + "\n\tThe error is "
                + e.toString() + " in" + "\n\t" + e.getStackTrace()[0] + "\n\t"
                + e.getStackTrace()[1] + "\n\t" + e.getStackTrace()[2] + "\n\t"
                + e.getStackTrace()[3] + "\n\t");
    }

    public SIMPLTranslationException(int exceptionType)
    {
        super();

        this.exceptionType = exceptionType;
    }

    public SIMPLTranslationException(String msg, int exceptionType)
    {
        this(msg);

        this.exceptionType = exceptionType;
    }

    public SIMPLTranslationException(String msg, Exception e, int exceptionType)
    {
        this(msg, e);

        this.exceptionType = exceptionType;
    }

    /**
     * Returns the type of exception that generated the XmlTranslationException.
     * These can be referenced from the interface XmlTranslationExceptionTypes.
     * 
     * @return
     */
    public int getExceptionType()
    {
        return exceptionType;
    }
    
    public void printTraceOrMessage(Debug that, String msg, ParsedURL purl)
    {
    	switch (getExceptionType())
    	{
    	case FILE_NOT_FOUND:
        	String purlMsg	= (purl == null) ? "" : purl.toString();
			that.warning("File not found - " + msg + " - "+purlMsg);
    		break;
    	case NULL_PURL:
			Debug.weird(that, "\tCan't open " + msg + " - ParsedURL is null");
   		break;
    	default:
    		this.printStackTrace();
    		break;
    	}
    }

    public Object remnant;
	public void setRemnantObject(Object result) {
		// TODO Auto-generated method stub
		this.remnant = result;
	}

}