be.SIRAPRISE.typeimplementations

Class NmBracketParser

java.lang.Object

be.SIRAPRISE.typeimplementations.NmBracketParser

public class NmBracketParser
extends java.lang.Object

Provides methods for working with bracketed expressions and produce (Maps with) NameIdentifiers from them.

Author:

Erwin

Constructor Summary

Constructors

Constructor and Description
NmBracketParser()

Method Summary

Modifier and Type	Method and Description
static java.util.HashMap<NameIdentifier,java.lang.String>	createIdentifiersHashMapFromEscaped(java.lang.String s) Creates a HashMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.Map<NameIdentifier,java.lang.String>	createIdentifiersHashMapFromNonEscaped(java.lang.String s) Creates a HashMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.Map<NameIdentifier,java.lang.String>	createIdentifiersHashMapWithMandatoryValuesFromEscaped(java.lang.String s) Creates a HashMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.Map<NameIdentifier,java.lang.String>	createIdentifiersHashMapWithMandatoryValuesFromNonEscaped(java.lang.String s) Creates a HashMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.Map<NameIdentifier,java.lang.String>	createIdentifiersMapFromEscapedString(java.lang.String s, boolean emptyMapAllowed) Parses a bracketed String and builds a hashmap with the information contained within the (map) value is the (attribute) value, also in string format.
static java.util.Map<NameIdentifier,java.lang.String>	createIdentifiersTreeMapFromEscaped(java.lang.String s) Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.Map<NameIdentifier,java.lang.String>	createIdentifiersTreeMapFromNonEscaped(java.lang.String s) Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.Map<NameIdentifier,java.lang.String>	createIdentifiersTreeMapWithMandatoryValuesFromEscaped(java.lang.String s) Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.Map<NameIdentifier,java.lang.String>	createIdentifiersTreeMapWithMandatoryValuesFromNonEscaped(java.lang.String s) Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)...
static void	fillIdentifiersMapFromEscaped(java.lang.String s, java.util.Map<NameIdentifier,java.lang.String> attributeValueMap) Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)...
static void	fillIdentifiersMapFromNonEscaped(java.lang.String s, java.util.Map<NameIdentifier,java.lang.String> attributeValueMap) Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)...
static void	fillIdentifiersMapWithMandatoryValuesFromEscaped(java.lang.String s, java.util.Map<NameIdentifier,java.lang.String> attributeValueMap) Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)...
static void	fillIdentifiersMapWithMandatoryValuesFromNonEscaped(java.lang.String s, java.util.Map<NameIdentifier,java.lang.String> attributeValueMap) Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)...
static void	fillNonEmptyIdentifiersMapWithMandatoryValuesFromEscaped(java.lang.String s, java.util.Map<NameIdentifier,java.lang.String> attributeValueMap)

Methods inherited from class java.lang.Object

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

Constructor Detail

NmBracketParser

public NmBracketParser()

Method Detail

createIdentifiersHashMapFromEscaped

public static java.util.HashMap<NameIdentifier,java.lang.String> createIdentifiersHashMapFromEscaped(java.lang.String s)
                                                                                              throws NoClosingBracketException,
                                                                                                     InvalidEscapedCharacterException,
                                                                                                     MissingEscapedCharacterException,
                                                                                                     DuplicateNameException

Creates a HashMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name.

createIdentifiersHashMapFromNonEscaped

public static java.util.Map<NameIdentifier,java.lang.String> createIdentifiersHashMapFromNonEscaped(java.lang.String s)
                                                                                             throws NoClosingBracketException,
                                                                                                    DuplicateNameException

Creates a HashMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

Returns:

A HashMap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name.

createIdentifiersHashMapWithMandatoryValuesFromEscaped

public static java.util.Map<NameIdentifier,java.lang.String> createIdentifiersHashMapWithMandatoryValuesFromEscaped(java.lang.String s)
                                                                                                             throws DuplicateNameException,
                                                                                                                    NoClosingBracketException,
                                                                                                                    InvalidEscapedCharacterException,
                                                                                                                    MissingEscapedCharacterException,
                                                                                                                    NoValueCorrespondingToNameException

Creates a HashMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

createIdentifiersHashMapWithMandatoryValuesFromNonEscaped

public static java.util.Map<NameIdentifier,java.lang.String> createIdentifiersHashMapWithMandatoryValuesFromNonEscaped(java.lang.String s)
                                                                                                                throws DuplicateNameException,
                                                                                                                       NoClosingBracketException,
                                                                                                                       NoValueCorrespondingToNameException

Creates a HashMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

createIdentifiersMapFromEscapedString

public static java.util.Map<NameIdentifier,java.lang.String> createIdentifiersMapFromEscapedString(java.lang.String s,
                                                                                                   boolean emptyMapAllowed)
                                                                                            throws NoClosingBracketException,
                                                                                                   InvalidEscapedCharacterException,
                                                                                                   MissingEscapedCharacterException,
                                                                                                   NoValueCorrespondingToNameException,
                                                                                                   DuplicateNameException

Parses a bracketed String and builds a hashmap with the information contained within the (map) value is the (attribute) value, also in string format.

Parameters:

s - The textual representation of a bracketed expression

emptyMapAllowed - true if the result is not expected to contain at least one entry

Returns:

An attributevaluemap containing attribute name/value pairs. The key is the name in string format,

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

createIdentifiersTreeMapFromEscaped

public static java.util.Map<NameIdentifier,java.lang.String> createIdentifiersTreeMapFromEscaped(java.lang.String s)
                                                                                          throws NoClosingBracketException,
                                                                                                 InvalidEscapedCharacterException,
                                                                                                 MissingEscapedCharacterException,
                                                                                                 DuplicateNameException

Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name.

createIdentifiersTreeMapFromNonEscaped

public static java.util.Map<NameIdentifier,java.lang.String> createIdentifiersTreeMapFromNonEscaped(java.lang.String s)
                                                                                             throws NoClosingBracketException,
                                                                                                    DuplicateNameException

Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

Returns:

A TreeMap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name.

createIdentifiersTreeMapWithMandatoryValuesFromEscaped

public static java.util.Map<NameIdentifier,java.lang.String> createIdentifiersTreeMapWithMandatoryValuesFromEscaped(java.lang.String s)
                                                                                                             throws DuplicateNameException,
                                                                                                                    NoClosingBracketException,
                                                                                                                    InvalidEscapedCharacterException,
                                                                                                                    MissingEscapedCharacterException,
                                                                                                                    NoValueCorrespondingToNameException

Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

Returns:

A Treemap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

createIdentifiersTreeMapWithMandatoryValuesFromNonEscaped

public static java.util.Map<NameIdentifier,java.lang.String> createIdentifiersTreeMapWithMandatoryValuesFromNonEscaped(java.lang.String s)
                                                                                                                throws DuplicateNameException,
                                                                                                                       NoClosingBracketException,
                                                                                                                       NoValueCorrespondingToNameException

Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

Returns:

A Treemap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

fillIdentifiersMapFromNonEscaped

public static void fillIdentifiersMapFromNonEscaped(java.lang.String s,
                                                    java.util.Map<NameIdentifier,java.lang.String> attributeValueMap)
                                             throws NoClosingBracketException,
                                                    DuplicateNameException

Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses for that name.

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

attributeValueMap - The map to be filled. May or may not be empty. If non-empty at the moment of invocation, entries from the String argument will be added to the Map, in addition to those that were already present.

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

fillIdentifiersMapWithMandatoryValuesFromEscaped

public static void fillIdentifiersMapWithMandatoryValuesFromEscaped(java.lang.String s,
                                                                    java.util.Map<NameIdentifier,java.lang.String> attributeValueMap)
                                                             throws NoClosingBracketException,
                                                                    InvalidEscapedCharacterException,
                                                                    MissingEscapedCharacterException,
                                                                    NoValueCorrespondingToNameException,
                                                                    DuplicateNameException

Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses for that name.

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

attributeValueMap - The map to be filled. May or may not be empty. If non-empty at the moment of invocation, entries from the String argument will be added to the Map, in addition to those that were already present.

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

fillIdentifiersMapWithMandatoryValuesFromNonEscaped

public static void fillIdentifiersMapWithMandatoryValuesFromNonEscaped(java.lang.String s,
                                                                       java.util.Map<NameIdentifier,java.lang.String> attributeValueMap)
                                                                throws NoClosingBracketException,
                                                                       NoValueCorrespondingToNameException,
                                                                       DuplicateNameException

Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses for that name.

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

attributeValueMap - The map to be filled. May or may not be empty. If non-empty at the moment of invocation, entries from the String argument will be added to the Map, in addition to those that were already present.

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

fillNonEmptyIdentifiersMapWithMandatoryValuesFromEscaped

public static void fillNonEmptyIdentifiersMapWithMandatoryValuesFromEscaped(java.lang.String s,
                                                                            java.util.Map<NameIdentifier,java.lang.String> attributeValueMap)
                                                                     throws NoClosingBracketException,
                                                                            InvalidEscapedCharacterException,
                                                                            MissingEscapedCharacterException,
                                                                            NoValueCorrespondingToNameException,
                                                                            DuplicateNameException

Parameters:

s - The string to parse

attributeValueMap - The map to fill

Throws:

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

fillIdentifiersMapFromEscaped

public static void fillIdentifiersMapFromEscaped(java.lang.String s,
                                                 java.util.Map<NameIdentifier,java.lang.String> attributeValueMap)
                                          throws NoClosingBracketException,
                                                 InvalidEscapedCharacterException,
                                                 MissingEscapedCharacterException,
                                                 DuplicateNameException

Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses for that name.

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

attributeValueMap - The map to be filled. May or may not be empty. If non-empty at the moment of invocation, entries from the String argument will be added to the Map, in addition to those that were already present.

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.