net.infordata.ifw2.web.jpa

Class AJpaDataGridModel<C>

java.lang.Object

net.infordata.ifw2.web.grds.APojoGridModel<C>

net.infordata.ifw2.web.jpa.AJpaGridModel<C>

net.infordata.ifw2.web.jpa.AJpaDataGridModel<C>

Type Parameters:

C -

All Implemented Interfaces:

java.io.Serializable, IDataGridModel, IGridModel, IPojoGridModel<C>, IReloadableGridModel, IJpaGridModel<C>

public abstract class AJpaDataGridModel<C>
extends AJpaGridModel<C>
implements IDataGridModel

An IDataGridModel able to retrieve data from a jpa data-source. It supports paging.

Author:

valentino.proietti

See Also:

Serialized Form

Field Summary

Fields inherited from class net.infordata.ifw2.web.jpa.AJpaGridModel

DEF_MIN_ROWS_TO_FETCH, MIN_ROWS_TO_FETCH

Constructor Summary

Constructors

Constructor and Description
AJpaDataGridModel(java.lang.Class<C> c)
AJpaDataGridModel(java.lang.Class<C> c, boolean fetchAll)

Method Summary

Methods

Modifier and Type	Method and Description
void	applyFilters(java.lang.String filteredColumnName, java.util.Map<java.lang.String,AFilterDefinition<?>> filters) If IDataGridModel.isFilterable() then this method can be used to change data filter definitions, otherwise you can assume that it is never used.
static <C> java.lang.String	buildOrderBy(java.lang.String ent, AJpaDataGridModel<C> model, java.lang.String sortedColumn, boolean sortedAsc) Deprecated.
static <C> java.lang.String	buildWhereCondition(java.lang.String ent, AJpaDataGridModel<C> model, java.util.Map<java.lang.String,AFilterDefinition<?>> filterDefs, java.lang.String paramPrefix, java.util.Map<java.lang.String,java.lang.Object> params) Deprecated.
boolean	canDoContainsSearch()
boolean	canSearchOnSortedColumn()
void	close()
int	containsSearch(java.lang.String columnName, java.lang.String value, boolean forward, int startFrom)
static <C> javax.persistence.Query	createQuery(javax.persistence.EntityManager em, java.lang.String queryStr, java.lang.String ent, AJpaDataGridModel<C> model, java.util.Map<java.lang.String,AFilterDefinition<?>> filterDefs, java.lang.String sortedColumn, boolean sortedAsc) Deprecated.
static javax.persistence.Query	feedParameters(javax.persistence.Query query, java.util.Map<java.lang.String,java.lang.Object> params) Deprecated.
void	forceReload(boolean restoreCurrentRow) Forces the model to reload data from the external storage at next IGridModel.sync(). It is usable to free up resources.
<VT> java.util.Set<VT>	getCollectedValues(java.lang.Class<VT> clazz, int columnIdx)
<VT> java.util.Set<VT>	getCollectedValues(java.lang.Class<VT> clazz, java.lang.String colName)
abstract javax.persistence.EntityManager	getEntityManager()
java.util.Map<java.lang.String,AFilterDefinition<?>>	getFilters()
java.lang.Boolean	getSortedAscendingIndicator()
java.lang.String	getSortedColumn()
boolean	isFilterable()
boolean	isFilterInMemory()
boolean	isSortable()
IColumn	removeColumn(java.lang.String columnName)
int	searchOnSortedColumn(java.lang.Object value) Rows are fetched from the jpa storage if needed, ie if a result is not found in currently loaded rows.
AJpaDataGridModel<C>	setFilterInMemory(boolean value)
void	setSortedColumn(java.lang.String columnName, boolean ascending) If IDataGridModel.isSortable() then this method is used to change the sort order otherwise you can assume that it is never used.

Methods inherited from class net.infordata.ifw2.web.jpa.AJpaGridModel

fetchAll, fetchedAll, fetchRows, getColumn, getCurrentPojo, getCurrentRow, getCurrentRowCount, getDataVersion, getDataView, getMinRowsToFetch, getPK, getPojo, getRowCount, isFetchingAll, reload, reloadPojo, reloadPojo, setCurrentRow, setFetchAll, setMinRowsToFetch, sync

Methods inherited from class net.infordata.ifw2.web.grds.APojoGridModel

getClassInfo, getColumnCount, getColumnGroup, getColumnGroupsMap, getColumnIndex, getColumnName, getPojoType, getProperty, getPropertyName, getValue, getValueAt, isCurrentRowFreezed, registerColumn, registerColumn, registerColumn, rowIndexOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.infordata.ifw2.web.grds.IGridModel

fetchRows, getColumn, getColumnCount, getColumnGroup, getColumnIndex, getColumnName, getCurrentRow, getCurrentRowCount, getRowCount, getValueAt, isCurrentRowFreezed, setCurrentRow, sync

Methods inherited from interface net.infordata.ifw2.web.grds.IPojoGridModel

getPojoType, getPropertyName, getValue, rowIndexOf

Constructor Detail

AJpaDataGridModel

public AJpaDataGridModel(java.lang.Class<C> c)

AJpaDataGridModel

public AJpaDataGridModel(java.lang.Class<C> c,
                 boolean fetchAll)

Method Detail

setFilterInMemory

public AJpaDataGridModel<C> setFilterInMemory(boolean value)

Parameters:

value - - if true the AJpaGridModel.setFetchAll(boolean) is true

Returns:

isFilterInMemory

public final boolean isFilterInMemory()

forceReload

public void forceReload(boolean restoreCurrentRow)

Description copied from interface: IReloadableGridModel

Forces the model to reload data from the external storage at next IGridModel.sync().
It is usable to free up resources.

Specified by:

forceReload in interface IReloadableGridModel

Overrides:

forceReload in class AJpaGridModel<C>

Parameters:

restoreCurrentRow - - If true the model shall try to restore the old current row.
If the method is called more than one time (with a true value) without an implicit or explicit IGridModel.sync() the current-row at the moment of the first call must be used.

close

public void close()

Overrides:

close in class AJpaGridModel<C>

removeColumn

public IColumn removeColumn(java.lang.String columnName)

Overrides:

removeColumn in class APojoGridModel<C>

Parameters:

columnName -

Returns:

the removed IColumn or null if none.

getEntityManager

public abstract javax.persistence.EntityManager getEntityManager()

Specified by:

getEntityManager in class AJpaGridModel<C>

applyFilters

public void applyFilters(java.lang.String filteredColumnName,
                java.util.Map<java.lang.String,AFilterDefinition<?>> filters)

Description copied from interface: IDataGridModel

If IDataGridModel.isFilterable() then this method can be used to change data filter definitions, otherwise you can assume that it is never used.

Specified by:

applyFilters in interface IDataGridModel

Parameters:

filteredColumnName - - used in case a the filter has been applied on a specific column, otherwise null.
Implementors must clone any AFilterDefinition.

filters - - filters to be applied per column

getFilters

public java.util.Map<java.lang.String,AFilterDefinition<?>> getFilters()

Specified by:

getFilters in interface IDataGridModel

Returns:

an unmodifiable map or null if no filter has been applied.

getSortedAscendingIndicator

public java.lang.Boolean getSortedAscendingIndicator()

Specified by:

getSortedAscendingIndicator in interface IDataGridModel

Returns:

true if sorted in ascending order, false if in descending and null if not sorted.
It is called even if IDataGridModel.isSortable() == false, because the model can be sorted but not sortable (ie the sort order is not changeable with the ui).

getSortedColumn

public final java.lang.String getSortedColumn()

Specified by:

getSortedColumn in interface IDataGridModel

Returns:

the sorted column, null if none.
It is called even if IDataGridModel.isSortable() == false, because the model can be sorted but not sortable (ie the sort order is not changeable with the gui).

isFilterable

public boolean isFilterable()

Specified by:

isFilterable in interface IDataGridModel

Returns:

true by default.

isSortable

public boolean isSortable()

Specified by:

isSortable in interface IDataGridModel

Returns:

true by default.

setSortedColumn

public void setSortedColumn(java.lang.String columnName,
                   boolean ascending)

Description copied from interface: IDataGridModel

If IDataGridModel.isSortable() then this method is used to change the sort order otherwise you can assume that it is never used.

Specified by:

setSortedColumn in interface IDataGridModel

searchOnSortedColumn

public int searchOnSortedColumn(java.lang.Object value)

Rows are fetched from the jpa storage if needed, ie if a result is not found in currently loaded rows.

Specified by:

searchOnSortedColumn in interface IDataGridModel

Returns:

should be "compatible" with Collections.binarySearch(java.util.List, Object).

canSearchOnSortedColumn

public boolean canSearchOnSortedColumn()

Specified by:

canSearchOnSortedColumn in interface IDataGridModel

Returns:

true if IDataGridModel.searchOnSortedColumn(Object) can used.

containsSearch

public int containsSearch(java.lang.String columnName,
                 java.lang.String value,
                 boolean forward,
                 int startFrom)

Specified by:

containsSearch in interface IDataGridModel

Returns:

less than zero if nothing has been found

canDoContainsSearch

public boolean canDoContainsSearch()

Specified by:

canDoContainsSearch in interface IDataGridModel

Returns:

true if #containsSearch(int, String, boolean, int) can be used.

getCollectedValues

public <VT> java.util.Set<VT> getCollectedValues(java.lang.Class<VT> clazz,
                                        java.lang.String colName)

getCollectedValues

public <VT> java.util.Set<VT> getCollectedValues(java.lang.Class<VT> clazz,
                                        int columnIdx)

createQuery

@Deprecated
public static <C> javax.persistence.Query createQuery(javax.persistence.EntityManager em,
                                                 java.lang.String queryStr,
                                                 java.lang.String ent,
                                                 AJpaDataGridModel<C> model,
                                                 java.util.Map<java.lang.String,AFilterDefinition<?>> filterDefs,
                                                 java.lang.String sortedColumn,
                                                 boolean sortedAsc)

Deprecated.

see JpaUtil#createQuery(EntityManager, String, String, IPojoGridModel, Map, String, boolean)

buildWhereCondition

@Deprecated
public static <C> java.lang.String buildWhereCondition(java.lang.String ent,
                                                  AJpaDataGridModel<C> model,
                                                  java.util.Map<java.lang.String,AFilterDefinition<?>> filterDefs,
                                                  java.lang.String paramPrefix,
                                                  java.util.Map<java.lang.String,java.lang.Object> params)

Deprecated.

see JpaUtil#buildWhereCondition(String, IPojoGridModel, Map, String, Map)

feedParameters

@Deprecated
public static javax.persistence.Query feedParameters(javax.persistence.Query query,
                                                java.util.Map<java.lang.String,java.lang.Object> params)

Deprecated.

see JpaUtil.feedParameters(Query, Map)

buildOrderBy

@Deprecated
public static <C> java.lang.String buildOrderBy(java.lang.String ent,
                                           AJpaDataGridModel<C> model,
                                           java.lang.String sortedColumn,
                                           boolean sortedAsc)

Deprecated.

see JpaUtil#buildOrderBy(String, IPojoGridModel, String, boolean)