Save This Page
Home » xwork-2.1.1-src » com.opensymphony.xwork2.conversion.impl » [javadoc | source]
com.opensymphony.xwork2.conversion.impl
public class: XWorkConverter [javadoc | source]
java.lang.Object
   com.opensymphony.xwork2.conversion.impl.DefaultTypeConverter
      com.opensymphony.xwork2.conversion.impl.XWorkConverter

All Implemented Interfaces:
    TypeConverter

Direct Known Subclasses:
    AnnotationXWorkConverter

XWorkConverter is a singleton used by many of the Struts 2's Ognl extention points, such as InstantiatingNullHandler, XWorkListPropertyAccessor etc to do object conversion. Type conversion is great for situations where you need to turn a String in to a more complex object. Because the web is type-agnostic (everything is a string in HTTP), Struts 2's type conversion features are very useful. For instance, if you were prompting a user to enter in coordinates in the form of a string (such as "3, 22"), you could have Struts 2 do the conversion both from String to Point and from Point to String.

Using this "point" example, if your action (or another compound object in which you are setting properties on) has a corresponding ClassName-conversion.properties file, Struts 2 will use the configured type converters for conversion to and from strings. So turning "3, 22" in to new Point(3, 22) is done by merely adding the following entry to ClassName-conversion.properties (Note that the PointConverter should impl the TypeConverter interface):

point = com.acme.PointConverter

Your type converter should be sure to check what class type it is being requested to convert. Because it is used for both to and from strings, you will need to split the conversion method in to two parts: one that turns Strings in to Points, and one that turns Points in to Strings.

After this is done, you can now reference your point (using <s:property value="point"/> in JSP or ${point} in FreeMarker) and it will be printed as "3, 22" again. As such, if you submit this back to an action, it will be converted back to a Point once again.

In some situations you may wish to apply a type converter globally. This can be done by editing the file xwork-conversion.properties in the root of your class path (typically WEB-INF/classes) and providing a property in the form of the class name of the object you wish to convert on the left hand side and the class name of the type converter on the right hand side. For example, providing a type converter for all Point objects would mean adding the following entry:

com.acme.Point = com.acme.PointConverter

Type conversion should not be used as a substitute for i18n. It is not recommended to use this feature to print out properly formatted dates. Rather, you should use the i18n features of Struts 2 (and consult the JavaDocs for JDK's MessageFormat object) to see how a properly formatted date should be displayed.

Any error that occurs during type conversion may or may not wish to be reported. For example, reporting that the input "abc" could not be converted to a number might be important. On the other hand, reporting that an empty string, "", cannot be converted to a number might not be important - especially in a web environment where it is hard to distinguish between a user not entering a value vs. entering a blank value.

By default, all conversion errors are reported using the generic i18n key xwork.default.invalid.fieldvalue, which you can override (the default text is Invalid field value for field "xxx", where xxx is the field name) in your global i18n resource bundle.

However, sometimes you may wish to override this message on a per-field basis. You can do this by adding an i18n key associated with just your action (Action.properties) using the pattern invalid.fieldvalue.xxx, where xxx is the field name.

It is important to know that none of these errors are actually reported directly. Rather, they are added to a map called conversionErrors in the ActionContext. There are several ways this map can then be accessed and the errors can be reported accordingly.

Field Summary
protected static final  Logger LOG     
public static final  String REPORT_CONVERSION_ERRORS     
public static final  String CONVERSION_PROPERTY_FULLNAME     
public static final  String CONVERSION_ERROR_PROPERTY_PREFIX     
public static final  String CONVERSION_COLLECTION_PREFIX     
public static final  String LAST_BEAN_CLASS_ACCESSED     
public static final  String LAST_BEAN_PROPERTY_ACCESSED     
protected  HashMap mappings    Target class conversion Mappings.
Map>
- Class -> convert to class
- Map
- String -> property name
eg. Element_property, property etc.
- Object -> String to represent properties
eg. value part of
KeyProperty_property=id
-> TypeConverter to represent an Ognl TypeConverter
eg. value part of
property=foo.bar.MyConverter
-> Class to represent a class
eg. value part of
Element_property=foo.bar.MyObject
 
protected  HashSet noMapping    Unavailable target class conversion mappings, serves as a simple cache. 
protected  HashMap defaultMappings    Record class and its type converter mapping.
- String - classname as String
- TypeConverter - instance of TypeConverter
 
protected  HashSet unknownMappings    Record classes that doesn't have conversion mapping defined.
- String -> classname as String
 
Constructor:
 protected XWorkConverter() 
Method from com.opensymphony.xwork2.conversion.impl.XWorkConverter Summary:
addConverterMapping,   buildConverterFilename,   convertValue,   convertValue,   createTypeConverter,   getConversionErrorMessage,   getConverter,   handleConversionException,   loadConversionProperties,   lookup,   lookup,   lookupSuper,   registerConverter,   registerConverterNotFound,   setDefaultTypeConverter,   setObjectFactory
Methods from com.opensymphony.xwork2.conversion.impl.DefaultTypeConverter:
bigDecValue,   bigIntValue,   booleanValue,   convertValue,   convertValue,   convertValue,   doubleValue,   enumValue,   getTypeConverter,   longValue,   stringValue,   stringValue
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.opensymphony.xwork2.conversion.impl.XWorkConverter Detail:
  void addConverterMapping(Map mapping,
    Class clazz) 
    Looks for converter mappings for the specified class and adds it to an existing map. Only new converters are added. If a converter is defined on a key that already exists, the converter is ignored.
 public static String buildConverterFilename(Class clazz) 
 public Object convertValue(Map map,
    Object o,
    Class aClass) 
 public Object convertValue(Map context,
    Object target,
    Member member,
    String property,
    Object value,
    Class toClass) 
    Convert value from one form to another. Minimum requirement of arguments:
    • supplying context, toClass and value
    • supplying context, target and value.
 TypeConverter createTypeConverter(String className) throws Exception 
 public static String getConversionErrorMessage(String propertyName,
    ValueStack stack) 
 protected Object getConverter(Class clazz,
    String property) 
 protected  void handleConversionException(Map context,
    String property,
    Object value,
    Object object) 
 public  void loadConversionProperties(String propsName) throws IOException 
 public TypeConverter lookup(String className) 
    Looks for a TypeConverter in the default mappings.
 public TypeConverter lookup(Class clazz) 
    Looks for a TypeConverter in the default mappings.
 TypeConverter lookupSuper(Class clazz) 
    Recurses through a class' interfaces and class hierarchy looking for a TypeConverter in the default mapping that can handle the specified class.
 public synchronized  void registerConverter(String className,
    TypeConverter converter) 
 public synchronized  void registerConverterNotFound(String className) 
 public  void setDefaultTypeConverter(XWorkBasicConverter conv) 
 public  void setObjectFactory(ObjectFactory factory)