com.acesoft.aceoffix.excelreader
Class Table

java.lang.Object
  extended by com.acesoft.aceoffix.excelreader.Table

public class Table
extends java.lang.Object

Table class represents a table defined in Aceoffix.

Table class is an important Excel table class defined in Aceoffix.

You can only call the Sheet.openTable(String) method to get the Table object.

Version:
5.0
Author:
Acesoft Corporation

Method Summary
 void close()
          Closes the current Table.
 DataFieldCollection getDataFields()
          Gets the DataField collection of the current record in the Table.
 java.lang.String getDefinedName()
          Gets the defined name of the Table.
 boolean getEOF()
          Returns a value that indicates whether the current record position is after the last position in the Table.
 int getRowCount()
          Gets the count of rows in the Table.
 void gotoRow(int rowIndex)
          Moves to the specified row in the Table.
 void nextRow()
          Moves to the next record row in the Table.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDefinedName

public java.lang.String getDefinedName()
Gets the defined name of the Table.


getRowCount

public int getRowCount()
Gets the count of rows in the Table.

Gets the count of rows in the Table.

See Also:
Sheet.openTable().

getEOF

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

This property is the ending condition for looping all the record rows in the table.

See Also:
Sheet.openTable().

getDataFields

public DataFieldCollection getDataFields()
                                  throws java.lang.Exception
Gets the DataField collection of the current record in the Table.

Throws:
java.lang.Exception
See Also:
Sheet.openTable().

nextRow

public void nextRow()
             throws java.lang.Exception
Moves to the next record row in the Table.

When the Table is opened, the default record is the first row. And you can call the NextRow() method to get the data form the next row. If you want to get all data from the Table, you can use NextRow() method and EOF property to loop all the record rows of the Table.

Throws:
java.lang.Exception
See Also:
Sheet.openTable().

gotoRow

public void gotoRow(int rowIndex)
             throws java.lang.Exception
Moves to the specified row in the Table.

Parameters:
rowIndex - Zero-based. The maximum RowIndex is equal to RowCount - 1.
Throws:
java.lang.Exception

close

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

When all the operations of the current Table are done, you must call the Close method to close the Table. Once the Table is closed, you cannot refer to it again.

Throws:
java.lang.Exception
See Also:
Sheet.openTable().