com.sabratec.applinx.baseobject.table

Interface GXITableRowCollection

All Known Implementing Classes:

GXTableRowCollection

public interface GXITableRowCollection

Table's rows' data.

Represents the table's rows' data. The collection is composed of GXITableRow objects. Can be used to directly access a row or a cell, and to filter rows.

Method Summary

Modifier and Type	Method and Description
void	addFilter(GXIRowsFilter filter) Adds a new filter to the table.
void	addRow(GXITableRow row) Adds a new row as the last row in the table.
GXITableRowCollection	filterRows() Filters the table's rows according to the filters added to the table.
GXIRowsFilter[]	getFilters()
GXITableCell	getItem(int rowIndex, int columnIndex)
GXITableCell	getItem(int rowIndex, String columnName)
String	getItemContent(int rowIndex, int columnIndex)
String	getItemContent(int rowIndex, String columnName)
GXITableRow	getRow(int rowIndex)
GXITableRow	getRowByKey(String primaryKey) Finds a row according to the specified primary key.
GXITableRow	getRowByKey(String[] primaryKey) Finds a row with the specified primary key values.
int	getRowCount()
GXITableRow[]	getRows()
void	removeFilter(GXIRowsFilter filter) Removes the specified filter.
void	removeRow(GXITableRow row) removes the specified row.
void	removeRow(int rowIndex) Removes the row at the specified index.
void	setItemContent(int rowIndex, int columnIndex, String content) Sets the contents of the cell at the specified row / column coordinates.
void	setItemContent(int rowIndex, String columnName, String content) Sets the contents of the cell at the specified row / column coordinates.
void	sort(GXAbstractSorter sorter, GXIComparator comparator) Sorts the row's data using the specified sorter and comparator.

Method Detail

getRows

GXITableRow[] getRows()

Returns:

the rows' data as an array.

getRowCount

int getRowCount()

Returns:

the number of the table's rows.

getRow

GXITableRow getRow(int rowIndex)

Parameters:

rowIndex - the row's index. Should range between 0 to rowCount - 1.

Returns:

the row at the specified index.

See Also:

getRowCount()

addRow

void addRow(GXITableRow row)

Adds a new row as the last row in the table.

Parameters:

row - the row to add.

removeRow

void removeRow(int rowIndex)

Removes the row at the specified index.

Parameters:

rowIndex - row index to be removed. Should range between 0 to rowCount - 1.

removeRow

void removeRow(GXITableRow row)

removes the specified row.

Parameters:

row - the row to remove.

addFilter

void addFilter(GXIRowsFilter filter)

Adds a new filter to the table.

Parameters:

filter - the filter to be added.

See Also:

GXIRowsFilter, filterRows()

getFilters

GXIRowsFilter[] getFilters()

Returns:

table's associated filters.

removeFilter

void removeFilter(GXIRowsFilter filter)

Removes the specified filter.

Parameters:

filter - the filter to remove.

filterRows

GXITableRowCollection filterRows()

Filters the table's rows according to the filters added to the table.

Returns:

the filtered rows.

See Also:

GXIRowsFilter.filter(com.sabratec.applinx.baseobject.table.GXITableRowCollection), addFilter(com.sabratec.applinx.baseobject.table.GXIRowsFilter)

getItem

GXITableCell getItem(int rowIndex,
                     int columnIndex)

Parameters:

rowIndex - should range between 0 - rowsCount - 1.

columnIndex - should range between 0 - columnsCount - 1.

Returns:

the cell at the specified row / column coordinates.

getItem

GXITableCell getItem(int rowIndex,
                     String columnName)

Parameters:

rowIndex - should range between 0 - rowsCount - 1.

columnName - the name of the column.

Returns:

the cell at the specified row / column coordinates.

getItemContent

String getItemContent(int rowIndex,
                      int columnIndex)

Parameters:

rowIndex - should range between 0 - rowsCount - 1.

columnIndex - should range between 0 - columnsCount - 1.

Returns:

the content of the cell at the specified row / column coordinates.

getItemContent

String getItemContent(int rowIndex,
                      String columnName)

Parameters:

rowIndex - should range between 0 - rowsCount - 1.

columnName - the name of the column.

Returns:

the content of the cell at the specified row / column coordinates.

setItemContent

void setItemContent(int rowIndex,
                    int columnIndex,
                    String content)

Sets the contents of the cell at the specified row / column coordinates.

Parameters:

rowIndex - should range between 0 - rowsCount - 1.

columnIndex - should range between 0 - columnsCount - 1.

content - the cell's new content.

See Also:

GXITableCell.setContent(String content)

setItemContent

void setItemContent(int rowIndex,
                    String columnName,
                    String content)

Sets the contents of the cell at the specified row / column coordinates.

Parameters:

rowIndex - should range between 0 - rowsCount - 1.

columnName - the name of the column.

content - the cell's new content.

See Also:

GXITableCell.setContent(String content)

getRowByKey

GXITableRow getRowByKey(String[] primaryKey)

Finds a row with the specified primary key values. Should be used for tables with a combination of several columns as a primary key.

Parameters:

primaryKey - the values of the primary key's columns.

Returns:

the found row. Returns null when a row with the specified values as the primary key was not found.

Example: If the primary key was defined to be the columns "first name" and "last name", the primaryKey parameter should hold the String array "John", "Doe".

See Also:

GXITable.getPrimaryKey()

getRowByKey

GXITableRow getRowByKey(String primaryKey)

Finds a row according to the specified primary key.

Parameters:

primaryKey - the requested primary key.

Returns:

the found row. Null when a row was not found.

See Also:

GXITable.getPrimaryKey()

sort

void sort(GXAbstractSorter sorter,
          GXIComparator comparator)

Sorts the row's data using the specified sorter and comparator. It is recommended to use the sort methods in GXITable and not this method directly.

Parameters:

sorter - the sorter.

comparator - the comparator used for sorting.

See Also:

GXITable.sort(int[] columnIndices, boolean[] isAscending), GXITable.sort(int columnIndex, boolean isAscending), GXITable.sort(String columnName, boolean isAscending), GXITable.sort(String[] columnNames, boolean[] isAscending)