Java Doc for FormCriterion.java in  » J2EE » Mdarad » org » mdarad » framework » util » struts » criteria » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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 » J2EE » Mdarad » org.mdarad.framework.util.struts.criteria 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.mdarad.framework.util.struts.criteria.FormCriterion

All known Subclasses:   org.mdarad.framework.util.struts.criteria.ListCriterion,  org.mdarad.framework.util.struts.criteria.FormCriterionWithOperator,
FormCriterion
abstract public class FormCriterion implements Serializable,ResourceMapped(Code)
This abstract class represents a search criterion in a search interface USAGE: To use a search criterion, derive from FormCriterion and implement the following methods : FormCriterion.getFormPattern() getFormPattern , FormCriterion.getHBCriterion() getHBCriterion , FormCriterion.getObjectType() getObjectType et FormCriterion.setPropertyValue(String) setPropertyValue
author:
   Philippe Brouillette
version:
   1.0



Constructor Summary
public  FormCriterion(String name, Class associatedEntity, CriterionProperty property, String bundleName, Locale locale)
     Constructor that takes all the properties to initialize a search criterion.
public  FormCriterion(String name, Class associatedEntity, CriterionProperty property, String bundleName, Locale locale, boolean isDynamic)
     Constructor that takes all the properties to initialize a search criterion.
Parameters:
  name - name of the criterion.
public  FormCriterion(FormCriterion criterion)
     Constructor that clones a query criterion.

Method Summary
public  ClassgetAssociatedEntity()
    
public  StringgetBundle()
    
public  BooleangetDynamic()
    
abstract public  CriteriongetExprCriterion()
     Abstract method that returns the criterion from the expression framework.
abstract public  CriterionFormPatterngetFormPattern()
     Abstract method that should return the display pattern of the search criterion.
public  LocalegetLocale()
    
public  StringgetName()
    
abstract public  ClassgetObjectType()
     Abstract method to be implemented and that is used to specifies the type of the value object of the criterion.
public  CriterionPropertygetProperty()
    
public  StringgetPropertyLabel()
     Method that return the label of the property associated to the search criterion.
public  StringgetPropertyValue()
     Method that returns the value associated to the search criterion. The return value is a string to be used with the forms.
protected  ObjectgetValue()
    
public  voidsetAssociatedEntity(Class class1)
    
public  voidsetBundle(String bundle)
    
public  voidsetDynamic(Boolean dynamic)
    
public  voidsetLocale(Locale locale)
    
public  voidsetName(String name)
    
public  voidsetProperty(CriterionProperty property)
    
abstract public  voidsetPropertyValue(String object)
     Method used by the form to set the value of the object.
protected  voidsetValue(Object object)
    
protected  voidsetValue(Object object, Class type)
    


Constructor Detail
FormCriterion
public FormCriterion(String name, Class associatedEntity, CriterionProperty property, String bundleName, Locale locale)(Code)
Constructor that takes all the properties to initialize a search criterion. By default, the criterion is dynamic.
Parameters:
  name - name of the criterion. This name must be uniqueas it is a key in a map.
Parameters:
  associatedEntity - class type associated to this criterion
Parameters:
  property - property used for the query criterion
Parameters:
  bundleName - bundle name
Parameters:
  locale - locale information



FormCriterion
public FormCriterion(String name, Class associatedEntity, CriterionProperty property, String bundleName, Locale locale, boolean isDynamic)(Code)
Constructor that takes all the properties to initialize a search criterion.
Parameters:
  name - name of the criterion. This name must be uniqueas it is a key in a map.
Parameters:
  associatedEntity - class type associated to this criterion
Parameters:
  property - property used for the query criterion
Parameters:
  bundleName - bundle name
Parameters:
  locale - locale information
Parameters:
  dynamic - boolean that indicates if the criterion is dynamic



FormCriterion
public FormCriterion(FormCriterion criterion)(Code)
Constructor that clones a query criterion. This constructor is used to instanciate a criterion in a search form when the form contains dynamic criteria.
Parameters:
  criterion - query criterion that must be oftype FormCriterion
exception:
  CriterionException - lancé si le critère à copier est nul.




Method Detail
getAssociatedEntity
public Class getAssociatedEntity()(Code)



getBundle
public String getBundle()(Code)



getDynamic
public Boolean getDynamic()(Code)



getExprCriterion
abstract public Criterion getExprCriterion()(Code)
Abstract method that returns the criterion from the expression framework. ( Criterion )

NOTE: The implementation must take care of the type of operator that is used to determine the criterion to use. the criterion




getFormPattern
abstract public CriterionFormPattern getFormPattern()(Code)
Abstract method that should return the display pattern of the search criterion. The patterns are documented in the class CriterionFormPatterns CriterionFormPatterns To implement, use the CriterionFormPatterns class to obtain an object of type : CriterionFormPattern CriterionFormPattern return the display pattern



getLocale
public Locale getLocale()(Code)



getName
public String getName()(Code)



getObjectType
abstract public Class getObjectType()(Code)
Abstract method to be implemented and that is used to specifies the type of the value object of the criterion. EX: for numeric property, the typical implementation should be the following : public Class getObjectType() { return Integer.class; } the class type of the value object



getProperty
public CriterionProperty getProperty()(Code)



getPropertyLabel
public String getPropertyLabel()(Code)
Method that return the label of the property associated to the search criterion. property label.



getPropertyValue
public String getPropertyValue()(Code)
Method that returns the value associated to the search criterion. The return value is a string to be used with the forms. By default, the toString() method is called. value used by the criterion.



getValue
protected Object getValue()(Code)



setAssociatedEntity
public void setAssociatedEntity(Class class1)(Code)



setBundle
public void setBundle(String bundle)(Code)



setDynamic
public void setDynamic(Boolean dynamic)(Code)



setLocale
public void setLocale(Locale locale)(Code)



setName
public void setName(String name)(Code)



setProperty
public void setProperty(CriterionProperty property)(Code)



setPropertyValue
abstract public void setPropertyValue(String object)(Code)
Method used by the form to set the value of the object. The arg is a string because the forms cannot use Object
Parameters:
  object - value of the property



setValue
protected void setValue(Object object)(Code)



setValue
protected void setValue(Object object, Class type)(Code)
Setter of the value of the search criterion
Parameters:
  object - value associated to the criterion
Parameters:
  type - class type of the value object



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
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.