com.sabratec.applinx.baseobject.table

Class GXTableRowCollection

java.lang.Object

com.sabratec.applinx.baseobject.table.GXTableRowCollection

All Implemented Interfaces:

GXITableRowCollection, Externalizable, Serializable

public class GXTableRowCollection
extends Object
implements GXITableRowCollection, Externalizable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GXTableRowCollection()

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.
boolean	equals(Object obj)
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	readExternal(ObjectInput in)
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.
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GXTableRowCollection

public GXTableRowCollection()

Method Detail

getRows

public GXITableRow[] getRows()

Specified by:

getRows in interface GXITableRowCollection

Returns:

the rows' data as an array.

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface GXITableRowCollection

Returns:

the number of the table's rows.

getRow

public GXITableRow getRow(int rowIndex)

Specified by:

getRow in interface GXITableRowCollection

Parameters:

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

Returns:

the row at the specified index.

See Also:

GXITableRowCollection.getRowCount()

addRow

public void addRow(GXITableRow row)

Description copied from interface: GXITableRowCollection

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

Specified by:

addRow in interface GXITableRowCollection

Parameters:

row - the row to add.

removeRow

public void removeRow(int rowIndex)

Description copied from interface: GXITableRowCollection

Removes the row at the specified index.

Specified by:

removeRow in interface GXITableRowCollection

Parameters:

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

removeRow

public void removeRow(GXITableRow row)

Description copied from interface: GXITableRowCollection

removes the specified row.

Specified by:

removeRow in interface GXITableRowCollection

Parameters:

row - the row to remove.

addFilter

public void addFilter(GXIRowsFilter filter)

Description copied from interface: GXITableRowCollection

Adds a new filter to the table.

Specified by:

addFilter in interface GXITableRowCollection

Parameters:

filter - the filter to be added.

See Also:

GXIRowsFilter, GXITableRowCollection.filterRows()

getFilters

public GXIRowsFilter[] getFilters()

Specified by:

getFilters in interface GXITableRowCollection

Returns:

table's associated filters.

removeFilter

public void removeFilter(GXIRowsFilter filter)

Description copied from interface: GXITableRowCollection

Removes the specified filter.

Specified by:

removeFilter in interface GXITableRowCollection

Parameters:

filter - the filter to remove.

filterRows

public GXITableRowCollection filterRows()

Description copied from interface: GXITableRowCollection

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

Specified by:

filterRows in interface GXITableRowCollection

Returns:

the filtered rows.

See Also:

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

getItem

public GXITableCell getItem(int rowIndex,
                            int columnIndex)

Specified by:

getItem in interface GXITableRowCollection

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

public GXITableCell getItem(int rowIndex,
                            String columnName)

Specified by:

getItem in interface GXITableRowCollection

Parameters:

rowIndex - should range between 0 - rowsCount - 1.

columnName - the name of the column.

Returns:

the cell at the specified row / column coordinates.

getItemContent

public String getItemContent(int rowIndex,
                             int columnIndex)

Specified by:

getItemContent in interface GXITableRowCollection

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

public String getItemContent(int rowIndex,
                             String columnName)

Specified by:

getItemContent in interface GXITableRowCollection

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

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

Description copied from interface: GXITableRowCollection

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

Specified by:

setItemContent in interface GXITableRowCollection

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

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

Description copied from interface: GXITableRowCollection

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

Specified by:

setItemContent in interface GXITableRowCollection

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

public GXITableRow getRowByKey(String[] primaryKey)

Description copied from interface: GXITableRowCollection

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

Specified by:

getRowByKey in interface GXITableRowCollection

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

public GXITableRow getRowByKey(String primaryKey)

Description copied from interface: GXITableRowCollection

Finds a row according to the specified primary key.

Specified by:

getRowByKey in interface GXITableRowCollection

Parameters:

primaryKey - the requested primary key.

Returns:

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

See Also:

GXITable.getPrimaryKey()

sort

public void sort(GXAbstractSorter sorter,
                 GXIComparator comparator)

Description copied from interface: GXITableRowCollection

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.

Specified by:

sort in interface GXITableRowCollection

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)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

toString

public String toString()

Overrides:

toString in class Object