Java Doc for BaseFilterHelper.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

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » aranea mvc 1.1.1 » org.araneaframework.uilib.list.structure.filter

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.araneaframework.uilib.list.structure.filter .BaseFilterHelper

All known Subclasses:   org.araneaframework.uilib.list.structure.filter .FieldFilterHelper,  org.araneaframework.uilib.list.structure.filter .FilterHelper,
BaseFilterHelper
abstract public class BaseFilterHelper implements FilterContext,Serializable(Code)
Base implementation of list filter helper. Filter helper is used to add filters and their form elements to the ListWidget .
This class handles configuration for new filter such as strictness (e.g equal is not allowed for greater than filter) as well as allow to predefine custom labels for fields that are not added to the standard list of list fields but are used in filter form elements instead.

The handling of field types and their comparator is proxied to TypeHelper of the list widget.
author:
   Rein Raudjärv
See Also:   ListWidget
See Also:   FilterHelper
See Also:   TypeHelper

Field Summary
final public static String HIGH_SUFFIX

final public static String LOW_SUFFIX

final protected ListWidget list


Constructor Summary
public BaseFilterHelper(ListWidget list)
     Constructs a BaseFilterHelper .

Method Summary
protected void _addCustomLabel(String fieldId, String labelId)
     Adds custom label for specified field.
protected void _addFieldType(String fieldId, Class type)
     Defines type for specified field.
protected void _setIgnoreCase(boolean ignoreCase)
     Sets the current case sensitivity behaivor.
protected void _setStrict(boolean strict)
     Sets the current strickness behaivor.
public void addCustomComparator(String fieldId, Comparator comp)
     Adds custom comparator for the specified field.
public void addInitEvent(Event event)

public boolean checkChanged()
     Returns whether the basic configuration that specifies which items are shown has changed since last call to this BaseFilterHelper 's BaseFilterHelper.checkChanged method.
public void destroy()

protected void fireChange()

public ConfigurationContext getConfiguration()
     Retrieves the global configuration context.
public Comparator getFieldComparator(String fieldId)
     Retrieves comparator for the specified field.
public String getFieldId(String valueId)
     Transforms the value id into field id.
The same string is returned.
public String getFieldIdFromHighValueId(String highValueId)
     Transforms the range filter's high value id into field id.
The BaseFilterHelper.HIGH_SUFFIX is removed from the end.
Parameters:
  highValueId - high value id.
public String getFieldIdFromLowValueId(String lowValueId)
     Transforms the range filter's low value id into field id.
The BaseFilterHelper.LOW_SUFFIX is removed from the end.
Parameters:
  lowValueId - low value id.
public String getFieldLabel(String fieldId)
     Retrieves label for the specified field.
public Class getFieldType(String fieldId)
     Retrieves type for the specified field.
public FormWidget getForm()
     Returns the filter form.
public String getHighValueId(String fieldId)
     Transform the field id into range filter's high value id.
The BaseFilterHelper.HIGH_SUFFIX is appended to the field id.
Parameters:
  fieldId - field id.
protected LocalizationContext getL10nCtx()
     Returns the localization context.
public Locale getLocale()
     Returns the current locale.
public String getLowValueId(String fieldId)
     Transform the field id into range filter's low value id.
The BaseFilterHelper.LOW_SUFFIX is appended to the field id.
Parameters:
  fieldId - field id.
protected TypeHelper getTypeHelper()
     Returns the associated TypeHelper .
public String getValueId(String fieldId)
     Transforms the field id into value id.
The same string is returned.
public void init(Environment env)

public boolean isIgnoreCase()
     Returns the current case sensitivity behaivor.
public boolean isStrict()
     Returns whether new filters should be strict.
E.g.

Field Detail
HIGH_SUFFIX
final public static String HIGH_SUFFIX(Code)
Field id suffix for range filter's high/end/max value

LOW_SUFFIX
final public static String LOW_SUFFIX(Code)
Field id suffix for range filter's low/start/min value

list
final protected ListWidget list(Code)
The associated list

Constructor Detail
BaseFilterHelper
public BaseFilterHelper(ListWidget list)(Code)
Constructs a BaseFilterHelper .
Parameters:
  list - list.

Method Detail
_addCustomLabel
protected void _addCustomLabel(String fieldId, String labelId)(Code)
Adds custom label for specified field. This can override already defined label of list field. Those labels are used by new filter form elements that are automatically created for list filters.
Parameters:
  fieldId - field id.
Parameters:
  labelId - label id (not yet resolved).

_addFieldType
protected void _addFieldType(String fieldId, Class type)(Code)
Defines type for specified field.
Parameters:
  fieldId - field id.
Parameters:
  type - field type.
See Also:   TypeHelper.addFieldType(StringClass)

_setIgnoreCase
protected void _setIgnoreCase(boolean ignoreCase)(Code)
Sets the current case sensitivity behaivor.
Parameters:
  ignoreCase - whether to ignore case.

_setStrict
protected void _setStrict(boolean strict)(Code)
Sets the current strickness behaivor.
Parameters:
  strict - whether new filters should be strict.

addCustomComparator
public void addCustomComparator(String fieldId, Comparator comp)(Code)
Adds custom comparator for the specified field. This just proxies the call to TypeHelper#addCustomComparator(String, Comparator).
Parameters:
  fieldId - field id.
Parameters:
  comp - custom comparator.
See Also:   TypeHelper.addCustomComparator(StringComparator)

addInitEvent
public void addInitEvent(Event event)(Code)

checkChanged
public boolean checkChanged()(Code)
Returns whether the basic configuration that specifies which items are shown has changed since last call to this BaseFilterHelper 's BaseFilterHelper.checkChanged method.
since:
   1.1

destroy
public void destroy() throws Exception(Code)

fireChange
protected void fireChange()(Code)

since:
   1.1

getConfiguration
public ConfigurationContext getConfiguration()(Code)
Retrieves the global configuration context. the global configuration context.

getFieldComparator
public Comparator getFieldComparator(String fieldId)(Code)
Retrieves comparator for the specified field. This just proxies the call to TypeHelper.getFieldComparator(String) .
See Also:   TypeHelper.getFieldComparator(String)

getFieldId
public String getFieldId(String valueId)(Code)
Transforms the value id into field id.
The same string is returned.
Parameters:
  valueId - value id. field id.

getFieldIdFromHighValueId
public String getFieldIdFromHighValueId(String highValueId)(Code)
Transforms the range filter's high value id into field id.
The BaseFilterHelper.HIGH_SUFFIX is removed from the end.
Parameters:
  highValueId - high value id. field id.

getFieldIdFromLowValueId
public String getFieldIdFromLowValueId(String lowValueId)(Code)
Transforms the range filter's low value id into field id.
The BaseFilterHelper.LOW_SUFFIX is removed from the end.
Parameters:
  lowValueId - low value id. field id.

getFieldLabel
public String getFieldLabel(String fieldId)(Code)
Retrieves label for the specified field. If there are now custom label defined, one is retrieved from list fields defined in ListWidget .
Range filter's low and high labels are automatically generated based on the original field itself.

getFieldType
public Class getFieldType(String fieldId)(Code)
Retrieves type for the specified field.
If type is not defined for range filter's low/high value, the range filter field type is returned.

Otherwise TypeHelper.getFieldType(String) is just called.

See Also:   TypeHelper.getFieldType(String)

getForm
public FormWidget getForm()(Code)
Returns the filter form. the filter form.

getHighValueId
public String getHighValueId(String fieldId)(Code)
Transform the field id into range filter's high value id.
The BaseFilterHelper.HIGH_SUFFIX is appended to the field id.
Parameters:
  fieldId - field id. high value id.

getL10nCtx
protected LocalizationContext getL10nCtx()(Code)
Returns the localization context. the localization context.

getLocale
public Locale getLocale()(Code)
Returns the current locale. the current locale.

getLowValueId
public String getLowValueId(String fieldId)(Code)
Transform the field id into range filter's low value id.
The BaseFilterHelper.LOW_SUFFIX is appended to the field id.
Parameters:
  fieldId - field id. low value id.

getTypeHelper
protected TypeHelper getTypeHelper()(Code)
Returns the associated TypeHelper . TypeHelper.

getValueId
public String getValueId(String fieldId)(Code)
Transforms the field id into value id.
The same string is returned.
Parameters:
  fieldId - field id. value id.

init
public void init(Environment env) throws Exception(Code)

isIgnoreCase
public boolean isIgnoreCase()(Code)
Returns the current case sensitivity behaivor. the current case sensitivity behaivor.

isStrict
public boolean isStrict()(Code)
Returns whether new filters should be strict.
E.g. when adding e GreaterThan filter, strict does not allow two values to be equal. whether new filters should be strict.

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.