org.oscelot.lti.tp

Class Utils

java.lang.Object

org.oscelot.lti.tp.Utils

public class Utils
extends java.lang.Object

Class to represent miscellaneous utility methods.

Version:

1.1.01 (18-Jun-13)

Author:

Stephen P Vickers

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	floatToString(float fValue) Converts a float value to a String value
protected static org.apache.commons.httpclient.NameValuePair[]	getHTTPParams(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> params) Returns an array of name/value pair objects representing map entry values in a list.
protected static org.apache.commons.httpclient.NameValuePair[]	getHTTPParams(java.util.Map<java.lang.String,java.lang.String> params) Returns an array of name/value pair objects representing values in a map.
protected static java.lang.String	getRandomString(int length) Generates a random string.
protected static org.jdom.Element	getXmlChild(org.jdom.Element root, java.lang.String name) Returns a named XML child element given a parent element.
protected static java.lang.String	getXmlChildValue(org.jdom.Element root, java.lang.String name) Returns the value of a named XML child element given a parent element.
protected static org.jdom.Document	getXMLDoc(java.lang.String xml) Returns an XML document from an XML String
protected static java.lang.String	quoted(java.lang.String value, boolean addQuotes) Returns a string in quotes for use in a database query.
static java.lang.Float	stringToFloat(java.lang.String value) Converts a String value to a float value
protected static java.lang.String	urlEncode(java.lang.String value) Returns a URL-encoded string.

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

stringToFloat

public static java.lang.Float stringToFloat(java.lang.String value)

Converts a String value to a float value

Parameters:

value - string to be converted

Returns:

numeric value, or null if not a numeric string

floatToString

public static java.lang.String floatToString(float fValue)

Converts a float value to a String value

Parameters:

fValue - to be converted

Returns:

converted value

getRandomString

protected static java.lang.String getRandomString(int length)

Generates a random string.

The generated string will only comprise letters (upper- and lower-case) and digits.

Parameters:

length - Length of string to be generated

Returns:

random string

quoted

protected static java.lang.String quoted(java.lang.String value,
                      boolean addQuotes)

Returns a string in quotes for use in a database query.

Any single quotes in the value passed will be replaced with two single quotes. If a null value is passed, a string of 'NULL' is returned (which will never be enclosed in quotes irrespective of the value of the $addQuotes parameter.

Parameters:

value - value to be quoted

addQuotes - true if the returned string is to be enclosed in single quotes

Returns:

true if the user object was successfully deleted

urlEncode

protected static java.lang.String urlEncode(java.lang.String value)

Returns a URL-encoded string.

Parameters:

value - value to be encoded

Returns:

encoded string

getHTTPParams

protected static org.apache.commons.httpclient.NameValuePair[] getHTTPParams(java.util.Map<java.lang.String,java.lang.String> params)

Returns an array of name/value pair objects representing values in a map.

Parameters:

params - map of String values

Returns:

array of name/value pairs

getHTTPParams

protected static org.apache.commons.httpclient.NameValuePair[] getHTTPParams(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> params)

Returns an array of name/value pair objects representing map entry values in a list.

Parameters:

params - list of map entry values

Returns:

array of name/value pairs

getXMLDoc

protected static org.jdom.Document getXMLDoc(java.lang.String xml)

Returns an XML document from an XML String

Parameters:

xml - String containing XML

Returns:

XML document, null if not XML

getXmlChild

protected static org.jdom.Element getXmlChild(org.jdom.Element root,
                           java.lang.String name)

Returns a named XML child element given a parent element.

The first element will be returned if more than one exists with the given name. The first child element will be returned if the name is null.

Parameters:

root - parent element

name - name of child element

Returns:

child element, null if not found

getXmlChildValue

protected static java.lang.String getXmlChildValue(org.jdom.Element root,
                                java.lang.String name)

Returns the value of a named XML child element given a parent element.

The value of the first element will be returned if more than one exists with the given name. The value of the first child element will be returned if the name is null.

Parameters:

root - parent element

name - name of child element

Returns:

element value, null if not found