/**
 * 
 */
package at.gv.egiz.pdfas.exceptions;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import at.gv.egiz.pdfas.api.exceptions.PdfAsException;
import at.gv.egiz.pdfas.exceptions.external.ExternalErrorException;
import at.gv.egiz.pdfas.exceptions.pdf.CaptionNotFoundException;
import at.knowcenter.wag.egov.egiz.cfg.SettingsReader;
import at.knowcenter.wag.egov.egiz.exceptions.PlaceholderException;
import at.knowcenter.wag.egov.egiz.exceptions.SettingNotFoundException;
import at.knowcenter.wag.egov.egiz.exceptions.SettingsException;

/**
 * @author wprinz
 * 
 */
public class ErrorCodeHelper
{
  /**
   * The log.
   */
  private static final Log log = LogFactory.getLog(ErrorCodeHelper.class);

  public static String getMessageForErrorCode(int errorCode)
  {
    try
    {
      SettingsReader settings = SettingsReader.getInstance();
      String message = settings.getSetting("error.code." + errorCode);
      return message;
    }
    catch (SettingsException e)
    {
      log.warn(e.getMessage(), e);
    }
    catch (SettingNotFoundException e)
    {
      log.warn(e.getMessage(), e);
    }
    return null;
  }

  /**
   * Forms a speaking textual error message for the given PdfAsException.
   * 
   * @param e
   *          The PdfAsException to be formed into a speaking text.
   * @return Returns the speaking error message explaining the PdfAsException.
   */
  public static String formErrorMessage(PdfAsException e)
  {
    String message = "Fehler " + e.getErrorCode() + ":";

    if (e.getErrorCode() == ErrorCode.PLACEHOLDER_EXCEPTION)
    {
      PlaceholderException phe = null;
      if (e instanceof PlaceholderException)
      {
        phe = (PlaceholderException) e;
      }
      else
      {
        phe = (PlaceholderException) e.getCause();
      }

      message += " Der Platzhalter des Feldes " + phe.getField() + " ist um " + phe.getMissing() + " Bytes zu kurz.";
    }
    
    if (e.getErrorCode() == ErrorCode.CAPTION_NOT_FOUND_EXCEPTION)
    {
      CaptionNotFoundException cnfe = null;
      if (e instanceof CaptionNotFoundException)
      {
        cnfe = (CaptionNotFoundException)e;
      }
      else
      {
        cnfe = (CaptionNotFoundException)e.getCause();
      }
      
      message += " Die Überschrift (Caption/Label) \"" + cnfe.getCaption() + "\" wurde nicht wiedergefunden.";
    }

    message += " " + ErrorCodeHelper.getMessageForErrorCode(e.getErrorCode());

    if (e instanceof ExternalErrorException)
    {
      ExternalErrorException eee = (ExternalErrorException) e;
      message += " Externer Fehlergrund: " + eee.getExternalErrorCode() + ": " + eee.getExternalErrorMessage();
    }

    return message;
  }

}