com.jaxfront.core.util
Class MapHelper

java.lang.Object
  com.jaxfront.core.util.MapHelper

public class MapHelper
extends java.lang.Object

Constructor Summary

MapHelper()

Method Summary

static java.util.Map	addAll(java.util.Map<java.lang.String,java.lang.String> items, java.lang.String[] vals)
static boolean	containsAll(java.util.Map map, java.lang.Object[] keys)
static java.lang.String	convert(java.lang.Object o)
static java.util.Map	copyKeyStartsWith(java.util.Map aMap, java.lang.String startsWith)
static java.lang.Object	createFromString(java.lang.String string)
static void	deSerializeProperties()
static java.lang.Object	getFirstMapEntry(java.util.Map aMap)
static java.util.Map	invertKeyValue(java.util.Map aMap)
static boolean	istTrue(java.util.Map domArgs, java.lang.String key, boolean defaultVal)
java.util.Map	load(java.io.InputStream inStream) Reads a property list (key and element pairs) from the input stream.
static java.lang.String	loadConvert(char[] in, int off, int len, char[] convtBuf)
static java.lang.String	loadConvert(java.lang.String in)
static void	removeKeysFromMap(java.util.Map aMap, java.util.ArrayList toRemove)
static void	removeKeysFromMap(java.util.Map aMap, java.lang.String[] toRemove)
static void	removeKeyStartsWith(java.util.Map aMap, java.lang.String startsWith)
static void	removeOther(java.util.Map aMap, java.util.List toKeep)
static java.lang.String	saveConvert(java.lang.String theString, boolean escapeSpace)
static void	serialize(java.util.Map aMap)
static void	store(java.util.Map aMap, java.io.OutputStream out, java.lang.String comments, java.lang.String keyPrefix, ToStringConverter converter, java.lang.String entryPrefix, java.lang.String entryPostfix) Writes this property list (key and element pairs) in this Properties table to the output stream in a format suitable for loading into a Properties table using the load method.
static java.lang.Object[]	toArrayForKey(java.util.Map aMap)
static java.util.List	toListForEntrySet(java.util.Map aMap)
static java.util.List	toListForKey(java.util.Map aMap)
static java.util.List	toListForValues(java.util.Map aMap)
static java.util.Map	toMap(java.lang.Class impl, java.util.Enumeration what) Generates a HashMap for a String array.
static java.util.Map	toMap(java.lang.Class impl, java.util.List what) Generates a HashMap for a String array.
static java.util.Map	toMap(java.util.Enumeration what) Generates a HashMap for a String array.
static java.util.Map	toMap(java.util.List what) Generates a HashMap for a String array.
static java.util.Map	toMap(java.util.List what, boolean emptyIfNull) Generates a HashMap for a String array.
static java.util.Map	toMap(java.util.List what, boolean emptyIfNull, boolean posAsValue) Generates a HashMap for a String array.
static java.util.Map	toMap(java.lang.String[] what)
static java.lang.String	toString(java.util.Map list)
static java.lang.String	toString(java.util.Map list, boolean withKey, boolean withValue)
static java.lang.String	toString(java.util.Map list, boolean withKey, boolean withValue, java.lang.String delim)
static java.lang.String	toString(java.util.Map list, boolean withKey, boolean withValue, java.lang.String delim, java.lang.String prefix, java.lang.String postfix, ToStringConverter converter)
static java.lang.String[]	toStringArray(java.util.Map aMap, boolean key, boolean value)
static java.lang.String[]	toStringArrayForKey(java.util.Map aMap)
static java.lang.String[]	translate(java.lang.String[] sqlColNames, java.util.Map colMapping)
static java.util.Map	tupleToMap(java.lang.String[] what) Generates a HashMap for a String array.
static java.util.Map	tupleToMap(java.lang.String[] what, java.util.Map result) Generates a HashMap for a String array.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapHelper

public MapHelper()

Method Detail

addAll

public static java.util.Map addAll(java.util.Map<java.lang.String,java.lang.String> items,
                                   java.lang.String[] vals)

containsAll

public static boolean containsAll(java.util.Map map,
                                  java.lang.Object[] keys)

convert

public static java.lang.String convert(java.lang.Object o)

copyKeyStartsWith

public static java.util.Map copyKeyStartsWith(java.util.Map aMap,
                                              java.lang.String startsWith)

createFromString

public static java.lang.Object createFromString(java.lang.String string)

deSerializeProperties

public static void deSerializeProperties()
                                  throws java.io.IOException

Throws:

java.io.IOException

getFirstMapEntry

public static java.lang.Object getFirstMapEntry(java.util.Map aMap)

invertKeyValue

public static java.util.Map invertKeyValue(java.util.Map aMap)

istTrue

public static boolean istTrue(java.util.Map domArgs,
                              java.lang.String key,
                              boolean defaultVal)

load

public java.util.Map load(java.io.InputStream inStream)
                   throws java.io.IOException

Reads a property list (key and element pairs) from the input stream. The stream is assumed to be using the ISO 8859-1 character encoding; that is each byte is one Latin1 character. Characters not in Latin1, and certain special characters, can be represented in keys and elements using escape sequences similar to those used for character and string literals (see §3.3 and §3.10.6 of the Java Language Specification). The differences from the character escape sequences used for characters and strings are:

• Octal escapes are not recognized.
• The character sequence \b does not represent a backspace character.
• The method does not treat a backslash character, \, before a non-valid escape character as an error; the backslash is silently dropped. For example, in a Java string the sequence "\z" would cause a compile time error. In contrast, this method silently drops the backslash. Therefore, this method treats the two character sequence "\b" as equivalent to the single character 'b'.
• Escapes are not necessary for single and double quotes; however, by the rule above, single and double quote characters preceded by a backslash still yield single and double quote characters, respectively.

An IllegalArgumentException is thrown if a malformed Unicode escape appears in the input.

This method processes input in terms of lines. A natural line of input is terminated either by a set of line terminator characters ( \n or \r or \r\n) or by the end of the file. A natural line may be either a blank line, a comment line, or hold some part of a key-element pair. The logical line holding all the data for a key-element pair may be spread out across several adjacent natural lines by escaping the line terminator sequence with a backslash character, \. Note that a comment line cannot be extended in this manner; every natural line that is a comment must have its own comment indicator, as described below. If a logical line is continued over several natural lines, the continuation lines receive further processing, also described below. Lines are read from the input stream until end of file is reached.

A natural line that contains only white space characters is considered blank and is ignored. A comment line has an ASCII '#' or '!' as its first non-white space character; comment lines are also ignored and do not encode key-element information. In addition to line terminators, this method considers the characters space (' ', '\u0020'), tab ('\t', '\u0009'), and form feed ( '\f', '\u000C') to be white space.

If a logical line is spread across several natural lines, the backslash escaping the line terminator sequence, the line terminator sequence, and any white space at the start the following line have no affect on the key or element values. The remainder of the discussion of key and element parsing will assume all the characters constituting the key and element appear on a single natural line after line continuation characters have been removed. Note that it is not sufficient to only examine the character preceding a line terminator sequence to see if the line terminator is escaped; there must be an odd number of contiguous backslashes for the line terminator to be escaped. Since the input is processed from left to right, a non-zero even number of 2n contiguous backslashes before a line terminator (or elsewhere) encodes n backslashes after escape processing.

The key contains all of the characters in the line starting with the first non-white space character and up to, but not including, the first unescaped '=', ':', or white space character other than a line terminator. All of these key termination characters may be included in the key by escaping them with a preceding backslash character; for example,

\:\=

would be the two-character key ":=". Line terminator characters can be included using \r and \n escape sequences. Any white space after the key is skipped; if the first non-white space character after the key is '=' or ':', then it is ignored and any white space characters after it are also skipped. All remaining characters on the line become part of the associated element string; if there are no remaining characters, the element is the empty string "". Once the raw character sequences constituting the key and element are identified, escape processing is performed as described above.

As an example, each of the following three lines specifies the key "Truth" and the associated element value "Beauty":

 Truth = Beauty
 Truth:Beauty
 Truth                  :Beauty
 

As another example, the following three lines specify a single property:

 fruits                           apple, banana, pear, \
                                  cantaloupe, watermelon, \
                                  kiwi, mango
 

The key is "fruits" and the associated element is:

 "apple, banana, pear, cantaloupe, watermelon, kiwi, mango"
 

Note that a space appears before each \ so that a space will appear after each comma in the final result; the \, line terminator, and leading white space on the continuation line are merely discarded and are not replaced by one or more other characters.

As a third example, the line:

 cheeses
 

specifies that the key is "cheeses" and the associated element is the empty string "".

Parameters:

inStream - the input stream.

Throws:

java.io.IOException - if an error occurred when reading from the input stream.

java.lang.IllegalArgumentException - if the input stream contains a malformed Unicode escape sequence.

loadConvert

public static java.lang.String loadConvert(char[] in,
                                           int off,
                                           int len,
                                           char[] convtBuf)

loadConvert

public static java.lang.String loadConvert(java.lang.String in)

removeKeysFromMap

public static void removeKeysFromMap(java.util.Map aMap,
                                     java.util.ArrayList toRemove)

removeKeysFromMap

public static void removeKeysFromMap(java.util.Map aMap,
                                     java.lang.String[] toRemove)

removeKeyStartsWith

public static void removeKeyStartsWith(java.util.Map aMap,
                                       java.lang.String startsWith)

removeOther

public static void removeOther(java.util.Map aMap,
                               java.util.List toKeep)

saveConvert

public static java.lang.String saveConvert(java.lang.String theString,
                                           boolean escapeSpace)

serialize

public static void serialize(java.util.Map aMap)
                      throws java.io.IOException

Throws:

java.io.IOException

store

public static void store(java.util.Map aMap,
                         java.io.OutputStream out,
                         java.lang.String comments,
                         java.lang.String keyPrefix,
                         ToStringConverter converter,
                         java.lang.String entryPrefix,
                         java.lang.String entryPostfix)
                  throws java.io.IOException

Writes this property list (key and element pairs) in this Properties table to the output stream in a format suitable for loading into a Properties table using the load method. The stream is written using the ISO 8859-1 character encoding.

Properties from the defaults table of this Properties table (if any) are not written out by this method.

If the comments argument is not null, then an ASCII # character, the comments string, and a line separator are first written to the output stream. Thus, the comments can serve as an identifying comment.

Next, a comment line is always written, consisting of an ASCII # character, the current date and time (as if produced by the toString method of Date for the current time), and a line separator as generated by the Writer.

Then every entry in this Properties table is written out, one per line. For each entry the key string is written, then an ASCII =, then the associated element string. Each character of the key and element strings is examined to see whether it should be rendered as an escape sequence. The ASCII characters \, tab, form feed, newline, and carriage return are written as \\, \t, \f \n, and \r, respectively. Characters less than \u0020 and characters greater than \u007E are written as \uxxxx for the appropriate hexadecimal value xxxx. For the key, all space characters are written with a preceding \ character. For the element, leading space characters, but not embedded or trailing space characters, are written with a preceding \ character. The key and element characters #, !, =, and : are written with a preceding backslash to ensure that they are properly loaded.

After the entries have been written, the output stream is flushed. The output stream remains open after this method returns.

Parameters:

out - an output stream.

comments - a description of the property list.

Throws:

java.io.IOException - if writing this property list to the specified output stream throws an IOException.

java.lang.ClassCastException - if this Properties object contains any keys or values that are not Strings.

java.lang.NullPointerException - if out is null.

Since:

1.2

toArrayForKey

public static java.lang.Object[] toArrayForKey(java.util.Map aMap)

toListForEntrySet

public static java.util.List toListForEntrySet(java.util.Map aMap)

toListForKey

public static java.util.List toListForKey(java.util.Map aMap)

toListForValues

public static java.util.List toListForValues(java.util.Map aMap)

toMap

public static java.util.Map toMap(java.lang.Class impl,
                                  java.util.Enumeration what)

Generates a HashMap for a String array. It creates a single map entry for each array element with equals key,value pairs!

Parameters:

what -

Returns:

toMap

public static java.util.Map toMap(java.lang.Class impl,
                                  java.util.List what)

Generates a HashMap for a String array. It creates a single map entry for each array element with equals key,value pairs!

Parameters:

what -

Returns:

toMap

public static java.util.Map toMap(java.util.Enumeration what)

Generates a HashMap for a String array. It creates a single map entry for each array element with equals key,value pairs!

Parameters:

what -

Returns:

toMap

public static java.util.Map toMap(java.util.List what)

Generates a HashMap for a String array. It creates a single map entry for each array element with equals key,value pairs!

Parameters:

what -

Returns:

toMap

public static java.util.Map toMap(java.util.List what,
                                  boolean emptyIfNull)

Generates a HashMap for a String array. It creates a single map entry for each array element with equals key,value pairs!

Parameters:

what -

Returns:

toMap

public static java.util.Map toMap(java.util.List what,
                                  boolean emptyIfNull,
                                  boolean posAsValue)

Generates a HashMap for a String array. It creates a single map entry for each array element with equals key,value pairs!

Parameters:

what -

Returns:

toMap

public static java.util.Map toMap(java.lang.String[] what)

toString

public static java.lang.String toString(java.util.Map list)

toString

public static java.lang.String toString(java.util.Map list,
                                        boolean withKey,
                                        boolean withValue)

toString

public static java.lang.String toString(java.util.Map list,
                                        boolean withKey,
                                        boolean withValue,
                                        java.lang.String delim)

toString

public static java.lang.String toString(java.util.Map list,
                                        boolean withKey,
                                        boolean withValue,
                                        java.lang.String delim,
                                        java.lang.String prefix,
                                        java.lang.String postfix,
                                        ToStringConverter converter)

toStringArray

public static java.lang.String[] toStringArray(java.util.Map aMap,
                                               boolean key,
                                               boolean value)

toStringArrayForKey

public static java.lang.String[] toStringArrayForKey(java.util.Map aMap)

translate

public static java.lang.String[] translate(java.lang.String[] sqlColNames,
                                           java.util.Map colMapping)

tupleToMap

public static java.util.Map tupleToMap(java.lang.String[] what)

Generates a HashMap for a String array. It creates a single map entry for each array element with equals key,value pairs!

Parameters:

what -

Returns:

tupleToMap

public static java.util.Map tupleToMap(java.lang.String[] what,
                                       java.util.Map result)

Generates a HashMap for a String array. It creates a single map entry for each array element with equals key,value pairs!

Parameters:

what -

Returns: