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:
java.io.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 ofErrorDetail.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.
- Design file is not a valid xml file.
- See Also:
ErrorDetail, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDESIGN_EXCEPTION_INVALID_XMLOther exceptions thrown by SAX.static java.lang.StringDESIGN_EXCEPTION_SEMANTIC_ERRORThe semantic error, when element doesn't conform semantic check.static java.lang.StringDESIGN_EXCEPTION_SEMANTIC_WARNINGThe semantic warning, when element doesn't conform semantic check.static java.lang.StringDESIGN_EXCEPTION_SYNTAX_ERRORThe syntax error, when design file doesn't conform metadata definition.protected java.lang.ExceptioneException thrown by SAX.protected java.lang.StringfileNameThe file name with the error.-
Fields inherited from class org.eclipse.birt.report.model.api.ModelException
PLUGIN_ID
-
-
Constructor Summary
Constructors Constructor Description DesignFileException(java.lang.String fileName, java.lang.Exception e)Constructs aDesignFileExceptionwith the given design filename and the specified cause.DesignFileException(java.lang.String fileName, java.util.List<? extends java.lang.Exception> errList)Constructs aDesignFileExceptionwith the given design filename and a list of errors.DesignFileException(java.lang.String fileName, java.util.List<? extends java.lang.Exception> errList, java.lang.Exception ex)Constructs aDesignFileExceptionwith the given design filename, a list of errors and the new exception to add.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<ErrorDetail>getErrorList()Returns the error list.java.util.List<java.lang.Exception>getExceptionList()Returns the exception list.java.lang.StringgetFileName()Returns the design file name.java.lang.StringgetLocalizedMessage()java.lang.StringgetMessage()java.lang.StringtoString()Returns a string representation of the exception.-
Methods inherited from class org.eclipse.birt.core.exception.BirtException
getErrorCode, getLocalizedMessage, getPluginId, getSeverity, setSeverity
-
-
-
-
Field Detail
-
fileName
protected java.lang.String fileName
The file name with the error.
-
e
protected java.lang.Exception e
Exception thrown by SAX.
-
DESIGN_EXCEPTION_SYNTAX_ERROR
public static final java.lang.String DESIGN_EXCEPTION_SYNTAX_ERROR
The syntax error, when design file doesn't conform metadata definition.- See Also:
- Constant Field Values
-
DESIGN_EXCEPTION_SEMANTIC_ERROR
public static final java.lang.String DESIGN_EXCEPTION_SEMANTIC_ERROR
The semantic error, when element doesn't conform semantic check.- See Also:
- Constant Field Values
-
DESIGN_EXCEPTION_SEMANTIC_WARNING
public static final java.lang.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:
- Constant Field Values
-
DESIGN_EXCEPTION_INVALID_XML
public static final java.lang.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:
- Constant Field Values
-
-
Constructor Detail
-
DesignFileException
public DesignFileException(java.lang.String fileName, java.lang.Exception e)Constructs aDesignFileExceptionwith 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(java.lang.String fileName, java.util.List<? extends java.lang.Exception> errList)Constructs aDesignFileExceptionwith 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(java.lang.String fileName, java.util.List<? extends java.lang.Exception> errList, java.lang.Exception ex)Constructs aDesignFileExceptionwith 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 Detail
-
getErrorList
public java.util.List<ErrorDetail> getErrorList()
Returns the error list. Each item in the list is an instance ofErrorDetail.- Returns:
- the error list.
-
getExceptionList
public java.util.List<java.lang.Exception> getExceptionList()
Returns the exception list. Each item in the list is an instance ofException.- Returns:
- the exception list.
-
getFileName
public java.lang.String getFileName()
Returns the design file name.- Returns:
- the design file name.
-
getLocalizedMessage
public java.lang.String getLocalizedMessage()
- Overrides:
getLocalizedMessagein classorg.eclipse.birt.core.exception.BirtException
-
getMessage
public java.lang.String getMessage()
- Overrides:
getMessagein classorg.eclipse.birt.core.exception.BirtException
-
toString
public java.lang.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 theerrorListand assemble them into a string. The return string is assembled in the ways:
Note output message are locale independent. ONLY for debugging, not user-visible. Debugging messages are defined to be in English.Error Type Message SYNTAX_ERROR and INVALID_XML [errorType]- [numOfErrors] errors found.
1.) [detail messages.]
2.) [detail messages.]
...
SEMANTIC_ERROR Impossible to occur. - Overrides:
toStringin classjava.lang.Throwable- See Also:
Object.toString(),ErrorDetail.toString(),getLocalizedMessage()
-
-