net.infordata.ifw2.web.grds

Class APojoCrossModel<T>

java.lang.Object

net.infordata.ifw2.web.grds.APojoCrossModel<T>

All Implemented Interfaces:

java.io.Serializable, IGridModel, IPojoGridModel<APojoCrossModel.Row<T>>

public abstract class APojoCrossModel<T>
extends java.lang.Object
implements IPojoGridModel<APojoCrossModel.Row<T>>, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APojoCrossModel.Cell<T>
static class	APojoCrossModel.Column
static class	APojoCrossModel.DataColumn<T>
static class	APojoCrossModel.IndentColumn
static class	APojoCrossModel.Row<T>

Constructor Summary

Constructors

Constructor and Description
APojoCrossModel(IPojoGridModel<T> model, java.util.Comparator<T> vComp, java.util.Comparator<T> hComp)
APojoCrossModel(IPojoGridModel<T> model, java.util.Comparator<T> vComp, java.util.Comparator<T> hComp, int indentCols)

Method Summary

Methods

Modifier and Type	Method and Description
int	fetchRows(int rowIndex, int count) Used by the ui to ensure that the request rows really exist without the need to retrieve any column value. The ui is simply saying that it wants to get access to the given rows.
APojoCrossModel.Cell<T>	getCell(APojoCrossModel.Row<T> pojo, int columnIndex)
APojoCrossModel.Cell<T>	getCell(int rowIndex, int columnIndex)
abstract java.lang.Object	getCellValue(APojoCrossModel.Cell<T> cell, int columnIndex)
APojoCrossModel.Column	getColumn(int columnIndex)
int	getColumnCount()
IColumnGroup	getColumnGroup(java.lang.String groupId)
java.util.Map<java.lang.String,IColumnGroup>	getColumnGroupsMap()
int	getColumnIndex(java.lang.String columnName)
java.lang.String	getColumnName(int columnIndex)
APojoCrossModel.Cell<T>	getCurrentCell(int columnIndex)
APojoCrossModel.Cell<T>	getCurrentCell(java.lang.String columnName)
APojoCrossModel.Row<T>	getCurrentPojo()
int	getCurrentRow()
int	getCurrentRowCount()
int	getDataVersion()
java.util.List<APojoCrossModel.Row<T>>	getDataView()
java.util.List<APojoCrossModel.IndentColumn>	getIndentColumns()
abstract java.lang.Object	getIndentValue(APojoCrossModel.Row<T> pojo, int columnIndex)
APojoCrossModel.Row<T>	getPojo(int rowIndex)
java.lang.Class<APojoCrossModel.Row<T>>	getPojoType()
java.lang.String	getPropertyName(int columnIndex)
int	getRowCount()
java.lang.Object	getValue(APojoCrossModel.Row<T> pojo, int columnIndex)
java.lang.Object	getValueAt(int rowIndex, int columnIndex)
java.lang.String	gotoCellPojo(T cellPojo)
boolean	isCurrentRowFreezed()
int	rowIndexOf(APojoCrossModel.Row<T> pojo)
APojoCrossModel<T>	setComparators(java.util.Comparator<T> vComp, java.util.Comparator<T> hComp)
void	setCurrentRow(int rowIndex)
void	sync() Called by the framework just before displaying the AGridFlow. Here is where the model can, as an example, ensure that depending sub models are synchronized or to restore data after a serialization. Keep in mind that after synchronizing the model internal state can be changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

APojoCrossModel

public APojoCrossModel(IPojoGridModel<T> model,
               java.util.Comparator<T> vComp,
               java.util.Comparator<T> hComp)

APojoCrossModel

public APojoCrossModel(IPojoGridModel<T> model,
               java.util.Comparator<T> vComp,
               java.util.Comparator<T> hComp,
               int indentCols)

Method Detail

getIndentColumns

public final java.util.List<APojoCrossModel.IndentColumn> getIndentColumns()

getColumnGroupsMap

public final java.util.Map<java.lang.String,IColumnGroup> getColumnGroupsMap()

getColumnGroup

public IColumnGroup getColumnGroup(java.lang.String groupId)

Specified by:

getColumnGroup in interface IGridModel

Returns:

if null then default behaviors and values are assumed.

setComparators

public APojoCrossModel<T> setComparators(java.util.Comparator<T> vComp,
                                java.util.Comparator<T> hComp)

Parameters:

vComp - comparator used for rows

hComp - comparator used for cols

Returns:

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface IGridModel

getColumnIndex

public int getColumnIndex(java.lang.String columnName)

Specified by:

getColumnIndex in interface IGridModel

Returns:

less than 0 if not found.

getColumn

public APojoCrossModel.Column getColumn(int columnIndex)

Specified by:

getColumn in interface IGridModel

Returns:

always not null otherwise an exception is thrown if the column doesn't exist.

getColumnName

public java.lang.String getColumnName(int columnIndex)

Specified by:

getColumnName in interface IGridModel

getCurrentRowCount

public int getCurrentRowCount()

Specified by:

getCurrentRowCount in interface IGridModel

Returns:

the currently loaded rows, generally it is equal to IGridModel.getRowCount() but can be less if the model supports paging.

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface IGridModel

Returns:

the row count, if not known yet Integer.MAX_VALUE.

sync

public void sync()

Description copied from interface: IGridModel

Called by the framework just before displaying the AGridFlow.
Here is where the model can, as an example, ensure that depending sub models are synchronized or to restore data after a serialization.
Keep in mind that after synchronizing the model internal state can be changed.

Specified by:

sync in interface IGridModel

getValueAt

public java.lang.Object getValueAt(int rowIndex,
                          int columnIndex)
                            throws OutOfBoundsException

Specified by:

getValueAt in interface IGridModel

Returns:

the value for the given coordinates.

Throws:

OutOfBoundsException - - used by models providing data pagination.
The contract, for paging models, is:
- for sequential access, when a row is requested, the model must ensure that also the next row is loaded, if it does not exist, IGridModel.getRowCount() must return the "real" value. - if a requested row does not exist (because of random access), the OutOfBoundsException must be thrown, and next IGridModel.getRowCount() requests must return the "real" value and the IGridModel.getCurrentRow() method must return a valid current row.

fetchRows

public int fetchRows(int rowIndex,
            int count)

Description copied from interface: IGridModel

Used by the ui to ensure that the request rows really exist without the need to retrieve any column value.
The ui is simply saying that it wants to get access to the given rows.

Specified by:

fetchRows in interface IGridModel

Parameters:

rowIndex - - starting from this index ...

count - - ... we want this number of rows

Returns:

the real number of rows founded.
Returning a number less than the requested number of rows means that the last row has been finally reached, in this case a following call to IGridModel.getRowCount() must return the real rows counter and a call to IGridModel.getCurrentRow() a valid row index.

getCurrentRow

public int getCurrentRow()

Specified by:

getCurrentRow in interface IGridModel

Returns:

the current row, a number less than 0 means none.

setCurrentRow

public void setCurrentRow(int rowIndex)

Specified by:

setCurrentRow in interface IGridModel

isCurrentRowFreezed

public boolean isCurrentRowFreezed()

Specified by:

isCurrentRowFreezed in interface IGridModel

Returns:

true if some sort of editing is happening on the current row, this freezes the current row.

getPojo

public APojoCrossModel.Row<T> getPojo(int rowIndex)
                               throws OutOfBoundsException

Specified by:

getPojo in interface IPojoGridModel<APojoCrossModel.Row<T>>

Returns:

the pojo object at the given index.

Throws:

OutOfBoundsException - - The contract defined in IGridModel.getValueAt(int, int) must be respected.

rowIndexOf

public int rowIndexOf(APojoCrossModel.Row<T> pojo)

Specified by:

rowIndexOf in interface IPojoGridModel<APojoCrossModel.Row<T>>

Returns:

the row index of the given pojo.

getCurrentPojo

public APojoCrossModel.Row<T> getCurrentPojo()

Specified by:

getCurrentPojo in interface IPojoGridModel<APojoCrossModel.Row<T>>

Returns:

the current pojo, null if none.

getPojoType

public java.lang.Class<APojoCrossModel.Row<T>> getPojoType()

Specified by:

getPojoType in interface IPojoGridModel<APojoCrossModel.Row<T>>

getCurrentCell

public APojoCrossModel.Cell<T> getCurrentCell(java.lang.String columnName)

Parameters:

columnName -

Returns:

the cell of the current row.

getCurrentCell

public APojoCrossModel.Cell<T> getCurrentCell(int columnIndex)

Parameters:

columnName -

Returns:

the cell of the current row.

getCell

public APojoCrossModel.Cell<T> getCell(int rowIndex,
                              int columnIndex)

getCell

public APojoCrossModel.Cell<T> getCell(APojoCrossModel.Row<T> pojo,
                              int columnIndex)

getValue

public java.lang.Object getValue(APojoCrossModel.Row<T> pojo,
                        int columnIndex)

Specified by:

getValue in interface IPojoGridModel<APojoCrossModel.Row<T>>

Parameters:

pojo - - the pojo to extract value from.

columnIndex - - the columnIndex which must be mapped to a pojo property or to a computed value.

Returns:

the pojo property value for the given column.

getIndentValue

public abstract java.lang.Object getIndentValue(APojoCrossModel.Row<T> pojo,
                              int columnIndex)

getCellValue

public abstract java.lang.Object getCellValue(APojoCrossModel.Cell<T> cell,
                            int columnIndex)

getDataView

public java.util.List<APojoCrossModel.Row<T>> getDataView()

Specified by:

getDataView in interface IPojoGridModel<APojoCrossModel.Row<T>>

Returns:

A read-only snapshot list reflecting any sort order or filter applied, it is unmodifiable but can change if "back-end" collection or data changes.
In case of paging, it contains only pojos already fetched, and its size must be equal to IGridModel.getCurrentRowCount().

getDataVersion

public int getDataVersion()

Specified by:

getDataVersion in interface IPojoGridModel<APojoCrossModel.Row<T>>

Returns:

The value must change any time one or more CRUD operations have been completed on the content model and after the model has been synchronized (see IGridModel.sync().
This can be used by wrapping models to update their state when the wrapped model changes.

getPropertyName

public java.lang.String getPropertyName(int columnIndex)

Specified by:

getPropertyName in interface IPojoGridModel<APojoCrossModel.Row<T>>

Returns:

null if the column is not related to a pojo property, otherwise the property name which can be different from the column name.

gotoCellPojo

public java.lang.String gotoCellPojo(T cellPojo)

Parameters:

cellPojo -

Returns:

null if not found, otherwise the name of the column containing the object and the current row is positioned on the row containing the object.