org.josef.web.jsf.converter

Class CodeDescriptionConverter

java.lang.Object

org.josef.web.jsf.converter.CodeDescriptionConverter

All Implemented Interfaces:

Serializable, javax.faces.convert.Converter

public class CodeDescriptionConverter
extends Object
implements javax.faces.convert.Converter, Serializable

Standard converter for objects of type CodeDescription.
Note: This converter only works when applied to:

1. CodeDescriptions with a unique (at least within the set of SelectItems) non null code.
2. A Select... component with nested <SelectItem(s)>

It is absolutely necessary that the value of the different SelectItems are actual CodeDescription objects! The toString() of the code of the CodeDescription will be used in the conversion.
Note: This converter will also work when applied to an output item, since for an output item only the getAsString(...) method is called.

Version:

1.0 $Revision: 5792 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CodeDescriptionConverter()

Method Summary

Modifier and Type	Method and Description
Object	getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, String code) Converts the supplied code to an object of type CodeDescription.
String	getAsString(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object codeDescription) Converts the supplied codeDescription to a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeDescriptionConverter

public CodeDescriptionConverter()

Method Detail

getAsObject

public Object getAsObject(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent uiComponent,
                          String code)

Converts the supplied code to an object of type CodeDescription.
The conversion is actually a lookup. Every UISelectItems and UISelectItem is scanned for objects of type: SelectItem. The getValue() method of this SelectItem returns a CodeDescription. When the toString() of this CodeDescription' code is equal to the supplied code, then the CodeDescription is returned.

Specified by:

getAsObject in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

uiComponent - The UI component that stores the CodeDescription and the nested UISelectItems.

code - The String representation of the code of the CodeDescription to lookup.

Returns:

The CodeDescription with the supplied code.
Null is returned when the supplied code is either null or empty.

Throws:

javax.faces.convert.ConverterException - When the supplied uiComponent is not of type: UISelectOne, or when no CodeDescription has the supplied code.

getAsString

public String getAsString(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent component,
                          Object codeDescription)

Converts the supplied codeDescription to a String.

Specified by:

getAsString in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the codeDescription.

codeDescription - The CodeDescription to convert to a String.

Returns:

The String value of the code of the supplied codeDescription.
Null is returned when either the supplied codeDescription is null or when the supplied codeDescription is not of type CodeDescription.