org.eclipse.birt.report.model.api.elements
Class SemanticError

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.eclipse.birt.core.exception.BirtException
              extended by org.eclipse.birt.report.model.api.ModelException
                  extended by org.eclipse.birt.report.model.api.activity.SemanticException
                      extended by org.eclipse.birt.report.model.api.elements.SemanticError
All Implemented Interfaces:
java.io.Serializable

public class SemanticError
extends SemanticException

The class provides the error code and the element with semantic error. The semantic error has two levels: error and warning. The default level is error.

See Also:
Serialized Form

Field Summary
static java.lang.String DESIGN_EXCEPTION_AT_LEAST_ONE_COLUMN
          Error code indicating the result set has no result set column.
static java.lang.String DESIGN_EXCEPTION_CANNOT_SPECIFY_PAGE_SIZE
          Error code indicating page size can not be specified if page type is not custom.
static java.lang.String DESIGN_EXCEPTION_CIRCULAR_ELEMENT_REFERNECE
          The element reference would create a cycle: a extends b extends a.
static java.lang.String DESIGN_EXCEPTION_COLUMN_COPY_FORBIDDEN
          Error code indicating to copy one column is forbidden.
static java.lang.String DESIGN_EXCEPTION_COLUMN_INSERT_FORBIDDEN
          Error code indicating to insert one column is forbidden.
static java.lang.String DESIGN_EXCEPTION_COLUMN_PASTE_DIFFERENT_LAYOUT
          Error code indicating to paste one column is forbidden.
static java.lang.String DESIGN_EXCEPTION_COLUMN_PASTE_FORBIDDEN
          Error code indicating to paste one column is forbidden.
static java.lang.String DESIGN_EXCEPTION_DATA_SET_MISSED_IN_JOINT_DATA_SET
          Data set is not added into this data set.
static java.lang.String DESIGN_EXCEPTION_DUPLICATE_CUSTOM_COLOR_NAME
          Error code indicating the custom color name is duplicate.
static java.lang.String DESIGN_EXCEPTION_DUPLICATE_GROUP_NAME
          Error code indicating the table/list has duplicate group name.
static java.lang.String DESIGN_EXCEPTION_EXTENSION_NOT_FOUND
          The extension name for the extended item is not found in our meta.
static java.lang.String DESIGN_EXCEPTION_IMAGE_FILE_NOT_EXIST
          Deprecated.  
static java.lang.String DESIGN_EXCEPTION_INCONSISTENT_DATA_GROUP
          The simple list property has no definition in the element.
static java.lang.String DESIGN_EXCEPTION_INCONSISTENT_TEMPLATE_PARAMETER_TYPE
          Error code indicating default element or value element of template parameter definition is incompatible the "allowedType" property defined or the element types of default element and value element are not the same.
static java.lang.String DESIGN_EXCEPTION_INCONSITENT_DROP_HEADINGS
          Error code indicating the table has a conflict among dropping cells in group header of the table.
static java.lang.String DESIGN_EXCEPTION_INCONSITENT_GRID_COL_COUNT
          Error code indicating the grid has inconsistent column count.
static java.lang.String DESIGN_EXCEPTION_INCONSITENT_TABLE_COL_COUNT
          Error code indicating the table has inconsistent column count.
static java.lang.String DESIGN_EXCEPTION_INCONSITENT_TABLE_COL_COUNT_WITH_DROP
          Error code indicating the table has inconsistent column count because of drop effects of some cells.
static java.lang.String DESIGN_EXCEPTION_INVALID_CUSTOM_COLOR_NAME
          Error code indicating the custom color name is the same as CSS standard color name.
static java.lang.String DESIGN_EXCEPTION_INVALID_DATA_BINDING_REF
          Error code indicating the element referred should not be the container or content of the element.
static java.lang.String DESIGN_EXCEPTION_INVALID_ELEMENT_REF
          Error code indicating the element referred is not found.
static java.lang.String DESIGN_EXCEPTION_INVALID_LIBRARY_REFERENCE
          Error code indicating the structure referred is not found.
static java.lang.String DESIGN_EXCEPTION_INVALID_MANIFEST
           
static java.lang.String DESIGN_EXCEPTION_INVALID_MASTER_PAGE_CONTEXT_CONTAINMENT
          The master page can not contain table/list in any level.
static java.lang.String DESIGN_EXCEPTION_INVALID_MULTI_COLUMN
          Error code indicating the columns span outside the page content.
static java.lang.String DESIGN_EXCEPTION_INVALID_PAGE_MARGINS
          Error code indicating the page margin is larger than the whole page.
static java.lang.String DESIGN_EXCEPTION_INVALID_PAGE_SIZE
          Error code indicating the master page size is invalid.
static java.lang.String DESIGN_EXCEPTION_INVALID_PROPERTY_BINDING_ID
          The property binding refers a non-existing element.
static java.lang.String DESIGN_EXCEPTION_INVALID_PROPERTY_NAME
          Error code indicating the property name of property mask does not be defined on the element.
static java.lang.String DESIGN_EXCEPTION_INVALID_SCALAR_PARAMETER_TYPE
          Error code indicating the a cascading parameter is not typed as "dynamic".
static java.lang.String DESIGN_EXCEPTION_INVALID_STRUCTURE_REF
          Error code indicating the structure referred is not found.
static java.lang.String DESIGN_EXCEPTION_MISSING_COLUMN_BINDING
          Column name of the data item has no corresponding data bindging.
static java.lang.String DESIGN_EXCEPTION_MISSING_DATA_SET
          Error code indicating List or Table can not access any data set.
static java.lang.String DESIGN_EXCEPTION_MISSING_EXTENSION
          The extension name for the extended item is not defined.
static java.lang.String DESIGN_EXCEPTION_MISSING_MASTER_PAGE
          Error code indicating the report has no master page.
static java.lang.String DESIGN_EXCEPTION_MISSING_PAGE_SIZE
          Error code indicating the page size is missing when page type is custom.
static java.lang.String DESIGN_EXCEPTION_MISSING_SQL_STMT
          Error code indicating the JDBC select data set has no SQL statement.
static java.lang.String DESIGN_EXCEPTION_MISSING_TEMPLATE_PARAMETER_TYPE
          Error code indicating template parameter definitions have no "type" information.
static java.lang.String DESIGN_EXCEPTION_OVERLAPPING_CELLS
          Error code indicating the table has overlapping cells.
static java.lang.String DESIGN_EXCEPTION_PROPERTY_BINDING_FORBIDDEN
          The element is not in the design tree, so it is forbidden to set the property binding.
static java.lang.String DESIGN_EXCEPTION_PROPERTY_COPY_FORBIDDEN
          Error code indicating to copy one property is forbidden.
static java.lang.String DESIGN_EXCEPTION_ROW_COPY_FORBIDDEN
          Error code indicating to copy one row is forbidden.
static java.lang.String DESIGN_EXCEPTION_ROW_INSERT_FORBIDDEN
          Error code indicating to shift one row is forbidden.
static java.lang.String DESIGN_EXCEPTION_ROW_INSERTANDPASTE_FORBIDDEN
          Error code indicating to inert and paste one row is forbidden.
static java.lang.String DESIGN_EXCEPTION_ROW_PASTE_FORBIDDEN
          Error code indicating to paste one row is forbidden.
static java.lang.String DESIGN_EXCEPTION_ROW_SHIFT_FORBIDDEN
          Error code indicating to paste one row is forbidden.
static java.lang.String DESIGN_EXCEPTION_UNSUPPORTED_ELEMENT
          Error code indicating the element is not supported, but implemented in this release.
static int ERROR
          The constant for the semantic error.
static int WARNING
          The constant for the semantic warning.
 
Fields inherited from class org.eclipse.birt.report.model.api.activity.SemanticException
element
 
Fields inherited from class org.eclipse.birt.report.model.api.ModelException
PLUGIN_ID
 
Fields inherited from class org.eclipse.birt.core.exception.BirtException
CANCEL, INFO, oaMessageArguments, OK, pluginId, rb, severity, sResourceKey
 
Constructor Summary
SemanticError(org.eclipse.birt.report.model.core.DesignElement element, java.lang.String errCode)
          Constructs a SemanticError with the default serious level.
SemanticError(org.eclipse.birt.report.model.core.DesignElement element, java.lang.String[] values, java.lang.String errCode)
          Constructs a SemanticError with the default serious level.
SemanticError(org.eclipse.birt.report.model.core.DesignElement element, java.lang.String[] values, java.lang.String errCode, int level)
          Constructs a SemanticError with the specified level.
SemanticError(org.eclipse.birt.report.model.core.DesignElement element, java.lang.String errCode, int level)
          Constructs a SemanticError with the specified level.
 
Method Summary
 int getErrorLevel()
          Returns the level of the error.
 java.lang.String getLocalizedMessage()
           
 
Methods inherited from class org.eclipse.birt.report.model.api.activity.SemanticException
getElement, getElementName, getMessage
 
Methods inherited from class org.eclipse.birt.core.exception.BirtException
getErrorCode, getLocalizedMessage, getPluginId, getSeverity, setSeverity
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DESIGN_EXCEPTION_INCONSITENT_TABLE_COL_COUNT

public static final java.lang.String DESIGN_EXCEPTION_INCONSITENT_TABLE_COL_COUNT
Error code indicating the table has inconsistent column count. The column count should match the maximum cell count in header, detail, and foot slots.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INCONSITENT_TABLE_COL_COUNT_WITH_DROP

public static final java.lang.String DESIGN_EXCEPTION_INCONSITENT_TABLE_COL_COUNT_WITH_DROP
Error code indicating the table has inconsistent column count because of drop effects of some cells. The column count should match the maximum cell count in header, detail, and foot slots.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INCONSITENT_GRID_COL_COUNT

public static final java.lang.String DESIGN_EXCEPTION_INCONSITENT_GRID_COL_COUNT
Error code indicating the grid has inconsistent column count. The column count should match the maximum cell count in rows.

See Also:
Constant Field Values

DESIGN_EXCEPTION_OVERLAPPING_CELLS

public static final java.lang.String DESIGN_EXCEPTION_OVERLAPPING_CELLS
Error code indicating the table has overlapping cells. Cell is forbidden to overlap other cells.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INCONSITENT_DROP_HEADINGS

public static final java.lang.String DESIGN_EXCEPTION_INCONSITENT_DROP_HEADINGS
Error code indicating the table has a conflict among dropping cells in group header of the table.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_PAGE_SIZE

public static final java.lang.String DESIGN_EXCEPTION_INVALID_PAGE_SIZE
Error code indicating the master page size is invalid. The size should be positive.

See Also:
Constant Field Values

DESIGN_EXCEPTION_MISSING_PAGE_SIZE

public static final java.lang.String DESIGN_EXCEPTION_MISSING_PAGE_SIZE
Error code indicating the page size is missing when page type is custom.

See Also:
Constant Field Values

DESIGN_EXCEPTION_CANNOT_SPECIFY_PAGE_SIZE

public static final java.lang.String DESIGN_EXCEPTION_CANNOT_SPECIFY_PAGE_SIZE
Error code indicating page size can not be specified if page type is not custom.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_PAGE_MARGINS

public static final java.lang.String DESIGN_EXCEPTION_INVALID_PAGE_MARGINS
Error code indicating the page margin is larger than the whole page.

See Also:
Constant Field Values

DESIGN_EXCEPTION_MISSING_MASTER_PAGE

public static final java.lang.String DESIGN_EXCEPTION_MISSING_MASTER_PAGE
Error code indicating the report has no master page.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_MULTI_COLUMN

public static final java.lang.String DESIGN_EXCEPTION_INVALID_MULTI_COLUMN
Error code indicating the columns span outside the page content.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_ELEMENT_REF

public static final java.lang.String DESIGN_EXCEPTION_INVALID_ELEMENT_REF
Error code indicating the element referred is not found.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_DATA_BINDING_REF

public static final java.lang.String DESIGN_EXCEPTION_INVALID_DATA_BINDING_REF
Error code indicating the element referred should not be the container or content of the element.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_STRUCTURE_REF

public static final java.lang.String DESIGN_EXCEPTION_INVALID_STRUCTURE_REF
Error code indicating the structure referred is not found.

See Also:
Constant Field Values

DESIGN_EXCEPTION_MISSING_SQL_STMT

public static final java.lang.String DESIGN_EXCEPTION_MISSING_SQL_STMT
Error code indicating the JDBC select data set has no SQL statement.

See Also:
Constant Field Values

DESIGN_EXCEPTION_MISSING_DATA_SET

public static final java.lang.String DESIGN_EXCEPTION_MISSING_DATA_SET
Error code indicating List or Table can not access any data set.

See Also:
Constant Field Values

DESIGN_EXCEPTION_IMAGE_FILE_NOT_EXIST

public static final java.lang.String DESIGN_EXCEPTION_IMAGE_FILE_NOT_EXIST
Deprecated. 
Error code indicating the image file is not found.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_PROPERTY_NAME

public static final java.lang.String DESIGN_EXCEPTION_INVALID_PROPERTY_NAME
Error code indicating the property name of property mask does not be defined on the element.

See Also:
Constant Field Values

DESIGN_EXCEPTION_UNSUPPORTED_ELEMENT

public static final java.lang.String DESIGN_EXCEPTION_UNSUPPORTED_ELEMENT
Error code indicating the element is not supported, but implemented in this release.

See Also:
Constant Field Values

DESIGN_EXCEPTION_AT_LEAST_ONE_COLUMN

public static final java.lang.String DESIGN_EXCEPTION_AT_LEAST_ONE_COLUMN
Error code indicating the result set has no result set column.

See Also:
Constant Field Values

DESIGN_EXCEPTION_DUPLICATE_GROUP_NAME

public static final java.lang.String DESIGN_EXCEPTION_DUPLICATE_GROUP_NAME
Error code indicating the table/list has duplicate group name.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_CUSTOM_COLOR_NAME

public static final java.lang.String DESIGN_EXCEPTION_INVALID_CUSTOM_COLOR_NAME
Error code indicating the custom color name is the same as CSS standard color name.

See Also:
Constant Field Values

DESIGN_EXCEPTION_DUPLICATE_CUSTOM_COLOR_NAME

public static final java.lang.String DESIGN_EXCEPTION_DUPLICATE_CUSTOM_COLOR_NAME
Error code indicating the custom color name is duplicate.

See Also:
Constant Field Values

DESIGN_EXCEPTION_EXTENSION_NOT_FOUND

public static final java.lang.String DESIGN_EXCEPTION_EXTENSION_NOT_FOUND
The extension name for the extended item is not found in our meta.

See Also:
Constant Field Values

DESIGN_EXCEPTION_MISSING_EXTENSION

public static final java.lang.String DESIGN_EXCEPTION_MISSING_EXTENSION
The extension name for the extended item is not defined.

See Also:
Constant Field Values

DESIGN_EXCEPTION_PROPERTY_COPY_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_PROPERTY_COPY_FORBIDDEN
Error code indicating to copy one property is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_ROW_COPY_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_ROW_COPY_FORBIDDEN
Error code indicating to copy one row is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_ROW_PASTE_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_ROW_PASTE_FORBIDDEN
Error code indicating to paste one row is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_ROW_INSERTANDPASTE_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_ROW_INSERTANDPASTE_FORBIDDEN
Error code indicating to inert and paste one row is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_ROW_INSERT_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_ROW_INSERT_FORBIDDEN
Error code indicating to shift one row is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_ROW_SHIFT_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_ROW_SHIFT_FORBIDDEN
Error code indicating to paste one row is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_COLUMN_COPY_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_COLUMN_COPY_FORBIDDEN
Error code indicating to copy one column is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_COLUMN_PASTE_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_COLUMN_PASTE_FORBIDDEN
Error code indicating to paste one column is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_COLUMN_PASTE_DIFFERENT_LAYOUT

public static final java.lang.String DESIGN_EXCEPTION_COLUMN_PASTE_DIFFERENT_LAYOUT
Error code indicating to paste one column is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_COLUMN_INSERT_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_COLUMN_INSERT_FORBIDDEN
Error code indicating to insert one column is forbidden.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_SCALAR_PARAMETER_TYPE

public static final java.lang.String DESIGN_EXCEPTION_INVALID_SCALAR_PARAMETER_TYPE
Error code indicating the a cascading parameter is not typed as "dynamic".

See Also:
Constant Field Values

DESIGN_EXCEPTION_MISSING_TEMPLATE_PARAMETER_TYPE

public static final java.lang.String DESIGN_EXCEPTION_MISSING_TEMPLATE_PARAMETER_TYPE
Error code indicating template parameter definitions have no "type" information.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_LIBRARY_REFERENCE

public static final java.lang.String DESIGN_EXCEPTION_INVALID_LIBRARY_REFERENCE
Error code indicating the structure referred is not found.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INCONSISTENT_TEMPLATE_PARAMETER_TYPE

public static final java.lang.String DESIGN_EXCEPTION_INCONSISTENT_TEMPLATE_PARAMETER_TYPE
Error code indicating default element or value element of template parameter definition is incompatible the "allowedType" property defined or the element types of default element and value element are not the same.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_PROPERTY_BINDING_ID

public static final java.lang.String DESIGN_EXCEPTION_INVALID_PROPERTY_BINDING_ID
The property binding refers a non-existing element.

See Also:
Constant Field Values

DESIGN_EXCEPTION_PROPERTY_BINDING_FORBIDDEN

public static final java.lang.String DESIGN_EXCEPTION_PROPERTY_BINDING_FORBIDDEN
The element is not in the design tree, so it is forbidden to set the property binding.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_MASTER_PAGE_CONTEXT_CONTAINMENT

public static final java.lang.String DESIGN_EXCEPTION_INVALID_MASTER_PAGE_CONTEXT_CONTAINMENT
The master page can not contain table/list in any level.

See Also:
Constant Field Values

DESIGN_EXCEPTION_DATA_SET_MISSED_IN_JOINT_DATA_SET

public static final java.lang.String DESIGN_EXCEPTION_DATA_SET_MISSED_IN_JOINT_DATA_SET
Data set is not added into this data set.

See Also:
Constant Field Values

DESIGN_EXCEPTION_MISSING_COLUMN_BINDING

public static final java.lang.String DESIGN_EXCEPTION_MISSING_COLUMN_BINDING
Column name of the data item has no corresponding data bindging.

See Also:
Constant Field Values

DESIGN_EXCEPTION_CIRCULAR_ELEMENT_REFERNECE

public static final java.lang.String DESIGN_EXCEPTION_CIRCULAR_ELEMENT_REFERNECE
The element reference would create a cycle: a extends b extends a.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INCONSISTENT_DATA_GROUP

public static final java.lang.String DESIGN_EXCEPTION_INCONSISTENT_DATA_GROUP
The simple list property has no definition in the element.

See Also:
Constant Field Values

DESIGN_EXCEPTION_INVALID_MANIFEST

public static final java.lang.String DESIGN_EXCEPTION_INVALID_MANIFEST
See Also:
Constant Field Values

ERROR

public static final int ERROR
The constant for the semantic error.

See Also:
Constant Field Values

WARNING

public static final int WARNING
The constant for the semantic warning.

See Also:
Constant Field Values
Constructor Detail

SemanticError

public SemanticError(org.eclipse.birt.report.model.core.DesignElement element,
                     java.lang.String errCode)
Constructs a SemanticError with the default serious level.

Parameters:
element - the element causing this semantic error
errCode - the semantic error code

SemanticError

public SemanticError(org.eclipse.birt.report.model.core.DesignElement element,
                     java.lang.String[] values,
                     java.lang.String errCode)
Constructs a SemanticError with the default serious level.

Parameters:
element - the element causing this semantic error
values - value array used for error message
errCode - the semantic error code

SemanticError

public SemanticError(org.eclipse.birt.report.model.core.DesignElement element,
                     java.lang.String errCode,
                     int level)
Constructs a SemanticError with the specified level.

Parameters:
element - the element causing this semantic error
errCode - the semantic error code
level - the level of the error. Can be ERROR or WARNING.

SemanticError

public SemanticError(org.eclipse.birt.report.model.core.DesignElement element,
                     java.lang.String[] values,
                     java.lang.String errCode,
                     int level)
Constructs a SemanticError with the specified level.

Parameters:
element - the element causing this semantic error
values - value array used for error message
errCode - the semantic error code
level - the level of the error. Can be ERROR or WARNING.
Method Detail

getLocalizedMessage

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

getErrorLevel

public int getErrorLevel()
Returns the level of the error. The level can be ERROR or WARNING.

Returns:
the level of the error


Copyright © 2008 Actuate Corp. All rights reserved.