org.gwt.advanced.client.datamodel

Class EditableGridDataModel

java.lang.Object

org.gwt.advanced.client.datamodel.SimpleGridDataModel

org.gwt.advanced.client.datamodel.EditableGridDataModel

All Implemented Interfaces:

Editable, GridDataModel, Pageable

Direct Known Subclasses:

LazyGridDataModel, TreeGridDataModel.DelegateEditableGridDataModel

public class EditableGridDataModel
extends SimpleGridDataModel
implements Editable

This is a model for editable grids.

It allows dynamically add / update and remove rows and columns. It also resizes the model if the specified row or column is too long.

Since:

1.0.0

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EditableGridDataModel.RowComparator This is a row comparator implementation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EditableGridDataModel(DataModelCallbackHandler<Editable> handler) Creates a new instnace of this class and defines the handler.
	EditableGridDataModel(Object[][] data) Creates an instance of this class and initializes it with the data.

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumn(int beforeColumn, Object[] column) This method adds a column into the model.
void	addColumn(int beforeColumn, String name, Object[] column) This method adds the specified column in the data model.
void	addListener(EditableModelListener listener) This method registers the specified listener to receive model events.
void	addRow(int beforeRow, Object[] row) This method adds the specified row in the data model.
protected void	checkColumnNumber(int columnNumber, int max) This method checks whether the specified column is in valid range and throws the IllegalArgumentException if it isn't.
protected void	checkRowNumber(int rowNumber, int max) This method checks whether the specified row is in valid range and throws the IllegalArgumentException if it isn't.
void	clearRemovedRows() This method clears removed rows from the model history
protected EditableModelEvent	createEvent(EditableModelEvent.EventType eventType) Creates a new model event.
protected EditableModelEvent	createEvent(EditableModelEvent.EventType eventType, int row, int column) Creates a new model event.
protected GridRow	createGridRow(int columnCount) This method creates a new identified list instance.
protected EditableGridDataModel.RowComparator	createRowComparator(int sortColumn, Comparator<Object> comparator) This method creates a row comparator.
protected void	fireColumnEvent(EditableModelEvent.EventType eventType, int column) Fires a column change events.
protected void	fireEvent(EditableModelEvent event) This method fires the specified event.
protected void	fireRowEvent(EditableModelEvent.EventType eventType, int row) Fires a row change events.
String[]	getColumnNames() This method gets a list of column names.
protected List<String>	getColumnNamesList() Getter for property 'columnNames'.
GridColumn[]	getColumns() Gets an array of all model columns.
Object[][]	getData() This method returns the data set of the model.
protected List<? extends GridRow>	getDataList() Gets a list of data.
GridColumn	getGridColumn(int index) Gets a grid column by index.
DataModelCallbackHandler<Editable>	getHandler() This method returns a callback handler instance.
protected String	getInternalRowIdentifier(int row) This method returns an internal row identifier.
protected List<EditableModelListener>	getListeners() Gets a list of registered listeners.
Object[][]	getRemovedRows() This method returns removed rows.
GridRow	getRow(int index) Gets a grid row by index.
Object[]	getRowData(int rowNumber) This method returns row data by the specified row number.
GridRow[]	getRows() This method returns an original list of rows.
protected List<String>	getSublist(List<String> list, int start, int end) This method extract a sublist of the specified list.
int	getTotalColumnCount() Getter for property 'totalColumnCount'.
int	getTotalRowCount() This method is overriden to avoid possible recursions.
protected GridRow	normalizeColumnsCount(Object[] row) This method normalizes a number of columns in all rows adding empty cells.
protected ArrayList<Object>	normalizeRowsCount(Object[] column) This method normalizes a number of rows in all columns adding empty cells.
protected void	prepareData(Object[][] data, int rowCount, int columnCount) This method initializes the data set with the specified values.
protected void	prepareEvent(EditableModelEvent event) This method prepares the specified event for sending, initilizing necessary fields.
void	removeAll() This method removes all rows from the model.
void	removeColumn(int columnNumber) This method removes a column from the model.
void	removeColumn(String name) This method deletes the specified column in the data model.
void	removeListener(EditableModelListener listener) This method unregisters the specified listener to stop model events receiving.
void	removeRow(int rowNumber) This method removes the specified row in the data model.
void	setColumNames(String[] names) This method sets a list of column names This list must be in the same order like the data array columns (see Editable.update(Object[][]) for details.
void	setHandler(DataModelCallbackHandler<Editable> handler) This method sets a callback handler.
void	setSortColumn(int sortColumn, Comparator<Object> comparator) This method sets a sort column and uses the specified comparator.
void	update(int row, int column, Object data) This method updates the specified cell with the value.
void	update(Object[][] data) Use this method to update the model with a new value.
void	updateColumn(int columnNumber, Object[] column) This method updates the specified column in the data model.
void	updateColumn(String name, Object[] column) This method updates the specified column in the data model.
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.SimpleGridDataModel

getCurrentPageNumber, getDisplayedPages, getEndPage, getEndRow, getPageable, getPageSize, getSortColumn, getStartPage, getStartRow, getTotalPagesNumber, isAscending, isEmpty, 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

getEndRow, getSortColumn, getStartRow, isAscending, isEmpty, setAscending, setSortColumn

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

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

Constructor Detail

EditableGridDataModel

public EditableGridDataModel(Object[][] data)

Creates an instance of this class and initializes it with the data.

It automatically resizes the data set if it's too small.

Parameters:

data - is a data set.

EditableGridDataModel

protected EditableGridDataModel(DataModelCallbackHandler<Editable> handler)

Creates a new instnace of this class and defines the handler.

Parameters:

handler - is a callback handler to be invoked on changes.

Method Detail

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

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

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

Parameters:

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

Throws:

IllegalArgumentException - if the row number is in invalid range.

addColumn

public void addColumn(int beforeColumn,
             Object[] column)
               throws IllegalArgumentException

This method adds a column into the model.

Specified by:

addColumn in interface Editable

Parameters:

beforeColumn - a column number.

column - a column data set.

Throws:

IllegalArgumentException - if the column number is invalid.

addColumn

public void addColumn(int beforeColumn,
             String name,
             Object[] column)
               throws IllegalArgumentException

This method adds the specified column in the data model.

It normalizes the model if the column is too long.

Specified by:

addColumn in interface Editable

Parameters:

beforeColumn - is a number of the new column in the grid.

name - is a name of the column.

column - is new column data.

Throws:

IllegalArgumentException - if the column number is in invalid range.

updateColumn

public void updateColumn(int columnNumber,
                Object[] column)

This method updates the specified column in the data model.

It normalizes the model if the column is too long.

Specified by:

updateColumn in interface Editable

Parameters:

columnNumber - is a number of the column in the grid.

column - is new data.

Throws:

IllegalArgumentException - if the column number is in invalid range.

updateColumn

public void updateColumn(String name,
                Object[] column)

This method updates the specified column in the data model.

It normalizes the model if the column is too long.

Specified by:

updateColumn in interface Editable

Parameters:

name - is a name of the column.

column - is new data.

removeColumn

public void removeColumn(int columnNumber)
                  throws IllegalArgumentException

This method removes a column from the model.

Specified by:

removeColumn in interface Editable

Parameters:

columnNumber - a column number.

Throws:

IllegalArgumentException - if the column number is invalid.

removeColumn

public void removeColumn(String name)

This method deletes the specified column in the data model.

Specified by:

removeColumn in interface Editable

Parameters:

name - is a name of the column.

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 SimpleGridDataModel

Parameters:

rowNumber - is a number of row to be returned.

Returns:

row data.

removeAll

public void removeAll()

This method removes all rows from the model.

Specified by:

removeAll in interface Editable

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

Parameters:

row - is a row number.

column - is a column number.

data - is a data to be applied.

setSortColumn

public void setSortColumn(int sortColumn,
                 Comparator<Object> comparator)

This method sets a sort column and uses the specified comparator.

Specified by:

setSortColumn in interface Editable

Parameters:

sortColumn - is a sort column.

comparator - is a column comparator.

createRowComparator

protected EditableGridDataModel.RowComparator createRowComparator(int sortColumn,
                                                      Comparator<Object> comparator)

This method creates a row comparator.

Parameters:

sortColumn - is a sort column.

comparator - is a cell comparator.

Returns:

is a row comparator instance.

getTotalColumnCount

public int getTotalColumnCount()

Getter for property 'totalColumnCount'.

Specified by:

getTotalColumnCount in interface Editable

Returns:

Value for property 'totalColumnCount'.

getRemovedRows

public Object[][] getRemovedRows()

This method returns removed rows.

Specified by:

getRemovedRows in interface Editable

Returns:

a list of removed rows.

clearRemovedRows

public void clearRemovedRows()

This method clears removed rows from the model history

Specified by:

clearRemovedRows in interface Editable

getTotalRowCount

public int getTotalRowCount()

This method is overriden to avoid possible recursions.

Specified by:

getTotalRowCount in interface GridDataModel

Overrides:

getTotalRowCount in class SimpleGridDataModel

Returns:

a total row count.

getHandler

public DataModelCallbackHandler<Editable> getHandler()

This method returns a callback handler instance.

Specified by:

getHandler in interface Editable

Returns:

a callback handler.

setHandler

public void setHandler(DataModelCallbackHandler<Editable> handler)

This method sets a callback handler.

Specified by:

setHandler in interface Editable

Parameters:

handler - a callback handler.

update

public void update(Object[][] data)

Use this method to update the model with a new value.

Specified by:

update in interface Editable

Parameters:

data - is a data set to be applied instead of the current set.

addListener

public void addListener(EditableModelListener listener)

This method registers the specified listener to receive model events.

Specified by:

addListener in interface Editable

Parameters:

listener - is a model listener to register.

removeListener

public void removeListener(EditableModelListener listener)

This method unregisters the specified listener to stop model events receiving.

Specified by:

removeListener in interface Editable

Parameters:

listener - is a model listener to be removed.

checkColumnNumber

protected void checkColumnNumber(int columnNumber,
                     int max)
                          throws IllegalArgumentException

This method checks whether the specified column is in valid range and throws the IllegalArgumentException if it isn't.

Parameters:

columnNumber - is a column number to check.

max - is a max limit of the range.

Throws:

IllegalArgumentException - if check failed.

checkRowNumber

protected void checkRowNumber(int rowNumber,
                  int max)

This method checks whether the specified row is in valid range and throws the IllegalArgumentException if it isn't.

Parameters:

rowNumber - is a row number to check.

max - is a max limit of the range.

Throws:

IllegalArgumentException - if check failed.

getData

public Object[][] getData()

This method returns the data set of the model.

Specified by:

getData in interface GridDataModel

Overrides:

getData in class SimpleGridDataModel

Returns:

a data set.

normalizeColumnsCount

protected GridRow normalizeColumnsCount(Object[] row)

This method normalizes a number of columns in all rows adding empty cells.

If the specified row is shorter then the current columns count, it add empty cells to the row.

Parameters:

row - is a pattern row.

Returns:

a result row.

normalizeRowsCount

protected ArrayList<Object> normalizeRowsCount(Object[] column)

This method normalizes a number of rows in all columns adding empty cells.

If the specified column is shorter then the current rows count, it add empty cells to the column.

Parameters:

column - is a pattern column.

Returns:

a result column.

prepareData

protected void prepareData(Object[][] data,
               int rowCount,
               int columnCount)

This method initializes the data set with the specified values.

It tries to fill the data set and if the specified value is shorter it adds empty cells. Otherwise it increases the size of the data set.

Parameters:

data - is a data to put into the data set.

rowCount - is a row count of the data set.

columnCount - is a column count of the data set.

createGridRow

protected GridRow createGridRow(int columnCount)

This method creates a new identified list instance.

Parameters:

columnCount - is a column count value.

Returns:

a new identified list.

getRows

public GridRow[] getRows()

This method returns an original list of rows.

Specified by:

getRows in interface Editable

Returns:

a list of rows.

getColumns

public GridColumn[] getColumns()

Gets an array of all model columns.

Specified by:

getColumns in interface Editable

Returns:

a columns array.

getRow

public GridRow getRow(int index)

Gets a grid row by index.

Specified by:

getRow in interface Editable

Parameters:

index - is an index value.

Returns:

a grid row.

getGridColumn

public GridColumn getGridColumn(int index)

Gets a grid column by index.

Specified by:

getGridColumn in interface Editable

Parameters:

index - is an index value.

Returns:

a grid column.

getColumnNames

public String[] getColumnNames()

This method gets a list of column names.

Size of this list must be equal to the size of the model data array.

Specified by:

getColumnNames in interface Editable

Returns:

is a list of column names.

setColumNames

public void setColumNames(String[] names)

This method sets a list of column names

This list must be in the same order like the data array columns (see Editable.update(Object[][]) for details.

Specified by:

setColumNames in interface Editable

Parameters:

names - is a list of column names.

getInternalRowIdentifier

protected String getInternalRowIdentifier(int row)

This method returns an internal row identifier.

Parameters:

row - is a row number.

Returns:

an identifier value.

getColumnNamesList

protected List<String> getColumnNamesList()

Getter for property 'columnNames'.

Returns:

Value for property 'columnNames'.

getSublist

protected List<String> getSublist(List<String> list,
                      int start,
                      int end)

This method extract a sublist of the specified list.

Parameters:

list - is a list of values.

start - is a start index (including).

end - is an end index (excluding).

Returns:

a sublist.

getDataList

protected List<? extends GridRow> getDataList()

Gets a list of data.

Returns:

a data list.

getListeners

protected List<EditableModelListener> getListeners()

Gets a list of registered listeners.

Returns:

a list of registered listeners.

prepareEvent

protected void prepareEvent(EditableModelEvent event)

This method prepares the specified event for sending, initilizing necessary fields.

Parameters:

event - is an event to be prepared.

fireEvent

protected void fireEvent(EditableModelEvent event)

This method fires the specified event.

Parameters:

event - is an event to fire.

fireRowEvent

protected void fireRowEvent(EditableModelEvent.EventType eventType,
                int row)

Fires a row change events.

Parameters:

eventType - is a concrete row event type.

row - is a row number.

fireColumnEvent

protected void fireColumnEvent(EditableModelEvent.EventType eventType,
                   int column)

Fires a column change events.

Parameters:

eventType - is a concrete column event type.

column - is a column number.

createEvent

protected EditableModelEvent createEvent(EditableModelEvent.EventType eventType)

Creates a new model event.

Subclasses can override this method to support their own event classes.

Parameters:

eventType - is an event type.

Returns:

a newly constructed event.

createEvent

protected EditableModelEvent createEvent(EditableModelEvent.EventType eventType,
                             int row,
                             int column)

Creates a new model event.

Subclasses can override this method to support their own event classes.

Parameters:

eventType - is an event type.

row - is a row number.

column - is a column number.

Returns:

a newly constructed event.