org.ujorm.wicket.component.grid

Class UjoDataProvider<T extends OrmUjo>

java.lang.Object

org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider<T,Object>

org.ujorm.wicket.component.grid.UjoDataProvider<T>

All Implemented Interfaces:

Serializable, org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortStateLocator<Object>, org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<T,Object>, org.apache.wicket.markup.repeater.data.IDataProvider<T>, org.apache.wicket.model.IDetachable, org.apache.wicket.util.io.IClusterable

public class UjoDataProvider<T extends OrmUjo>
extends org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider<T,Object>

This class called UjoDataProvider is an database Wicket DataProvider. For a customization you can use a your own IColumn implementations or you can owerwrite selected methods of this provider.

The implementation generates two database requests per a one rendering, the first one get size and the second one get paged data. You can owerwrite the two data methods: iterator() and the size() for more optimization.

The current class uses a WicketApplication implementation, which must implement the interface OrmHandlerProvider for an ORM support. See the example:

See the simple sample:

 Criterion<Hotel> allActiveHotels = Hotel.ACTIVE.whereEq(true);
  UjoDataProvider<Hotel> dataProvider = UjoDataProvider.of(allActiveHotels);

  dataProvider.addColumn(Hotel.NAME);
  dataProvider.addColumn(Hotel.CITY.add(City.NAME)); // An example of relations
  dataProvider.addColumn(Hotel.STREET);
  dataProvider.addColumn(Hotel.PRICE);
  dataProvider.addColumn(KeyColumn.of(Hotel.CURRENCY, SORTING_OFF));
  dataProvider.addColumn(Hotel.STARS);
  dataProvider.addColumn(Hotel.PHONE);
  dataProvider.setSort(Hotel.NAME);

  panel.add(dataProvider.createDataTable("datatable", 10));
 
 

Author:

Pavel Ponec

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T>>	criterion Data criterion model
static String	DEFAULT_DATATABLE_ID Default Datatable ID have got value "datatable".
protected KeyRing<T>	model Domain model
protected Long	size Data size

Constructor Summary

Constructors

Constructor and Description
UjoDataProvider(org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T>> criterion) Constructor
UjoDataProvider(org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T>> criterion, Key<T,?> defaultSort) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,?> column) Add table column
<V> boolean	add(Key<T,V> column) Add table column according to column type
<V> boolean	add(Key<T,V> column, CssAppender cssClass) Add table column according to column type including CSS class
<S> org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable<T,S>	createDataTable(int rowsPerPage) Create AJAX-based DataTable with a DEFAULT_DATATABLE_ID
<S> org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable<T,S>	createDataTable(String id, int rowsPerPage) Create AJAX-based DataTable
protected Query<T>	createQuery(org.ujorm.criterion.Criterion<T> criterion) Create default Query
void	detach() Commit and close transaction
protected void	fetchDatabaseColumns(Query<T> query) The method reduces a lazy database requests from relational table columns.
List<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,?>>	getColumns() Transient tableOf columns
KeyRing<T>	getModel() Get a bean Model
protected Session	getOrmSession() Returns orm Session
Key<T,?>	getSortKey() Vrací klíč pro řazení
boolean	isDefaultColumnSorting() Default column sorting for the method #addColumn(org.ujorm.Key) where the feature is enabled by default
boolean	isFetchDatabaseColumns() Fetch database columns for better SQL performance where the feature is enabled by default
protected boolean	isSortingEnabled(Key<T,?> column) The sorting is enabled for a persistent Ujorm Key by default
Iterator<T>	iterator(long first, long count) Build a JDBC ResultSet allways.
org.apache.wicket.model.IModel<T>	model(T object) Create a model
static <T extends OrmUjo> UjoDataProvider<T>	of(org.ujorm.criterion.Criterion<T> criterion) Factory for the class
static <T extends OrmUjo> UjoDataProvider<T>	of(org.ujorm.criterion.Criterion<T> criterion, Key<T,?> defaultSort) Factory for the class
static <T extends OrmUjo> UjoDataProvider<T>	of(org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T>> criterion) Factory for the class
static <T extends OrmUjo> UjoDataProvider<T>	of(org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T>> criterion, Key<T,?> defaultSort) Factory for the class
void	setCssClass(Key<T,?> key, String cssClass) Assign a CSS class to a KeyColumn, if exists
void	setDefaultColumnSorting(boolean defaultColumnSorting) Default column sorting for the method #addColumn(org.ujorm.Key) where the feature is enabled by default
void	setFetchDatabaseColumns(boolean fetchDatabaseColumns) Fetch database columns for better SQL performance where the feature is enabled by default
void	setSort(Key<T,?> property) Sets the current sort state and assign the BaseClass
long	size() Method calculate the size using special SQL requst.
protected void	sortDatabaseQuery(Query<T> query) Add sorting to a database Query, an empty method causes a natural sorting from database

Methods inherited from class org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider

getSort, getSortState, setSort, setSort

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATATABLE_ID

public static final String DEFAULT_DATATABLE_ID

Default Datatable ID have got value "datatable".

See Also:

Constant Field Values

size

protected Long size

Data size

criterion

protected org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T extends OrmUjo>> criterion

Data criterion model

model

protected KeyRing<T extends OrmUjo> model

Domain model

Constructor Detail

UjoDataProvider

public UjoDataProvider(org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T>> criterion)

Constructor

Parameters:

criterion - Condition to a database query

UjoDataProvider

public UjoDataProvider(org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T>> criterion,
               Key<T,?> defaultSort)

Constructor

Parameters:

criterion - Model of a condition to a database query

defaultSort - Default sorting can be assigned optionally

Method Detail

setSort

public final void setSort(Key<T,?> property)

Sets the current sort state and assign the BaseClass

Parameters:

property - sort property

order - sort order

getSortKey

public Key<T,?> getSortKey()

Vrací klíč pro řazení

iterator

public Iterator<T> iterator(long first,
                   long count)

Build a JDBC ResultSet allways. Overwrite the method for an optimization.

size

public long size()

Method calculate the size using special SQL requst. Overwrite the method for an optimization.
Original documentation:

getOrmSession

protected Session getOrmSession()

Returns orm Session

detach

public void detach()

Commit and close transaction

Specified by:

detach in interface org.apache.wicket.model.IDetachable

Overrides:

detach in class org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider<T extends OrmUjo,Object>

createQuery

protected Query<T> createQuery(org.ujorm.criterion.Criterion<T> criterion)

Create default Query

getModel

public KeyRing<T> getModel()

Get a bean Model

model

public org.apache.wicket.model.IModel<T> model(T object)

Create a model

add

public boolean add(org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,?> column)

Add table column

add

public <V> boolean add(Key<T,V> column,
              CssAppender cssClass)

Add table column according to column type including CSS class

add

public <V> boolean add(Key<T,V> column)

Add table column according to column type

isSortingEnabled

protected boolean isSortingEnabled(Key<T,?> column)
                            throws IllegalArgumentException

The sorting is enabled for a persistent Ujorm Key by default

Throws:

IllegalArgumentException

See Also:

isDefaultColumnSorting()

createDataTable

public <S> org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable<T,S> createDataTable(int rowsPerPage)

Create AJAX-based DataTable with a DEFAULT_DATATABLE_ID

createDataTable

public <S> org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable<T,S> createDataTable(String id,
                                                                                              int rowsPerPage)

Create AJAX-based DataTable

fetchDatabaseColumns

protected void fetchDatabaseColumns(Query<T> query)

The method reduces a lazy database requests from relational table columns. The current implementation assigns all direct keys/columns from domain entity and all required keys/columns from the IColumn object.
Note: You can overwrite the method for a different behaviour.
Note: If the implementation will be empty, so all related attributes will be lazy loaded, so it can be a performance problem in some cases.

See Also:

isFetchDatabaseColumns()

sortDatabaseQuery

protected void sortDatabaseQuery(Query<T> query)

Add sorting to a database Query, an empty method causes a natural sorting from database

isDefaultColumnSorting

public final boolean isDefaultColumnSorting()

Default column sorting for the method #addColumn(org.ujorm.Key) where the feature is enabled by default

Returns:

the defaultColumnSorting

setDefaultColumnSorting

public void setDefaultColumnSorting(boolean defaultColumnSorting)

Default column sorting for the method #addColumn(org.ujorm.Key) where the feature is enabled by default

Parameters:

defaultColumnSorting - the defaultColumnSorting to set

isFetchDatabaseColumns

public final boolean isFetchDatabaseColumns()

Fetch database columns for better SQL performance where the feature is enabled by default

Returns:

the fetchDatabaseColumns

setFetchDatabaseColumns

public void setFetchDatabaseColumns(boolean fetchDatabaseColumns)

Fetch database columns for better SQL performance where the feature is enabled by default

Parameters:

fetchDatabaseColumns - the fetchDatabaseColumns to set

getColumns

public List<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,?>> getColumns()

Transient tableOf columns

of

public static <T extends OrmUjo> UjoDataProvider<T> of(org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T>> criterion,
                                       Key<T,?> defaultSort)

Factory for the class

of

public static <T extends OrmUjo> UjoDataProvider<T> of(org.apache.wicket.model.IModel<org.ujorm.criterion.Criterion<T>> criterion)

Factory for the class

of

public static <T extends OrmUjo> UjoDataProvider<T> of(org.ujorm.criterion.Criterion<T> criterion,
                                       Key<T,?> defaultSort)

Factory for the class

of

public static <T extends OrmUjo> UjoDataProvider<T> of(org.ujorm.criterion.Criterion<T> criterion)

Factory for the class

setCssClass

public void setCssClass(Key<T,?> key,
               String cssClass)

Assign a CSS class to a KeyColumn, if exists