Class DesignFileException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.report.model.api.ModelException
org.eclipse.birt.report.model.api.DesignFileException
All Implemented Interfaces:
Serializable

public class DesignFileException extends ModelException
Signals that a fatal error occurred when opening a design file. It includes the error list. Each item in the list is an instance of ErrorDetail.

Four types of error are defined:

Design file is not found. INVALID_XML
Design file is not a valid xml file. SYNTAX_ERROR
Design file has something conflicting MetaData definition. SEMANTIC_ERROR
Design file is opened with semantic error.
See Also:
  • Field Details

    • fileName

      protected String fileName
      The file name with the error.
    • e

      protected Exception e
      Exception thrown by SAX.
    • DESIGN_EXCEPTION_SYNTAX_ERROR

      public static final String DESIGN_EXCEPTION_SYNTAX_ERROR
      The syntax error, when design file doesn't conform metadata definition.
      See Also:
    • DESIGN_EXCEPTION_SEMANTIC_ERROR

      public static final String DESIGN_EXCEPTION_SEMANTIC_ERROR
      The semantic error, when element doesn't conform semantic check.
      See Also:
    • DESIGN_EXCEPTION_SEMANTIC_WARNING

      public static final String DESIGN_EXCEPTION_SEMANTIC_WARNING
      The semantic warning, when element doesn't conform semantic check. However, the level of this error is warning.
      See Also:
    • DESIGN_EXCEPTION_INVALID_XML

      public static final String DESIGN_EXCEPTION_INVALID_XML
      Other exceptions thrown by SAX. Generally, it's caused when design file is not a valid xml file.
      See Also:
  • Constructor Details

    • DesignFileException

      public DesignFileException(String fileName, Exception e)
      Constructs a DesignFileException with the given design filename and the specified cause. It is for the exception thrown by SAX.
      Parameters:
      fileName - design file name.
      e - exception to wrap.
    • DesignFileException

      public DesignFileException(String fileName, List<? extends Exception> errList)
      Constructs a DesignFileException with the given design filename and a list of errors. Used when syntax error is found when parsing.
      Parameters:
      fileName - design file name.
      errList - exception list, each of them is the syntax error.
    • DesignFileException

      public DesignFileException(String fileName, List<? extends Exception> errList, Exception ex)
      Constructs a DesignFileException with the given design filename, a list of errors and the new exception to add. Used when syntax error is found when parsing.
      Parameters:
      fileName - design file name.
      errList - exception list, each of which is the syntax error.
      ex - the exception to add
  • Method Details

    • getErrorList

      public List<ErrorDetail> getErrorList()
      Returns the error list. Each item in the list is an instance of ErrorDetail.
      Returns:
      the error list.
    • getExceptionList

      public List<Exception> getExceptionList()
      Returns the exception list. Each item in the list is an instance of Exception.
      Returns:
      the exception list.
    • getFileName

      public String getFileName()
      Returns the design file name.
      Returns:
      the design file name.
    • getLocalizedMessage

      public String getLocalizedMessage()
      Overrides:
      getLocalizedMessage in class org.eclipse.birt.core.exception.BirtException
    • getMessage

      public String getMessage()
      Overrides:
      getMessage in class org.eclipse.birt.core.exception.BirtException
    • toString

      public String toString()
      Returns a string representation of the exception. If the exception type is SYNTAX_ERROR or INVALID_XML, this method checks all errors in the errorList and assemble them into a string. The return string is assembled in the ways:
      Error Type Message
      SYNTAX_ERROR and INVALID_XML [errorType]- [numOfErrors] errors found.
      1.) [detail messages.]
      2.) [detail messages.]
      ...
      SEMANTIC_ERROR Impossible to occur.
      Note output message are locale independent. ONLY for debugging, not user-visible. Debugging messages are defined to be in English.
      Overrides:
      toString in class Throwable
      See Also: