com.aspose.cells

Class RowCollection

java.lang.Object

com.aspose.cells.RowCollection

All Implemented Interfaces:

java.lang.Iterable

public class RowCollection
extends java.lang.Object
implements java.lang.Iterable

Collects the Row objects that represent the individual rows in a worksheet.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
 
         //Obtaining the reference of the first worksheet
         Worksheet worksheet = workbook.getWorksheets().get(0);
          //Get first row
         Row row = worksheet.getCells().getRows().get(0);
 

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear all rows and cells.
Row	get(int rowIndex) Gets a Row object by given row index.
int	getCount() Gets the number of rows in this collection.
Row	getRowByIndex(int index) Gets the row object by the position in the list.
java.util.Iterator	iterator() Gets an enumerator that iterates rows through this collection
java.util.Iterator	iterator(boolean reversed, boolean sync) Gets an enumerator that iterates rows through this collection
void	removeAt(int index) Remove the row item at the specified index(position) in this collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCount

public int getCount()

Gets the number of rows in this collection.

iterator

public java.util.Iterator iterator()

Gets an enumerator that iterates rows through this collection

Example

 
         Workbook workbook = new Workbook("template.xlsx");
                Cells cells = workbook.getWorksheets().get(0).getCells();
 
                Iterator en = cells.getRows().iterator();
                while (en.hasNext())
                {
                    Row row = (Row)en.next();
                    System.out.println(row.getIndex() + ": " + row.getHeight());
                }
 

Specified by:

iterator in interface java.lang.Iterable

Returns:

The row enumerator which will traverse all existing rows in this collection.

iterator

public java.util.Iterator iterator(boolean reversed,
                          boolean sync)

Gets an enumerator that iterates rows through this collection

Remarks

If the row collection will be modified(by operations that may cause new Row be instantiated or existing Row be removed) during the traversal with the enumerator, synchronized enumerator should be used instead of normal enumerator so that the traversal can continue from the position just after the one has been traversed by the last MoveNext(). However, together with the advantage that no element be skipped or traversed repeatedly, the disadvantage for synchronized enumerator is that the performance will be degraded a bit when comparing with normal enumerator.

Parameters:

reversed - whether enumerate rows in reversed order

sync - whether the returned enumerator should check the modification of row collection and keep synchronized with it.

Returns:

The row enumerator which will traverse all existing rows in this collection.

getRowByIndex

public Row getRowByIndex(int index)

Gets the row object by the position in the list.

Parameters:

index - The position.

Returns:

The Row object at given position.

get

public Row get(int rowIndex)

Gets a Row object by given row index. The Row object of given row index will be instantiated if it does not exist before.

clear

public void clear()

Clear all rows and cells.

removeAt

public void removeAt(int index)

Remove the row item at the specified index(position) in this collection.

Parameters:

index - zero-based index(position, not Row.getIndex()) of the existing row item in this collection.