pt.ua.dicoogle.sdk.settings

Class Utils

java.lang.Object

pt.ua.dicoogle.sdk.settings.Utils

public class Utils
extends java.lang.Object

Helper for parsing form input values and creating HTML content based on them, server side.

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	convertStringValueIntoProperType(java.lang.Object originalValue, java.util.HashMap<java.lang.String,java.lang.String[]> params, int index, java.lang.String htmlElementID) Converts a String value into the type/class of originalValue.
static java.lang.String	getHTMLElementIDFromString(java.lang.String input) Based on a input String, returns a valid HTML element name or ID for it.
static java.lang.String	getHTMLInputFromType(java.lang.String id, java.lang.Object value) Based on the "real" type/class of the plugin setting Object returns the appropriate form input for it.
static java.lang.String	getHTMLInputFromType(java.lang.String name, java.lang.Object value, boolean isArrayElement) Based on the "real" type/class of the plugin setting Object returns the appropriate form input for it.
static boolean	parseCheckBoxValue(java.lang.String value) Given the string value of a checkbox obtained from an http request, returns its boolean value.
static boolean	parseCheckBoxValue(java.lang.String[] values, int index) Given the string value of a checkbox obtained from an http request, returns its boolean value.
static java.util.HashMap<java.lang.String,java.lang.Object>	processAdvancedSettings(java.util.HashMap<java.lang.String,java.lang.Object> originalSettings, java.util.HashMap<java.lang.String,java.lang.String[]> newSettings) This converts and applies the new textual values into the originalSettings HashMap, taking into account their original class/type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

processAdvancedSettings

public static java.util.HashMap<java.lang.String,java.lang.Object> processAdvancedSettings(java.util.HashMap<java.lang.String,java.lang.Object> originalSettings,
                                                                                           java.util.HashMap<java.lang.String,java.lang.String[]> newSettings)

This converts and applies the new textual values into the originalSettings HashMap, taking into account their original class/type. Only the settings that exist on both Maps are updated, this avoid invalid settings and Class type injections from happening.

Parameters:

originalSettings - the original advanced/internal settings of a plugin or service.

newSettings - the new settings to apply.

Returns:

the originalSettings HashMap with the new values in place (you can use the reference passed as originalSettings instead if you want, they will allways be the same).

parseCheckBoxValue

public static boolean parseCheckBoxValue(java.lang.String value)

Given the string value of a checkbox obtained from an http request, returns its boolean value.

Parameters:

value - the checkbox value obtained from an http request.

Returns:

the checkbox state in boolean form.

parseCheckBoxValue

public static boolean parseCheckBoxValue(java.lang.String[] values,
                                         int index)

Given the string value of a checkbox obtained from an http request, returns its boolean value.

Parameters:

values - an array of Strings where the checkbox value obtained from an http request is.

index - the index on the array where the wanted checkbox value is.

Returns:

the checkbox state in boolean form.

getHTMLElementIDFromString

public static java.lang.String getHTMLElementIDFromString(java.lang.String input)

Based on a input String, returns a valid HTML element name or ID for it. NOTE: be aware that repeated calls with the same input String will return the same result, so, on these cases name/ID collisions will happen!

Parameters:

input - the input String.

Returns:

a valid HTML element ID or name.

getHTMLInputFromType

public static java.lang.String getHTMLInputFromType(java.lang.String name,
                                                    java.lang.Object value,
                                                    boolean isArrayElement)

Based on the "real" type/class of the plugin setting Object returns the appropriate form input for it.

Parameters:

name - the Form Name of this HTML input.

value - a Object.

isArrayElement - if this value Object is part of a another multiple value Object.

Returns:

the appropriate form input for the supplied Object.

getHTMLInputFromType

public static java.lang.String getHTMLInputFromType(java.lang.String id,
                                                    java.lang.Object value)

Based on the "real" type/class of the plugin setting Object returns the appropriate form input for it. This procedure espects the value Object to not be a part of a another multiple value Object.

Parameters:

id - the ID and Name of this HTML input.

value - a Object.

Returns:

the appropriate form input for the supplied Object.

convertStringValueIntoProperType

public static java.lang.Object convertStringValueIntoProperType(java.lang.Object originalValue,
                                                                java.util.HashMap<java.lang.String,java.lang.String[]> params,
                                                                int index,
                                                                java.lang.String htmlElementID)

Converts a String value into the type/class of originalValue.

Parameters:

originalValue - the original/target type/class of the value.

newValue - the new value in String form.

Returns:

a new Object of the same class as orignalValue but it's value updated to newValue.