ExcelAccessor Bean Suite

com.ibm.excelaccessor.event
Class ExcelCellErrorEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.excelaccessor.event.ExcelAccessorErrorEvent
              |
              +--com.ibm.excelaccessor.event.ExcelCellErrorEvent
All Implemented Interfaces:
java.io.Serializable

public class ExcelCellErrorEvent
extends ExcelAccessorErrorEvent

The ExcelCellErrorEvent is fired when an error occurs on the ExcelCell bean. This event encapsulates the exception occurred and the related error message. This exception could be used to obtain more detailed information about the exception.

See Also:
ExcelCellErrorListener, Serialized Form

Fields inherited from class com.ibm.excelaccessor.event.ExcelAccessorErrorEvent
EXCEL_ERROR
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ExcelCellErrorEvent(java.lang.Object source, int messageCode, java.lang.Exception currentException, java.lang.String message, int startRow, int startCol, int endRow, int endCol, java.lang.String rangeName, java.lang.String sheetName, java.lang.String workbookName)
          Constructs a ExcelCellErrorEvent object with the specified source object.
 
Method Summary
 int getEndCol()
          Returns the ending column number for the range.
 int getEndRow()
          Returns the ending row number for the range.
 java.lang.String getRangeName()
          Returns the name of the range on which the error has occurred.
 int getStartCol()
          Returns the starting column number for the range.
 int getStartRow()
          Returns the starting row number for the range.
 java.lang.String getWorksheetName()
          Returns the name of the worksheet in which the range is present
 
Methods inherited from class com.ibm.excelaccessor.event.ExcelAccessorErrorEvent
getCurrentException, getMessage, getMessageCode, getWorkbookName, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ExcelCellErrorEvent

public ExcelCellErrorEvent(java.lang.Object source,
                           int messageCode,
                           java.lang.Exception currentException,
                           java.lang.String message,
                           int startRow,
                           int startCol,
                           int endRow,
                           int endCol,
                           java.lang.String rangeName,
                           java.lang.String sheetName,
                           java.lang.String workbookName)
Constructs a ExcelCellErrorEvent object with the specified source object.
Parameters:
source - The object where the event originated.
messageCode - The code of the error message.
currentException - The exception that is thrown.
message - The detailed error message.
workbookName - The name of the workbook of the range.
sheetName - The name of the sheet of the range.
rangeName - The name of the range which has thrown the error.
startRow - The starting row number for the range.
startCol - The starting column number for the range.
endRow - The ending row number for the range.
endCol - The ending column number for the range.
Method Detail

getEndCol

public int getEndCol()
Returns the ending column number for the range.
Returns:
The ending column number.

getEndRow

public int getEndRow()
Returns the ending row number for the range.
Returns:
The ending row number.

getRangeName

public java.lang.String getRangeName()
Returns the name of the range on which the error has occurred.
Returns:
The name of the range.

getStartCol

public int getStartCol()
Returns the starting column number for the range.
Returns:
The starting column number.

getStartRow

public int getStartRow()
Returns the starting row number for the range.
Returns:
The starting row number.

getWorksheetName

public java.lang.String getWorksheetName()
Returns the name of the worksheet in which the range is present
Returns:
The name of the worksheet that contains the range.

ExcelAccessor Bean Suite

ExcelAccessor Bean Suite