org.apache.directory.api.ldap.model.schema

Class PrepareString

java.lang.Object

org.apache.directory.api.ldap.model.schema.PrepareString

public final class PrepareString
extends Object

This class implements the 6 steps described in RFC 4518

Author:

Apache Directory Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrepareString.StringType The type of String we have to normalize

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	CASE_SENSITIVE A flag used to lowercase chars during the map process
private static char[][]	COMBINING_MARKS All the possible combining marks
private static boolean	IGNORE_CASE A flag used to keep casing during the map process

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PrepareString() A private constructor, to avoid instance creation of this static class.

Method Summary

Modifier and Type	Method and Description
static StringBuilder	bidi(char[] array) Remove all bidirectionnal chars.
static String	bidi(String str) Remove all bidirectionnal chars.
private static void	checkProhibited(char c) Prohibit characters described in RFC 4518 : - Table A.1 of RFC 3454 - Table C.3 of RFC 3454 - Table C.4 of RFC 3454 - Table C.5 of RFC 3454 - Table C.8 of RFC 3454 - character U-FFFD
private static String	insignifiantCharNumericString(String str) Remove all insignifiant spaces in a numeric string.
private static String	insignifiantCharTelephoneNumber(String str) Remove all insignifiant chars in a Telephone Number : Hyphen and spaces.
private static String	insignifiantSpacesString(String str, boolean caseSensitive) Remove all insignificant spaces in a string.
private static String	insignifiantSpacesStringAscii(String str, boolean caseSensitive) Remove all insignificant spaces in a Ascii string.
private static boolean	isCombiningMark(char c) Tells if a char is a combining mark.
private static int	map(char[] src, char[] target, char lowerCase) Execute the mapping step of the string preparation : - suppress useless chars - transform to spaces - lowercase
static String	normalize(String str, PrepareString.StringType type) We have to go through 6 steps : 1) Transcode 2) Map 3) Normalize 4) Prohibit 5) Bidi 6) Insignifiant Character Handling The first step is already done, the step (3) is not done.
private static byte	toByte(char c)
private static String	unescape(char[] array, int end)

Methods inherited from class java.lang.Object

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

Field Detail

CASE_SENSITIVE

private static final boolean CASE_SENSITIVE

A flag used to lowercase chars during the map process

See Also:

Constant Field Values

IGNORE_CASE

private static final boolean IGNORE_CASE

A flag used to keep casing during the map process

See Also:

Constant Field Values

COMBINING_MARKS

private static final char[][] COMBINING_MARKS

All the possible combining marks

Constructor Detail

PrepareString

private PrepareString()

A private constructor, to avoid instance creation of this static class.

Method Detail

isCombiningMark

private static boolean isCombiningMark(char c)

Tells if a char is a combining mark.

Parameters:

c - The char to check

Returns:

true if the char is a combining mark, false otherwise

normalize

public static String normalize(String str,
                               PrepareString.StringType type)
                        throws IOException

We have to go through 6 steps : 1) Transcode 2) Map 3) Normalize 4) Prohibit 5) Bidi 6) Insignifiant Character Handling The first step is already done, the step (3) is not done.

Parameters:

str - The String to normalize

type - The string type

Returns:

A normalized string.

Throws:

IOException - If teh normalization failed

map

private static int map(char[] src,
                       char[] target,
                       char lowerCase)

Execute the mapping step of the string preparation : - suppress useless chars - transform to spaces - lowercase

Parameters:

c - The char to map

array - The array which will collect the transformed char

pos - The current position in the target

lowerCase - A mask to lowercase the char, if necessary

Returns:

The transformed StringBuilder

checkProhibited

private static void checkProhibited(char c)
                             throws org.apache.directory.api.util.exception.InvalidCharacterException

Prohibit characters described in RFC 4518 : - Table A.1 of RFC 3454 - Table C.3 of RFC 3454 - Table C.4 of RFC 3454 - Table C.5 of RFC 3454 - Table C.8 of RFC 3454 - character U-FFFD

Parameters:

c - The char to analyze

Throws:

org.apache.directory.api.util.exception.InvalidCharacterException - If any character is prohibited

bidi

public static String bidi(String str)

Remove all bidirectionnal chars. This is not really clear in RFC 4518 what we should do with bidi chars : "Bidirectional characters are ignored." But it's not explained what is a bidi chars... So this method just do nothing atm.

Parameters:

str - The string where bidi chars are to be removed

Returns:

The cleaned string

bidi

public static StringBuilder bidi(char[] array)

Remove all bidirectionnal chars. This is not really clear in RFC 4518 what we should do with bidi chars : "Bidirectional characters are ignored." But it's not explained what is a bidi chars... So this method just do nothing atm.

Parameters:

array - The char array where bidi chars are to be removed

Returns:

The cleaned StringBuilder

insignifiantCharTelephoneNumber

private static String insignifiantCharTelephoneNumber(String str)

Remove all insignifiant chars in a Telephone Number : Hyphen and spaces. For instance, the following telephone number : "+ (33) 1-123--456 789" will be trasnformed to : "+(33)1123456789"

Parameters:

str - The telephone number

Returns:

The modified telephone number String

insignifiantCharNumericString

private static String insignifiantCharNumericString(String str)

Remove all insignifiant spaces in a numeric string. For instance, the following numeric string : " 123 456 789 " will be transformed to : "123456789"

Parameters:

str - The numeric String

Returns:

The modified numeric StringBuilder

insignifiantSpacesString

private static String insignifiantSpacesString(String str,
                                               boolean caseSensitive)
                                        throws org.apache.directory.api.util.exception.InvalidCharacterException

Remove all insignificant spaces in a string. This method use a finite state machine to parse the text.

Parameters:

str - The String to modify

caseSensitive - A flag telling if the chars must be lower cased

Returns:

The modified StringBuilder

Throws:

org.apache.directory.api.util.exception.InvalidCharacterException - If an invalid character is found in the String

insignifiantSpacesStringAscii

private static String insignifiantSpacesStringAscii(String str,
                                                    boolean caseSensitive)
                                             throws org.apache.directory.api.util.exception.InvalidCharacterException

Remove all insignificant spaces in a Ascii string. We don't remove escaped spaces. This method use a finite state machine to parse the text.

Parameters:

str - The String to modify

caseSensitive - A flag telling if the chars must be lower cased

Returns:

The modified StringBuilder

Throws:

org.apache.directory.api.util.exception.InvalidCharacterException - If an invalid character is found in the String

unescape

private static String unescape(char[] array,
                               int end)

toByte

private static byte toByte(char c)