+ * Throws an exception with one of two messages: "(identifier) is null, cannot + * convert to an int" or "Unable to convert value (identifier): (value) to an int" * @param identifier - name of value being converted - using in the exception thrown * if the number cannot be converted. * @param value - the value to be converted * @return int value - * @throws Exception - will contain a message "Unable to convert value (identifier): (value) to an int" + * @throws WDDXProcessorConversionException + * */ public static int convertToInt( String identifier, Object value) throws WDDXProcessorConversionException { int result=-255; - if ( value == null ) + if ( value == null || isNull(value) ) { throw new WDDXProcessorConversionException(identifier+" is null, cannot convert to an int"); } @@ -158,7 +167,9 @@ /** * Some conversion doesn't allow null value. Doing so will result in hidden * nullpointer exception. We do need this helper function. - * + *
+ * If it gets any of the NULL value objects (see WDDXTAGS) then it will + * consider this the same as a null. * @param identifier * @param value * @return converted integer. @@ -167,13 +178,15 @@ */ public static Integer nullSafeCovertToInteger(String identifier,Object value) throws WDDXProcessorConversionException { - if(value == null) + if(value == null || isNull(value) ) throw new IllegalArgumentException("["+identifier+"] is null. We can't convert null value to integer"); //delegate to convertToInteger return convertToInteger(identifier,value); } - /** Convert a string to an integer, based on how WDDX usually passes numbers. + /** Convert a number/string to an integer, based on how WDDX usually passes numbers. * As it is an integer, if the field is blank (or not there), then return null + * If it gets any of the NULL value objects (see WDDXTAGS) then it will return null + * * @param identifier - name of value being converted - using in the exception thrown * if the number cannot be converted. * @param value - the value to be converted @@ -184,13 +197,12 @@ throws WDDXProcessorConversionException { Integer result = null; - if ( value == null ) + if ( value == null || isNull(value) ) return null; try { // WDDX should give us a double - result = new Integer (((Number)value).intValue() ); - return(result); + return new Integer (((Number)value).intValue() ); } catch (Exception e) {} try { @@ -210,8 +222,9 @@ return(result); } - /** Convert a String to an Long, based on how WDDX usually passes numbers. + /** Convert a Number/String to an Long, based on how WDDX usually passes numbers. * As it is a Long, if the field is blank (or not there), then return null + * If it gets any of the NULL value objects (see WDDXTAGS) then it will return null * @param identifier - name of value being converted - using in the exception thrown * if the number cannot be converted. * @param value - the value to be converted @@ -222,15 +235,14 @@ throws WDDXProcessorConversionException { Long result = null; - if ( value == null ) + if ( value == null || isNull(value) ) { return null; } try { // WDDX should give us a double - result = new Long(((Number)value).intValue() ); - return(result); + return new Long(((Number)value).intValue() ); } catch (Exception e) {} try { @@ -250,7 +262,10 @@ return(result); } - /** Convert a String/Boolean to an Boolean + /** + * Convert a String/Boolean to an Boolean + * If it gets any of the NULL value objects (see WDDXTAGS) then it will return null + * * @param identifier - name of value being converted - using in the exception thrown * if the value cannot be converted. * @param value - the value to be converted @@ -261,15 +276,13 @@ throws WDDXProcessorConversionException { Boolean result = null; - if ( value == null ) + if ( value == null || isNull(value) ) { return null; } try { - result = (Boolean) value; - logger.debug("identifier "+identifier+" was Boolean value "+value+" becomes "+result); - return(result); + return (Boolean) value; } catch (Exception e) {} try { @@ -284,4 +297,77 @@ throw new WDDXProcessorConversionException("Unable to convert value "+identifier+":"+value+" to a Boolean"); } } + + /** Convert a string to an string. + * If it gets any of the NULL value objects (see WDDXTAGS) then it will return null + * + * @param identifier - name of value being converted - using in the exception thrown + * if the number cannot be converted. + * @param value - the value to be converted + * @return integer value or null + * @throws Exception - will contain a message "Unable to convert value (identifier): (value) to an int" + */ + public static String convertToString( String identifier, Object value) + throws WDDXProcessorConversionException + { + if ( value == null || isNull(value) ) { + return null; + } + + try { + return (String) value; + } catch ( Exception e2) { + throw new WDDXProcessorConversionException("Unable to convert value "+identifier+":"+value+" to an String"); + } + } + + /** + * Convert a String/Date to an Date + * If it gets any of the NULL value objects (see WDDXTAGS) then it will return null + * + * @param identifier - name of value being converted - using in the exception thrown + * if the value cannot be converted. + * @param value - the value to be converted + * @return Boolean value or null + * @throws Exception - will contain a message "Unable to convert value (identifier): (value) to an int" + */ + public static Date convertToDate( String identifier, Object value) + throws WDDXProcessorConversionException + { + Date result = null; + if ( value == null || isNull(value) ) + { + return null; + } + + try { + return (Date) value; + } catch (Exception e) {} + + try { + String textValue = (String) value; + if ( textValue.length() == 0 ) + return null; + + result = DateUtil.convertFromString(textValue); + logger.debug("identifier "+identifier+" was String value "+value+" becomes date "+result); + return(result); + + } catch ( Exception e2) { + throw new WDDXProcessorConversionException("Unable to convert value "+identifier+":"+value+" to a Date"); + } + } + + /** Does the given object match any of the known "null" values? */ + public static boolean isNull(Object obj) { + if ( obj == null ) return true; + if ( obj.equals(WDDXTAGS.STRING_NULL_VALUE) ) return true; + if ( obj.equals(WDDXTAGS.BOOLEAN_NULL_VALUE_AS_STRING) ) return true; + if ( obj.equals(WDDXTAGS.NUMERIC_NULL_VALUE_DOUBLE) ) return true; + if ( obj.equals(WDDXTAGS.NUMERIC_NULL_VALUE_LONG) ) return true; + if ( obj.equals(WDDXTAGS.NUMERIC_NULL_VALUE_INTEGER) ) return true; + if ( obj.equals(WDDXTAGS.DATE_NULL_VALUE) ) return true; + return false; + } + } Index: lams_common/src/java/org/lamsfoundation/lams/util/wddx/WDDXTAGS.java =================================================================== diff -u -rfc76a4bb4e5abc614e15b642e4015295b2912c0a -r7a9b889ef3ba8294bbbd6eb79fa18051416e7b6f --- lams_common/src/java/org/lamsfoundation/lams/util/wddx/WDDXTAGS.java (.../WDDXTAGS.java) (revision fc76a4bb4e5abc614e15b642e4015295b2912c0a) +++ lams_common/src/java/org/lamsfoundation/lams/util/wddx/WDDXTAGS.java (.../WDDXTAGS.java) (revision 7a9b889ef3ba8294bbbd6eb79fa18051416e7b6f) @@ -50,12 +50,25 @@ public static final String LIB_PACKAGE = "libraries"; public static final String DESIGN_PACKAGE ="designs"; - - public static final Long NUMERIC_NULL_VALUE_LONG = new Long(-111111); + /** The string value in a WDDX packet that indicates that this value is really null */ public static final String STRING_NULL_VALUE = "string_null_value"; + /** The Boolean value in a WDDX packet that indicates that this value is really null. + * Implemented as a String as Boolean is too restrictive. */ + public static final String BOOLEAN_NULL_VALUE_AS_STRING = "boolean_null_value"; + /** Don't know what to do Java -> Flash yet. + * TODO remove. + */ + public static final Boolean BOOLEAN_NULL_VALUE = new Boolean(false); + /** The Long value in a WDDX packet that indicates that this value is really null.*/ + public static final Long NUMERIC_NULL_VALUE_LONG = new Long(-111111); + /** The Integer value in a WDDX packet that indicates that this value is really null.*/ public static final Integer NUMERIC_NULL_VALUE_INTEGER = new Integer(-111111); + /** The Double value in a WDDX packet that indicates that this value is really null. + * This is used to check a value coming in from WDDX - as it tends to return Doubles, + * not Long or Integers. */ + public static final Double NUMERIC_NULL_VALUE_DOUBLE = new Double(-111111); + /** The Date value in a WDDX packet that indicates that this value is really null.*/ public static final Date DATE_NULL_VALUE = new Date(0); - public static final Boolean BOOLEAN_NULL_VALUE = new Boolean("false"); /*Activity specific tags*/ public static final String ACTIVITY_ID ="activity_id";