org.efaps.ui.wicket.models.objects
Class UITable.Filter

java.lang.Object
  org.efaps.ui.wicket.models.objects.UITable.Filter

All Implemented Interfaces:

java.io.Serializable, org.apache.wicket.IClusterable

Enclosing class:

UITable

public class UITable.Filter
extends java.lang.Object
implements org.apache.wicket.IClusterable

Class represents one filter applied to this UITable.

See Also:

Serialized Form

Field Summary

static java.lang.String	FROM Key to the value for "from" in the nap for the esjp.
static java.lang.String	TO Key to the value for "to" in the nap for the esjp.

Constructor Summary

UITable.Filter()
Constructor is used for a database based filter in case that it is required.

UITable.Filter(UITableHeader _uitableHeader)
Constructor is used in case that a filter is required, during loading the date first time for a memory base filter.

UITable.Filter(UITableHeader _uitableHeader, java.util.Set<?> _filterList)
Standard Constructor for a Filter using a PICKLIST.

UITable.Filter(UITableHeader _uitableHeader, java.lang.String _from, java.lang.String _to)
Standard Constructor for a Filter containing a range.

Method Summary

boolean	filterRow(UIRow _uiRow) Method is used for memory based filters to filter one row.
org.joda.time.DateTime	getDateFrom() Getter method for instance variable dateFrom.
org.joda.time.DateTime	getDateTo() Getter method for instance variable dateTo.
java.util.Map<java.lang.String,java.lang.String>	getMap4esjp() Method to get the map that must be passed for this filter to the esjp.
UITableHeader	getUiTableHeader() Getter method for instance variable uiTableHeader.

Methods inherited from class java.lang.Object

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

Field Detail

FROM

public static final java.lang.String FROM

Key to the value for "from" in the nap for the esjp.

See Also:

Constant Field Values

TO

public static final java.lang.String TO

Key to the value for "to" in the nap for the esjp.

See Also:

Constant Field Values

Constructor Detail

UITable.Filter

public UITable.Filter()

Constructor is used for a database based filter in case that it is required.

UITable.Filter

public UITable.Filter(UITableHeader _uitableHeader)
               throws org.efaps.util.EFapsException

Constructor is used in case that a filter is required, during loading the date first time for a memory base filter.

Parameters:

_uitableHeader - UITableHeader this filter lies in

Throws:

org.efaps.util.EFapsException - on error

UITable.Filter

public UITable.Filter(UITableHeader _uitableHeader,
                      java.lang.String _from,
                      java.lang.String _to)

Standard Constructor for a Filter containing a range.

Parameters:

_uitableHeader - UITableHeader this filter lies in

_from - value for from

_to - value for to

UITable.Filter

public UITable.Filter(UITableHeader _uitableHeader,
                      java.util.Set<?> _filterList)

Standard Constructor for a Filter using a PICKLIST.

Parameters:

_uitableHeader - UITableHeader this filter lies in

_filterList - set of values for the filter

Method Detail

getUiTableHeader

public UITableHeader getUiTableHeader()

Getter method for instance variable uiTableHeader.

Returns:

value of instance variable uiTableHeader

getMap4esjp

public java.util.Map<java.lang.String,java.lang.String> getMap4esjp()

Method to get the map that must be passed for this filter to the esjp.

Returns:

Map

filterRow

public boolean filterRow(UIRow _uiRow)

Method is used for memory based filters to filter one row.

Parameters:

_uiRow - UIRow to filter

Returns:

false if the row must be shown to the user, true if the row must be filtered

getDateFrom

public org.joda.time.DateTime getDateFrom()

Getter method for instance variable dateFrom.

Returns:

value of instance variable dateFrom

getDateTo

public org.joda.time.DateTime getDateTo()

Getter method for instance variable dateTo.

Returns:

value of instance variable dateTo