org.gwt.advanced.client.datamodel

Class HierarchicalGridDataModel

java.lang.Object

org.gwt.advanced.client.datamodel.HierarchicalGridDataModel

All Implemented Interfaces:

Editable, GridDataModel, Hierarchical, Pageable

Direct Known Subclasses:

LazyHierarchicalGridDataModel

public class HierarchicalGridDataModel
extends Object
implements Hierarchical

This is a hierarchical grid data model (experimental).

Since:

1.1.0

Author:

Sergey Skladchikov

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HierarchicalGridDataModel(DataModelCallbackHandler<Editable> handler) Creates a new instnace of this class and defines the handler.
	HierarchicalGridDataModel(Object[][] data) Initializes the model with the preloaded piece of data set.

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 a column into the model.
void	addListener(EditableModelListener listener) This method registers the specified listener to receive model events.
void	addRow(int beforeRow, Object[] row) This method adds a row into the model.
void	addSubgridModel(int rowNumber, int columnNumber, GridDataModel model) Adds a subgrid model to the specified cell.
void	clearRemovedRows() This method clears removed rows from the model history
String[]	getColumnNames() This method gets a list of column names.
GridColumn[]	getColumns() Gets an array of all model columns.
int	getCurrentPageNumber() This method gets a current page number.
Object[][]	getData() This method returns all the data contained in the model.
protected EditableGridDataModel	getDelegate() Getter for property 'delegate'.
int	getDisplayedPages() This method gets the number of pages links to be displayed.
int	getEndPage() This method returns an end page number.
int	getEndRow() This method returns an end row number.
GridColumn	getGridColumn(int index) Gets a grid column by index.
DataModelCallbackHandler<Editable>	getHandler() This method returns a callback handler instance.
int	getPageSize() This method returns a page size.
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 all rows of the model.
int	getSortColumn() This method returns a sorted column number.
int	getStartPage() This method returns a start page number.
int	getStartRow() This method returns a start row number.
GridDataModel	getSubgridModel(int rowNumber, int columnNumber) This method gets a subgrid model associated with the specified cell.
int	getTotalColumnCount() This method returns a total row count.
int	getTotalPagesNumber() This method returns a number of existing pages.
int	getTotalRowCount() This method returns total row count value.
boolean	isAscending() This method defines sorting direction.
boolean	isEmpty() This method checks whether the data model is empty.
boolean	isExpanded(int row, int column) This method checks whether the specified cell is expanded.
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 removes a column from the model.
void	removeListener(EditableModelListener listener) This method unregisters the specified listener to stop model events receiving.
void	removeRow(int rowNumber) This method removes a row from the model.
void	setAscending(boolean ascending) This method sets sort direction.
protected void	setAssociatedSubgrids(Map<SubgridKey,GridDataModel> associatedSubgrids) Setter for property 'associatedSubgrids'.
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	setCurrentPageNumber(int currentPageNumber) This method sets the current page number.
protected void	setDelegate(EditableGridDataModel delegate) Setter for property 'delegate'.
void	setDisplayedPages(int displayedPages) This method sets the number of pages links to be displayed.
void	setExpanded(int row, int column, boolean expanded) This method sets expanded flag for the specified cell.
protected void	setExpandedCells(Map<SubgridKey,Boolean> expandedCells) Setter for property 'expandedCells'.
void	setHandler(DataModelCallbackHandler<Editable> handler) This method sets a callback handler.
void	setPageSize(int pageSize) This method sets a page size.
void	setSortColumn(int sortColumn) This method sets a number of sort column.
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) This method updates data in the model using the specified value.
void	updateColumn(int columnNumber, Object[] column) This method updates a column with the specified data set.
void	updateColumn(String name, Object[] column) This method updates a column with the specified data set.
void	updateRow(int rowNumber, Object[] row) This method updates a row with the specified data set.

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchicalGridDataModel

public HierarchicalGridDataModel(Object[][] data)

Initializes the model with the preloaded piece of data set.

Parameters:

data - is a data set piece.

HierarchicalGridDataModel

protected HierarchicalGridDataModel(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

addSubgridModel

public void addSubgridModel(int rowNumber,
                   int columnNumber,
                   GridDataModel model)
                     throws IllegalArgumentException

Adds a subgrid model to the specified cell.

Specified by:

addSubgridModel in interface Hierarchical

Parameters:

rowNumber - is a row number.

columnNumber - is a column number.

model - is a model to add.

Throws:

IllegalArgumentException - if the row / column number is out of range.

getSubgridModel

public GridDataModel getSubgridModel(int rowNumber,
                            int columnNumber)
                              throws IllegalArgumentException

This method gets a subgrid model associated with the specified cell.

If there is no such model, it returns null.

Specified by:

getSubgridModel in interface Hierarchical

Parameters:

rowNumber - is a row number.

columnNumber - is a column number.

Returns:

a subgrid model.

Throws:

IllegalArgumentException - if the row / column number is out of range.

setExpanded

public void setExpanded(int row,
               int column,
               boolean expanded)

This method sets expanded flag for the specified cell.

Specified by:

setExpanded in interface Hierarchical

Parameters:

row - is a row number.

column - is a column number.

expanded - is an expanded flag value.

isExpanded

public boolean isExpanded(int row,
                 int column)

This method checks whether the specified cell is expanded.

Specified by:

isExpanded in interface Hierarchical

Parameters:

row - is a row number.

column - is a column number.

Returns:

an expanded falg value.

setAssociatedSubgrids

protected void setAssociatedSubgrids(Map<SubgridKey,GridDataModel> associatedSubgrids)

Setter for property 'associatedSubgrids'.

Parameters:

associatedSubgrids - Value to set for property 'associatedSubgrids'.

setExpandedCells

protected void setExpandedCells(Map<SubgridKey,Boolean> expandedCells)

Setter for property 'expandedCells'.

Parameters:

expandedCells - Value to set for property 'expandedCells'.

addRow

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

This method adds a row into the model.

Specified by:

addRow in interface Editable

Parameters:

beforeRow - is a row number.

row - is row data.

Throws:

IllegalArgumentException - if the row number is invalid.

updateRow

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

This method updates a row with the specified data set.

Specified by:

updateRow in interface Editable

Parameters:

rowNumber - is a row number.

row - is row data.

Throws:

IllegalArgumentException - if the row number is invalid.

removeRow

public void removeRow(int rowNumber)
               throws IllegalArgumentException

This method removes a row from the model.

Specified by:

removeRow in interface Editable

Parameters:

rowNumber - is a row number.

Throws:

IllegalArgumentException - if the row number is invalid.

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 a column into the model.

Specified by:

addColumn in interface Editable

Parameters:

beforeColumn - a column number.

name - a column name.

column - a column data set.

Throws:

IllegalArgumentException - if the column number is invalid.

updateColumn

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

This method updates a column with the specified data set.

Specified by:

updateColumn in interface Editable

Parameters:

columnNumber - a column number.

column - a column data set.

Throws:

IllegalArgumentException - if the column number is invalid.

updateColumn

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

This method updates a column with the specified data set.

Specified by:

updateColumn in interface Editable

Parameters:

name - a column name.

column - a column data set.

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 removes a column from the model.

Specified by:

removeColumn in interface Editable

Parameters:

name - a column name.

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)
            throws IllegalArgumentException

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.

Throws:

IllegalArgumentException - if row and / or column number is invalid.

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.

getHandler

public DataModelCallbackHandler<Editable> getHandler()

This method returns a callback handler instance.

Specified by:

getHandler in interface Editable

Returns:

a callback handler.

update

public void update(Object[][] data)

This method updates data in the model using the specified value.

Specified by:

update in interface Editable

Parameters:

data - is a data to be placed.

setHandler

public void setHandler(DataModelCallbackHandler<Editable> handler)

This method sets a callback handler.

Specified by:

setHandler in interface Editable

Parameters:

handler - a callback handler.

getTotalColumnCount

public int getTotalColumnCount()

This method returns a total row count.

Specified by:

getTotalColumnCount in interface Editable

Returns:

a total row count.

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

getRows

public GridRow[] getRows()

This method returns all rows of the model.

Specified by:

getRows in interface Editable

Returns:

a grid row array.

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.

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.

getTotalRowCount

public int getTotalRowCount()

This method returns total row count value.

Specified by:

getTotalRowCount in interface GridDataModel

Returns:

a total rows number.

getStartRow

public int getStartRow()

This method returns a start row number.

Specified by:

getStartRow in interface GridDataModel

Returns:

a start row number.

getEndRow

public int getEndRow()

This method returns an end row number.

Specified by:

getEndRow in interface GridDataModel

Returns:

an end row number.

getSortColumn

public int getSortColumn()

This method returns a sorted column number.

Specified by:

getSortColumn in interface GridDataModel

Returns:

a sortable column number.

isAscending

public boolean isAscending()

This method defines sorting direction.

It returns true if direction is ascending.

Specified by:

isAscending in interface GridDataModel

Returns:

false if sorting is descending.

getRowData

public Object[] getRowData(int rowNumber)

This method returns row data by the specified row number.

Specified by:

getRowData in interface GridDataModel

Parameters:

rowNumber - is a number of row to be returned.

Returns:

row data.

setSortColumn

public void setSortColumn(int sortColumn)

This method sets a number of sort column.

Specified by:

setSortColumn in interface GridDataModel

Parameters:

sortColumn - a number of sort column.

setAscending

public void setAscending(boolean ascending)

This method sets sort direction.

Specified by:

setAscending in interface GridDataModel

Parameters:

ascending - sort direction.

isEmpty

public boolean isEmpty()

This method checks whether the data model is empty.

Specified by:

isEmpty in interface GridDataModel

Returns:

true if the model is empty.

getData

public Object[][] getData()

This method returns all the data contained in the model.

Specified by:

getData in interface GridDataModel

Returns:

data

setPageSize

public void setPageSize(int pageSize)

This method sets a page size.

Specified by:

setPageSize in interface Pageable

Parameters:

pageSize - is a page size.

setCurrentPageNumber

public void setCurrentPageNumber(int currentPageNumber)
                          throws IllegalArgumentException

This method sets the current page number.

Specified by:

setCurrentPageNumber in interface Pageable

Parameters:

currentPageNumber - is a current page number.

Throws:

IllegalArgumentException - if current page number less then zero or greater then actual number of pages.

getTotalPagesNumber

public int getTotalPagesNumber()

This method returns a number of existing pages.

Specified by:

getTotalPagesNumber in interface Pageable

Returns:

a total pages number.

getStartPage

public int getStartPage()

This method returns a start page number.

Specified by:

getStartPage in interface Pageable

Returns:

is a start page number.

getEndPage

public int getEndPage()

This method returns an end page number.

Specified by:

getEndPage in interface Pageable

Returns:

is an end page number.

getDisplayedPages

public int getDisplayedPages()

This method gets the number of pages links to be displayed.

Specified by:

getDisplayedPages in interface Pageable

Returns:

is a number of pages.

setDisplayedPages

public void setDisplayedPages(int displayedPages)

This method sets the number of pages links to be displayed.

Specified by:

setDisplayedPages in interface Pageable

Parameters:

displayedPages - is a number of pages.

getPageSize

public int getPageSize()

This method returns a page size.

Specified by:

getPageSize in interface Pageable

Returns:

a page size (number of displayable rows).

getCurrentPageNumber

public int getCurrentPageNumber()

This method gets a current page number.

Specified by:

getCurrentPageNumber in interface Pageable

Returns:

a current page number.

getDelegate

protected EditableGridDataModel getDelegate()

Getter for property 'delegate'.

Returns:

Value for property 'delegate'.

setDelegate

protected void setDelegate(EditableGridDataModel delegate)

Setter for property 'delegate'.

Parameters:

delegate - Value to set for property 'delegate'.