to.etc.domui.component.tbl

Class SimpleSearchModel<T>

java.lang.Object

to.etc.domui.component.tbl.TableModelBase<T>

to.etc.domui.component.tbl.TableListModelBase<T>

to.etc.domui.component.tbl.SimpleSearchModel<T>

All Implemented Interfaces:

IKeyedTableModel<T>, IModifyableTableModel<T>, ISortableTableModel, ITableModel<T>, ITruncateableDataModel, IShelvedListener

public class SimpleSearchModel<T>
extends TableListModelBase<T>
implements IKeyedTableModel<T>, ITruncateableDataModel, ISortableTableModel, IShelvedListener

Author:

Frits Jalvingh Created on Jun 16, 2008

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleSearchModel.ByComparatorSortHelper<T> Implementation of ISortHelper that can be used when sort is specified by sort column comparator.
static interface	SimpleSearchModel.IQuery<T> Functor interface to create some abstract query result.
static class	SimpleSearchModel.SortHelper<T>

Field Summary

Fields inherited from interface to.etc.domui.component.tbl.ITableModel

DEFAULT_MAX_SIZE, IN_MEMORY_FILTER_OR_SORT_MAX_SIZE

Constructor Summary

Constructors

Constructor and Description
SimpleSearchModel(IQueryHandler<T> ss, QCriteria<T> qc)
SimpleSearchModel(NodeBase contextSourceNode, QCriteria<T> qc) EXPERIMENTAL INTERFACE
SimpleSearchModel(NodeBase contextSource, SimpleSearchModel.IQuery<T> q)
SimpleSearchModel(QDataContextFactory ss, QCriteria<T> qc) Use {@link SimpleSearchModel#SimpleSearchModel(IQueryHandler, QCriteria) instead!
SimpleSearchModel(QDataContextFactory f, SimpleSearchModel.IQuery<T> q)

Method Summary

Modifier and Type	Method and Description
void	clear()
T	findRowObject(String key)
QCriteria<T>	getCriteria() Return a criteria for this search which can then be manipulated for sorting.
List<T>	getItems(int start, int end)
protected List<T>	getList()
int	getMaxRowCount() Return the current result row limit.
QCriteria<T>	getQuery()
String	getRowKey(int row)
String	getSortKey() DO NOT USE: Whomever uses the model should define sorting and remember it.
protected void	handleQuerySorting(QCriteria<T> qc)
protected void	initResult()
boolean	isRefreshAfterShelve()
boolean	isSortDescending() DO NOT USE: Whomever uses the model should define sorting and remember it.
boolean	isTruncated() Return true if the result is truncated.
void	onShelve() When the component is shelved we discard all results.
void	onUnshelve()
void	refresh()
void	setCriteria(QCriteria<T> query)
void	setMaxRowCount(int maxRowCount) Set the current result row limit.
void	setRefreshAfterShelve(boolean refreshAfterShelve)
void	sortOn(Comparator<T> sortComparator, String sortComparatorKey, boolean descending) When called, this does a re-query using the specified sortComparator.
void	sortOn(String key, boolean descending) When called this does a re-query using the specified sort property.

Methods inherited from class to.etc.domui.component.tbl.TableListModelBase

add, add, delete, delete, getComparator, getItem, getRows, indexOf, modified, modified, move, setComparator

Methods inherited from class to.etc.domui.component.tbl.TableModelBase

addChangeListener, fireAdded, fireDeleted, fireModelChanged, fireModified, getListeners, removeChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface to.etc.domui.component.tbl.ITableModel

addChangeListener, getRows, removeChangeListener

Constructor Detail

SimpleSearchModel

public SimpleSearchModel(@Nonnull
                         NodeBase contextSourceNode,
                         @Nonnull
                         QCriteria<T> qc)

EXPERIMENTAL INTERFACE

Parameters:

contextSourceNode -

qc -

SimpleSearchModel

public SimpleSearchModel(@Nonnull
                         QDataContextFactory ss,
                         @Nonnull
                         QCriteria<T> qc)

Use {@link SimpleSearchModel#SimpleSearchModel(IQueryHandler, QCriteria) instead!

Parameters:

ss -

qc -

SimpleSearchModel

public SimpleSearchModel(@Nonnull
                         IQueryHandler<T> ss,
                         @Nonnull
                         QCriteria<T> qc)

SimpleSearchModel

public SimpleSearchModel(@Nonnull
                         QDataContextFactory f,
                         @Nonnull
                         SimpleSearchModel.IQuery<T> q)

SimpleSearchModel

public SimpleSearchModel(@Nonnull
                         NodeBase contextSource,
                         @Nonnull
                         SimpleSearchModel.IQuery<T> q)

Method Detail

getQuery

public QCriteria<T> getQuery()

setRefreshAfterShelve

public void setRefreshAfterShelve(boolean refreshAfterShelve)

Parameters:

refreshAfterShelve -

isRefreshAfterShelve

public boolean isRefreshAfterShelve()

getMaxRowCount

public int getMaxRowCount()

Return the current result row limit. When <= 0 the result will have a default limit.

Returns:

setMaxRowCount

public void setMaxRowCount(int maxRowCount)

Set the current result row limit. When <= 0 the result will have a default limit.

handleQuerySorting

protected void handleQuerySorting(QCriteria<T> qc)

getCriteria

@Nonnull
public QCriteria<T> getCriteria()

Return a criteria for this search which can then be manipulated for sorting. Warning: the current implementation allows changing the root's order by ONLY(!). Once altered the new criteria must be set using setCriteria(QCriteria). FIXME This urgently needs to duplicate the query instead of messing around with the original!

Returns:

setCriteria

public void setCriteria(@Nonnull
                        QCriteria<T> query)

isTruncated

public boolean isTruncated()

Description copied from interface: ITruncateableDataModel

Return true if the result is truncated.

Specified by:

isTruncated in interface ITruncateableDataModel

Returns:

initResult

protected void initResult()
                   throws Exception

Throws:

Exception

getList

@Nonnull
protected List<T> getList()
                            throws Exception

Specified by:

getList in class TableListModelBase<T>

Throws:

Exception

getItems

@Nonnull
public List<T> getItems(int start,
                                 int end)
                          throws Exception

Specified by:

getItems in interface ITableModel<T>

Overrides:

getItems in class TableListModelBase<T>

Throws:

Exception

findRowObject

public T findRowObject(String key)
                throws Exception

Specified by:

findRowObject in interface IKeyedTableModel<T>

Throws:

Exception

getRowKey

public String getRowKey(int row)
                 throws Exception

Specified by:

getRowKey in interface IKeyedTableModel<T>

Throws:

Exception

clear

public void clear()

sortOn

public void sortOn(String key,
                   boolean descending)
            throws Exception

When called this does a re-query using the specified sort property.

Specified by:

sortOn in interface ISortableTableModel

Throws:

Exception

sortOn

public void sortOn(Comparator<T> sortComparator,
                   String sortComparatorKey,
                   boolean descending)
            throws Exception

When called, this does a re-query using the specified sortComparator.

Throws:

Exception

getSortKey

@Nullable
public String getSortKey()

Description copied from interface: ISortableTableModel

DO NOT USE: Whomever uses the model should define sorting and remember it. If this model is currently sorted, this returns an identifier (usually a property reference) indicating on which column the thingy is sorted. If the model is unsorted this returns null.

Specified by:

getSortKey in interface ISortableTableModel

Returns:

isSortDescending

public boolean isSortDescending()

Description copied from interface: ISortableTableModel

DO NOT USE: Whomever uses the model should define sorting and remember it. If the set is a sorted set, this returns TRUE if the sort order is descending. The return value is undefined for an unsorted model.

Specified by:

isSortDescending in interface ISortableTableModel

Returns:

onShelve

public void onShelve()
              throws Exception

When the component is shelved we discard all results. This causes a requery when unshelved (when accessed).

Specified by:

onShelve in interface IShelvedListener

Throws:

Exception

See Also:

IShelvedListener.onShelve()

onUnshelve

public void onUnshelve()
                throws Exception

Specified by:

onUnshelve in interface IShelvedListener

Throws:

Exception

refresh

public void refresh()

Specified by:

refresh in interface ITableModel<T>

Overrides:

refresh in class TableModelBase<T>