kotkabeans
Class Tools

java.lang.Object
  |
  +--kotkabeans.Tools

public class Tools

extends java.lang.Object

contains some videly used functions

Field Summary

static int	getRequestParametersCount
static int	QUERY_MODE_HIDDEN_INPUT
static int	QUERY_MODE_HREF
static int	QUERY_MODE_LINEFEED
static int	QUERY_MODE_REDIRECT

Constructor Summary

Tools()

Method Summary

static java.lang.String	addHref(java.lang.String href) Creates a href link used in HTML code.
static java.lang.String	addHref(java.lang.String href, java.lang.String urlText)
static java.util.ArrayList	arrangeKeys(java.util.Hashtable h) Arranges key-values (must be Double!)
static java.lang.String	checkValidityOfEmail(java.lang.String email) Checks validity of email address.
static java.lang.String	checkValidityOfEmail(java.lang.String email, User user)
static java.lang.String	checkValidityOfHetu(java.lang.String hetu) Checks validity of Finnish ID number, SSN (hetu).
static java.lang.String	checkValidityOfHetu(java.lang.String hetu, User user)
static boolean	containsCharacters(java.lang.String str, java.lang.String ch) Checks if given string contains any of characters in later string
static java.lang.String	convertGrade(java.lang.String g) Converts grade to acceptable form.
static double	decimalNro(java.lang.String nro) Replaces all commas to points in decimalnumber nro
static boolean	deleteFile(java.lang.String fileName) Deletes file.
static java.lang.String	getFile(java.lang.String fileName) Returns contents of wanted file.
static java.util.Locale	getLocale(int languageID)
static java.lang.String	getRequestParameters(javax.servlet.http.HttpServletRequest req, java.lang.String[] parameters, java.lang.String[] notWantedParams)
static java.lang.String	getRequestParameters(javax.servlet.http.HttpServletRequest req, java.lang.String[] parameters, java.lang.String[] notWantedParams, boolean amp) Returns parameters and their values from request.
static java.lang.String	getRequestParameters(javax.servlet.http.HttpServletRequest req, java.lang.String[] parameters, java.lang.String[] notWantedParams, int queryMode)
static java.lang.String	getRequestParametersAsHiddens(javax.servlet.http.HttpServletRequest req, java.lang.String[] parameters, java.lang.String[] notWantedParams) Returns parameters and their values as Hidden-fields from request.
static java.lang.String	getUnikTableName()
static boolean	isInTable(java.lang.String[] table, java.lang.String value) Searches if table contains given value.
static java.lang.String	pad(java.lang.String str, int finalLength) Pads a string with specified pad string.
static java.lang.String	pad(java.lang.String str, int finalLength, int position)
static java.lang.String	pad(java.lang.String str, java.lang.String padStr, int finalLength, int position)
static java.lang.String	parseFromBeginning(java.lang.String str, java.lang.String legal) Strips all characters after first found character in parameter notWanted.
static java.lang.String	parseNameSearch(java.lang.String s) Generates part of sql-query when you want to make such a query, that retrieves persons by their lastname.
static java.util.Hashtable	parseParams(java.lang.String paramNames, javax.servlet.http.HttpServletRequest req) Deprecated.
static java.util.Hashtable	parseParams(java.lang.String paramNames, javax.servlet.http.HttpServletRequest req, boolean emptys) Parses wanted parameters from HttpServletRequest into Hashtable.
static java.lang.String	parsePathPage(java.lang.String uri) Parses host and parameters off from URI and returns path with page
static java.lang.String	parseSearch(java.lang.String s, java.lang.String fieldName)
static java.lang.String	randomString() Returns random string created with specified length and characters.
static java.lang.String	randomString(int length)
static java.lang.String	randomString(int length, java.lang.String chars)
static void	redirectWithCurrentParams(java.lang.String address, javax.servlet.jsp.JspWriter out, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears buffer and redirects user to another page.
static java.lang.String	removeCharacters(java.lang.String s, java.lang.String c)
static java.lang.String	removeCharacters(java.lang.String s, java.lang.String c, java.lang.String except)
static java.lang.String	removeIllegalCharactersAtTableName(java.lang.String s)
static java.lang.String	retainCharacters(java.lang.String s, java.lang.String except) Removes the specified characters from input string.
static boolean	saveFile(java.lang.String fileName, java.lang.String data) Saves data to file
static java.util.ArrayList	sortHashtableByValue(java.util.Hashtable ht)
static java.lang.String	stringToCommaSeparated(User user, java.lang.String str)
static java.lang.String	stringToCommaSeparated(User user, java.lang.String str, int count)
static java.lang.String	stripTags(java.lang.String s) Strips all HTML-tags from String Tai itseasiassa stripataan kaikki < ja > -merkkien välissä olevat
static void	synchronizeStreams(java.io.InputStream src, java.io.PrintStream target) Prints content from src to target, line by line.
static java.lang.String	trimString(java.lang.String value) Deprecated. 12.6.2002 KK

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_MODE_REDIRECT

public static int QUERY_MODE_REDIRECT

QUERY_MODE_HREF

public static int QUERY_MODE_HREF

QUERY_MODE_HIDDEN_INPUT

public static int QUERY_MODE_HIDDEN_INPUT

QUERY_MODE_LINEFEED

public static int QUERY_MODE_LINEFEED

getRequestParametersCount

public static int getRequestParametersCount

Constructor Detail

Tools

public Tools()

Method Detail

trimString

public static java.lang.String trimString(java.lang.String value)

Deprecated. 12.6.2002 KK

Removes spaces from a given string. This function is needed because PostGreSQL seems to return string padded by spaces. (if they are defined as fixed length)

Parameters:

value - String to be trimmed

Returns:

the same string without extra spaces

See Also:

String.trim()

isInTable

public static boolean isInTable(java.lang.String[] table,
                                java.lang.String value)

Searches if table contains given value.

Parameters:

table - String array where to search.

value - Value that is searches

Returns:

trueif array contains value, otherwise false

getRequestParametersAsHiddens

public static java.lang.String getRequestParametersAsHiddens(javax.servlet.http.HttpServletRequest req,
                                                             java.lang.String[] parameters,
                                                             java.lang.String[] notWantedParams)
                                                      throws java.lang.Exception

Returns parameters and their values as Hidden-fields from request. If parameter "parameters" is null, we will return all parameters and otherwise those parameters that are defined in "parameters".

Parameters:

req - Current request.

parameters - Array containing wanted parameters.

notWantedParams - Array containin those parameters that we dont want to be added to parameters.

Returns:

String containing parameters coded as HTML hidden fields.

java.lang.Exception

getRequestParameters

public static java.lang.String getRequestParameters(javax.servlet.http.HttpServletRequest req,
                                                    java.lang.String[] parameters,
                                                    java.lang.String[] notWantedParams,
                                                    boolean amp)
                                             throws java.lang.Exception

Returns parameters and their values from request. If parameter "parameters" is null, we will return all parameters and otherwise those parameters that are defined in "parameters".

Parameters:

req - Current request.

parameters - Array containing wanted parameters.

notWantedParams - Array containin those parameters that we dont want to be added to parameters.

Returns:

String containing parameters.

java.lang.Exception

getRequestParameters

public static java.lang.String getRequestParameters(javax.servlet.http.HttpServletRequest req,
                                                    java.lang.String[] parameters,
                                                    java.lang.String[] notWantedParams,
                                                    int queryMode)
                                             throws java.lang.Exception

java.lang.Exception

getRequestParameters

public static java.lang.String getRequestParameters(javax.servlet.http.HttpServletRequest req,
                                                    java.lang.String[] parameters,
                                                    java.lang.String[] notWantedParams)
                                             throws java.lang.Exception

java.lang.Exception

See Also:

getRequestParameters(HttpServletRequest, String[], String[], boolean)

parseParams

public static java.util.Hashtable parseParams(java.lang.String paramNames,
                                              javax.servlet.http.HttpServletRequest req,
                                              boolean emptys)

Parses wanted parameters from HttpServletRequest into Hashtable.

Parameters:

paramNames - wanted parameters' names separated by comma

req - HttpServletRequest containing wanted parameters

emptys - if true empty values are taken also

Returns:

wanted parameters in Hashtable (paramName, paramValue)

parseParams

public static java.util.Hashtable parseParams(java.lang.String paramNames,
                                              javax.servlet.http.HttpServletRequest req)

Deprecated.

See Also:

parseParams(String, HttpServletRequest, boolean)

parseNameSearch

public static java.lang.String parseNameSearch(java.lang.String s)

Generates part of sql-query when you want to make such a query, that retrieves persons by their lastname. you may give several names or part of names separated by ,;: or /. Example return value: upper(lastname) LIKE upper('par%') OR upper(lastname) LIKE upper('ta%'). If given parameter is NULL, return value will be NULL also.

Parameters:

s - Given search key

Returns:

Part of sql-query

parseSearch

public static java.lang.String parseSearch(java.lang.String s,
                                           java.lang.String fieldName)

retainCharacters

public static java.lang.String retainCharacters(java.lang.String s,
                                                java.lang.String except)

Removes the specified characters from input string. If param c is blank, all chars except chars in except are removed. If param except is not blank, chars in this string are not removed.

Parameters:

s - The original string

except - A string consisting of characters to not be removed, even if they appear in c.

Returns:

A string with the specified characters removed

removeCharacters

public static java.lang.String removeCharacters(java.lang.String s,
                                                java.lang.String c)

removeCharacters

public static java.lang.String removeCharacters(java.lang.String s,
                                                java.lang.String c,
                                                java.lang.String except)

checkValidityOfHetu

public static java.lang.String checkValidityOfHetu(java.lang.String hetu)

Checks validity of Finnish ID number, SSN (hetu).

Parameters:

hetu - The hetu to be checked

Returns:

blank String if hetu is correct, otherwise an error message. If the last part of the hetu is 0000 (defined as defaultSocSecEnd in Common bean), the hetu is considered valid.

checkValidityOfHetu

public static java.lang.String checkValidityOfHetu(java.lang.String hetu,
                                                   User user)

pad

public static java.lang.String pad(java.lang.String str,
                                   int finalLength)

Pads a string with specified pad string.

Parameters:

str - the original string

finalLength - the final length of the padded string

Returns:

the padded string

pad

public static java.lang.String pad(java.lang.String str,
                                   int finalLength,
                                   int position)

pad

public static java.lang.String pad(java.lang.String str,
                                   java.lang.String padStr,
                                   int finalLength,
                                   int position)

getFile

public static java.lang.String getFile(java.lang.String fileName)

Returns contents of wanted file.

Parameters:

fileName - filename containing path

Returns:

contents of wanted file

saveFile

public static boolean saveFile(java.lang.String fileName,
                               java.lang.String data)

Saves data to file

Parameters:

fileName - filename containing path

data - data to write in file

deleteFile

public static boolean deleteFile(java.lang.String fileName)

Deletes file.

Parameters:

fileName - filename containing path

Returns:

true if file deleted successfully else false

addHref

public static java.lang.String addHref(java.lang.String href)

Creates a href link used in HTML code.

Parameters:

href - URL

addHref

public static java.lang.String addHref(java.lang.String href,
                                       java.lang.String urlText)

checkValidityOfEmail

public static java.lang.String checkValidityOfEmail(java.lang.String email)

Checks validity of email address.

Parameters:

email - The email address to be checked

Returns:

true or false depending on the validity

checkValidityOfEmail

public static java.lang.String checkValidityOfEmail(java.lang.String email,
                                                    User user)

arrangeKeys

public static java.util.ArrayList arrangeKeys(java.util.Hashtable h)

Arranges key-values (must be Double!) from given Hashtable to ArrayList.

Parameters:

h - Hashtable to arrange

Returns:

Hashtable's keys in order

removeIllegalCharactersAtTableName

public static java.lang.String removeIllegalCharactersAtTableName(java.lang.String s)

getUnikTableName

public static java.lang.String getUnikTableName()

randomString

public static java.lang.String randomString()

Returns random string created with specified length and characters.

Returns:

created random string

randomString

public static java.lang.String randomString(int length)

randomString

public static java.lang.String randomString(int length,
                                            java.lang.String chars)

stripTags

public static java.lang.String stripTags(java.lang.String s)

Strips all HTML-tags from String Tai itseasiassa stripataan kaikki < ja > -merkkien välissä olevat

Parameters:

s - string to Strip

Returns:

stripped String

containsCharacters

public static boolean containsCharacters(java.lang.String str,
                                         java.lang.String ch)

Checks if given string contains any of characters in later string

Parameters:

str - String that is tested

ch - String containing characters

Returns:

true if given string contains any of characters in later string otherwise false.

decimalNro

public static double decimalNro(java.lang.String nro)
                         throws java.lang.NumberFormatException

Replaces all commas to points in decimalnumber nro

Parameters:

nro - decimalnumber as string

Returns:

number converted to double

Throws:

java.lang.NumberFormatException - if nro is not number at all

parsePathPage

public static java.lang.String parsePathPage(java.lang.String uri)

Parses host and parameters off from URI and returns path with page

sortHashtableByValue

public static java.util.ArrayList sortHashtableByValue(java.util.Hashtable ht)

convertGrade

public static java.lang.String convertGrade(java.lang.String g)

Converts grade to acceptable form. ie. 2½ -> 2.5 'hyv' -> 'hyväksytty' 'pass' -> 'hyväksytty' etc...

Parameters:

g - grade to convert

Returns:

grade in acceptable form

stringToCommaSeparated

public static java.lang.String stringToCommaSeparated(User user,
                                                      java.lang.String str)

stringToCommaSeparated

public static java.lang.String stringToCommaSeparated(User user,
                                                      java.lang.String str,
                                                      int count)

synchronizeStreams

public static void synchronizeStreams(java.io.InputStream src,
                                      java.io.PrintStream target)
                               throws java.io.IOException

Prints content from src to target, line by line.

java.io.IOException

getLocale

public static java.util.Locale getLocale(int languageID)

parseFromBeginning

public static java.lang.String parseFromBeginning(java.lang.String str,
                                                  java.lang.String legal)

Strips all characters after first found character in parameter notWanted. If all characters are legal, returns the string unchanged.

Parameters:

str - String which is to be stripped

legal - String consisting of legal characters

redirectWithCurrentParams

public static void redirectWithCurrentParams(java.lang.String address,
                                             javax.servlet.jsp.JspWriter out,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws java.lang.Exception

Clears buffer and redirects user to another page. Current parameters are sent with request. Note! return should be called manually after calling this method.

Parameters:

address - where to jump ('?' or additional params may be inserted)

out - current jspwriter

request - current request (params are read here)

response - current response (new page is sent here)

java.lang.Exception