org.gwt.advanced.client.datamodel

Class LazyGridDataModel

java.lang.Object

org.gwt.advanced.client.datamodel.SimpleGridDataModel

org.gwt.advanced.client.datamodel.EditableGridDataModel

org.gwt.advanced.client.datamodel.LazyGridDataModel

All Implemented Interfaces:

Editable, GridDataModel, LazyLoadable, Pageable

Direct Known Subclasses:

LazyTreeGridDataModel.DelegateLazyGridDataModel

public class LazyGridDataModel
extends EditableGridDataModel
implements LazyLoadable

This data model reprents lazy loading approach.

The total amount of rows is always greater or equal to data set length.

Since:

1.0.0

Author:

Sergey Skladchikov

Nested Class Summary

Nested classes/interfaces inherited from class org.gwt.advanced.client.datamodel.EditableGridDataModel

EditableGridDataModel.RowComparator

Constructor Summary

Constructors

Constructor and Description
LazyGridDataModel(DataModelCallbackHandler<Editable> handler) Initializes the model with the preloaded piece of data set.
LazyGridDataModel(Object[][] data) Initializes the model with the preloaded piece of data set.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRow(int beforeRow, Object[] row) This method adds the specified row in the data model.
int	getEndRow() This method returns an end row number.
protected String	getInternalRowIdentifier(int row) This method returns an internal row identifier.
Object[]	getRowData(int rowNumber) This method returns row data by the specified row number.
int	getTotalRowCount() This method return the total row amount.
boolean	isEmpty() This method checks whether the data model is empty.
void	removeAll() This method removes all rows from the model.
void	removeRow(int rowNumber) This method removes the specified row in the data model.
void	setSortColumn(int sortColumn, Comparator comparator) This implemntation doesn't do client sorting.
void	setTotalRowCount(int totalRowCount) Sets the total row count value.
void	update(int row, int column, Object data) This method updates the specified cell with the value.
void	updateRow(int rowNumber, Object[] row) This method updates the specified row in the data model.

Methods inherited from class org.gwt.advanced.client.datamodel.EditableGridDataModel

addColumn, addColumn, addListener, checkColumnNumber, checkRowNumber, clearRemovedRows, createEvent, createEvent, createGridRow, createRowComparator, fireColumnEvent, fireEvent, fireRowEvent, getColumnNames, getColumnNamesList, getColumns, getData, getDataList, getGridColumn, getHandler, getListeners, getRemovedRows, getRow, getRows, getSublist, getTotalColumnCount, normalizeColumnsCount, normalizeRowsCount, prepareData, prepareEvent, removeColumn, removeColumn, removeListener, setColumNames, setHandler, update, updateColumn, updateColumn

Methods inherited from class org.gwt.advanced.client.datamodel.SimpleGridDataModel

getCurrentPageNumber, getDisplayedPages, getEndPage, getPageable, getPageSize, getSortColumn, getStartPage, getStartRow, getTotalPagesNumber, isAscending, setAscending, setCurrentPageNumber, setDisplayedPages, setPageable, setPageSize, setSortColumn, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gwt.advanced.client.datamodel.GridDataModel

getSortColumn, getStartRow, isAscending, setAscending, setSortColumn

Methods inherited from interface org.gwt.advanced.client.datamodel.Pageable

getCurrentPageNumber, getDisplayedPages, getEndPage, getPageSize, getStartPage, getTotalPagesNumber, setCurrentPageNumber, setDisplayedPages, setPageSize

Constructor Detail

LazyGridDataModel

public LazyGridDataModel(Object[][] data)

Initializes the model with the preloaded piece of data set.

Parameters:

data - is a data set piece.

LazyGridDataModel

public LazyGridDataModel(DataModelCallbackHandler<Editable> handler)

Initializes the model with the preloaded piece of data set.

Parameters:

handler - is a data model change callback handler.

Method Detail

getTotalRowCount

public int getTotalRowCount()

This method return the total row amount.

If it hasn't been redefined, it returns data set length (and in this case the model works as usual).

Specified by:

getTotalRowCount in interface GridDataModel

Overrides:

getTotalRowCount in class EditableGridDataModel

Returns:

a total row count.

addRow

public void addRow(int beforeRow,
          Object[] row)
            throws IllegalArgumentException

This method adds the specified row in the data model.

It normalizes the model if the row is too long.

Specified by:

addRow in interface Editable

Overrides:

addRow in class EditableGridDataModel

Parameters:

beforeRow - is a number of the new row in the grid.

row - is new row data.

Throws:

IllegalArgumentException - if the row number is in invalid range.

updateRow

public void updateRow(int rowNumber,
             Object[] row)
               throws IllegalArgumentException

This method updates the specified row in the data model.

It normalizes the model if the row is too long.

Specified by:

updateRow in interface Editable

Overrides:

updateRow in class EditableGridDataModel

Parameters:

rowNumber - is a number of the row in the grid.

row - is new data.

Throws:

IllegalArgumentException - if the row number is in invalid range.

removeRow

public void removeRow(int rowNumber)
               throws IllegalArgumentException

This method removes the specified row in the data model.

Specified by:

removeRow in interface Editable

Overrides:

removeRow in class EditableGridDataModel

Parameters:

rowNumber - is a number of the row in the grid.

Throws:

IllegalArgumentException - if the row number is in invalid range.

getEndRow

public int getEndRow()

This method returns an end row number.

Specified by:

getEndRow in interface GridDataModel

Overrides:

getEndRow in class SimpleGridDataModel

Returns:

an end row number.

getRowData

public Object[] getRowData(int rowNumber)

This method returns row data by the specified row number.

Specified by:

getRowData in interface GridDataModel

Overrides:

getRowData in class EditableGridDataModel

Parameters:

rowNumber - is a number of row to be returned.

Returns:

row data.

isEmpty

public boolean isEmpty()

This method checks whether the data model is empty.

Specified by:

isEmpty in interface GridDataModel

Overrides:

isEmpty in class SimpleGridDataModel

Returns:

true if the model is empty.

removeAll

public void removeAll()

This method removes all rows from the model.

Specified by:

removeAll in interface Editable

Overrides:

removeAll in class EditableGridDataModel

setSortColumn

public void setSortColumn(int sortColumn,
                 Comparator comparator)

This implemntation doesn't do client sorting.

Specified by:

setSortColumn in interface Editable

Overrides:

setSortColumn in class EditableGridDataModel

Parameters:

sortColumn - is a sort column.

comparator - is a comparator that is never used.

setTotalRowCount

public void setTotalRowCount(int totalRowCount)

Sets the total row count value.

Specified by:

setTotalRowCount in interface LazyLoadable

Parameters:

totalRowCount - is a total row count value.

update

public void update(int row,
          int column,
          Object data)

This method updates the specified cell with the value.

Specified by:

update in interface Editable

Overrides:

update in class EditableGridDataModel

Parameters:

row - is a row number.

column - is a column number.

data - is a data to be applied.

getInternalRowIdentifier

protected String getInternalRowIdentifier(int row)

This method returns an internal row identifier.

Overrides:

getInternalRowIdentifier in class EditableGridDataModel

Parameters:

row - is a row number.

Returns:

an identifier value.