com.whitestein.lsps.vaadin.forms.datasource

Class DataSourceMethods

java.lang.Object

com.whitestein.lsps.vaadin.forms.datasource.DataSourceMethods

public class DataSourceMethods
extends Object

These methods are called from QueryDataSource.methods and TypeDataSource.methods files in standard lib.

Author:

mvo

Constructor Summary

Constructors

Constructor and Description
DataSourceMethods()

Method Summary

Modifier and Type	Method and Description
Decimal	getQueryDataSourceCount(ExecutionContext ctx, CollectionHolder filters) How many filtered records exists in the data source.
ListHolder	getQueryDataSourceData(ExecutionContext ctx, Decimal startIndex, Decimal count, CollectionHolder filters, SetHolder sortSpecs) All filtered records of the data source sorted by sort spec
Decimal	getTypeDataSourceCount(ExecutionContext ctx, CollectionHolder filters) How many filtered records of that type exists.
ListHolder	getTypeDataSourceData(ExecutionContext ctx, Decimal startIndex, Decimal count, CollectionHolder filters, SetHolder sortSpecs) All filtered records of that type sorted by sort spec
Boolean	supportsFilter(ExecutionContext ctx, RecordHolder filter) Checks whether query based data sources are able to handle this filter natively.
Boolean	supportsSort(ExecutionContext ctx, RecordHolder sort) Checks whether query based data sources are able to handle this sort natively.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceMethods

public DataSourceMethods()

Method Detail

supportsFilter

public Boolean supportsFilter(ExecutionContext ctx,
                              RecordHolder filter)
                       throws ErrorException

Checks whether query based data sources are able to handle this filter natively. E.g. whether the filter has property path and whether it is not RegexpFilter. (Question mna: is this condition still sufficient?)

Parameters:

ctx -

filter -

Returns:

whether the datasource accepts the filter.

Throws:

ErrorException

supportsSort

public Boolean supportsSort(ExecutionContext ctx,
                            RecordHolder sort)
                     throws ErrorException

Checks whether query based data sources are able to handle this sort natively. E.g. whether the filter has property path. (Question mna: is this condition still sufficient?)

Parameters:

ctx -

sort -

Returns:

whether the datasource accepts the sort.

Throws:

ErrorException

getTypeDataSourceCount

public Decimal getTypeDataSourceCount(ExecutionContext ctx,
                                      CollectionHolder filters)
                               throws ErrorException

How many filtered records of that type exists.

Parameters:

ctx -

filters -

Returns:

count of records

Throws:

ErrorException

getTypeDataSourceData

public ListHolder getTypeDataSourceData(ExecutionContext ctx,
                                        Decimal startIndex,
                                        Decimal count,
                                        CollectionHolder filters,
                                        SetHolder sortSpecs)
                                 throws ErrorException

All filtered records of that type sorted by sort spec

Parameters:

ctx -

startIndex -

count -

filters -

sortSpecs -

Returns:

records

Throws:

ErrorException

getQueryDataSourceCount

public Decimal getQueryDataSourceCount(ExecutionContext ctx,
                                       CollectionHolder filters)
                                throws ErrorException

How many filtered records exists in the data source.

Parameters:

ctx -

filters -

Returns:

count of recordss

Throws:

ErrorException

getQueryDataSourceData

public ListHolder getQueryDataSourceData(ExecutionContext ctx,
                                         Decimal startIndex,
                                         Decimal count,
                                         CollectionHolder filters,
                                         SetHolder sortSpecs)
                                  throws ErrorException

All filtered records of the data source sorted by sort spec

Parameters:

ctx -

startIndex -

count -

filters -

sortSpecs -

Returns:

records

Throws:

ErrorException