com.acesoft.aceoffix
Class ExcelReqTableRange

java.lang.Object
  extended by com.acesoft.aceoffix.ExcelReqTableRange

public class ExcelReqTableRange
extends java.lang.Object

Represents a TableRange. Extracts data from the TableRange. You can only use the ExcelReqSheet.openTableRange method to obtain a ExcelReqTableRange object.

Version:
3.0
Author:
Acesoft Corporation

Method Summary
 void close()
          Closes the current TableRange.
 DataFieldReqCollection getDataFields()
          Returns a collection of DataField objects of the current record.
 boolean getEOF()
          Returns a value that indicates whether the current record position is after the last record in the TableRange.
 int getRowCount()
          Gets the number of rows that are actually being submitted in the TableRange.
 void gotoRow(int rowIndex)
          Tries to move to the specified row in the TableRange.
 void nextRow()
          Tries to move to the next available row in the TableRange.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getRowCount

public int getRowCount()
Gets the number of rows that are actually being submitted in the TableRange. The RowCount are not always the same as the number of rows which rangeAddress contains when the TableRange opens.


getEOF

public boolean getEOF()
Returns a value that indicates whether the current record position is after the last record in the TableRange.


getDataFields

public DataFieldReqCollection getDataFields()
                                     throws java.lang.Exception
Returns a collection of DataField objects of the current record.

Throws:
java.lang.Exception

nextRow

public void nextRow()
             throws java.lang.Exception
Tries to move to the next available row in the TableRange.

When the TableRange is opened, the default record row is the first row. If you want to get data from next row, you must call the nextRow method. If you want to get all data from the TableRange, you need to use EOF property and nextRow method to loop all the record rows of the TableRange.

Throws:
java.lang.Exception

gotoRow

public void gotoRow(int rowIndex)
             throws java.lang.Exception
Tries to move to the specified row in the TableRange.

Parameters:
rowIndex - The zero-based index of the record row. The maximum rowIndex is RowCount - 1.
Throws:
java.lang.Exception

close

public void close()
           throws java.lang.Exception
Closes the current TableRange.

When all the operations of current TableRange are done, you must call the close method to close the TableRange. Once the TableRange is closed, you can not reference it again.

Throws:
java.lang.Exception