Java Doc for FilterHelper.java in  » Web-Framework » aranea-mvc-1.1.1 » org » araneaframework » uilib » list » structure » filter » Java Source Code / Java DocumentationJava Source Code and Java Documentation

THe following filters can be added to the list: EqualFilter , GreaterThanFilter , LowerThanFilter , LikeFilter , NullFilter , RangeFilter , RangeInRangeFilter , SqlFunctionFilter .

There are many methods for adding each filter and their form elements. Note that some methods start with the _ sign. These add filters without adding form elements to them. Use this only if its inevitable. The default behaivor is to add the filter and its form elements at once to enable filter specific form elements (e.g LikeFilter uses TextControl ignoring the field type defined by the list) and avoid many mistakes.

Also many filters can be added as constant filters. This means they are just part of the query but do not depend on the user. For example one would like to add constant filter to get only clients from one region without showing this filter to the user or letting it to be modified.

In other cases, filters are added with form elements no matter if one pass it within the method arguments or no. For each form element (e.g 2 in case of range filter and 1 in case of like filter) one can pass a form element, just a control or none of these. Passing a control means that the form element is automatically created using the other information available for this filter's field - label and type. Not passing the control either just means that the control is automatically created according the the field type (using FormUtil.createControl(Class) )). However if you like to define label or type for a form element, you can predefine them using FilterHelper.addCustomLabel(String,String) and FilterHelper.addFieldType(String,Class) methods. As you could expect, the mandatory is set to false and the initial value is set to null by default.

Their is one more aspect for all filter adding methods. For each method, one can define valueId. The term value is used here to mark the blank in the filter (basically the form element). By default the fieldId is also used as the valueId. So it's unneccesary to pass a valueId unless one would like to add more than one filter for one field. In the case of range filter, there are already two values used for one filter and therefore original fieldId is suffixed to distinguish the two values - low and high. However for more than two range filter for one field, custom value ids must be used as well.
author:
   Rein Raudjärv
See Also:   ListWidget
See Also:   FormWidget
See Also:   ListFilter