com.ihr.xbrl.util

Class TextTools

java.lang.Object

com.ihr.xbrl.util.TextTools

public class TextTools
extends java.lang.Object

The Class TextTools.

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextTools.ClsStringWidthAndLines The Class ClsStringWidthAndLines.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	styles The Constant styles.

Constructor Summary

Constructors

Constructor and Description
TextTools()

Method Summary

Modifier and Type	Method and Description
static void	addAfterSpacer(java.lang.StringBuilder sb, java.lang.String string, java.lang.String spacer) Adds the after spacer.
static java.lang.String	addStylesToHTMLString(java.lang.String html) Adds the styles to HTML string.
static TextTools.ClsStringWidthAndLines	computeStringMultilineWidth(java.awt.FontMetrics fm, java.lang.String text) Compute the width of the string using a font with the specified "metrics" (sizes).
static java.lang.String	convertNumToColString(int col) Takes in a 0-based base-10 column and returns a ALPHA-26 representation.
static java.util.Map<java.lang.String,java.lang.String>	eliminateCommon(java.util.Collection<java.lang.String> input) Prepares a Map of strings that contains the unique parts of each string in the overall collection.
static boolean	equalsNullSafe(java.lang.Object obj1, java.lang.Object obj2) Compares two objects that implements equals and return true if both are null or both are equals using equals on the one that is not null or in obj1 if both are not null.
static java.lang.String	extractNumber(java.lang.String strValueFormatted) This method will extract a number form the text string received as a parameter by removing all non number characters except the dot "."
static java.lang.String	getSignAndDigits(java.lang.CharSequence cs) Returns the optional minus sign and all digits from the left of the incoming CharSequence and ignores other characters that are not digits.
static java.lang.String	htmlToText(java.lang.String inputHTML) Very simple transformation between HTML and Text.
static boolean	isHTML(java.lang.String text) Returns true if text is html.
static int	leftCollectToSpaceUnquoting(java.lang.String address, int atChar, java.lang.StringBuilder buffer) Used to extract the user name form an email address.
static java.lang.String	lowerFirstWord(java.lang.String inputStr) Lower first word.
static java.lang.String	md5(java.lang.String source) Compute md5 of the input text.
static java.lang.String	normalizeSpace(java.lang.String source) Returns a string with space normalized.
static java.lang.String	normalizeSpaces(java.lang.String text) Replaces multiple occurrences of spaces and invisible characters by a single space.
static java.lang.String	pluralize(java.lang.String text, double days) Pluralize.
static java.lang.String	randomString(int len) Generates a random string of the indicated length.
static java.lang.String	reencodeText(java.lang.String possibleHTMLtext) Re encode a text string according with the rules defined in the EFM.
static java.lang.String	replaceEncodingInformation(java.lang.String inputHTML, java.lang.String instanceEncoding) This method is used to replace definitions of charcodes to match the charcode of the XBRL instance to be serialized.
static int	reverseFind(java.lang.String string, char c, int i) Finds character c on the string string starting at character position i decrementing the character position
static int	rightCollectToSpaceUnquoting(java.lang.String address, int atChar, java.lang.StringBuilder buffer) Right collect to space unquoting.
static boolean	search(java.lang.String where, java.lang.String find, boolean bExactWord, boolean ignoreCase) This method search the 'find' parameter string in 'where' parameter string.
static java.lang.String	textToHTML(java.lang.String inputStr) Very simple transformation of a text string with carrier returns into an HTML text with <br/> separators.
static java.lang.String	textToHTMLtext(java.lang.String string) This is the surrounding method behind textToHTML(String).
static java.lang.String	toHTMLTooltip(java.lang.String inputStr) Very simple transformation of a text string with carrier returns into an HTML text with <br/> separators.
static java.lang.String	trimToLetterOrDigit(java.lang.String text) Remove non letter or digit to the left and right of the text received as a parameter.
static java.lang.String	unquote(java.lang.String text) Removes starting and ending quote marks of a string if they exist.
static java.lang.String	upperFirstLetter(java.lang.String string) Simple text transformation to capitalize the first letter in the string.

Methods inherited from class java.lang.Object

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

Field Detail

styles

public static final java.lang.String styles

The Constant styles.

Constructor Detail

TextTools

public TextTools()

Method Detail

lowerFirstWord

public static java.lang.String lowerFirstWord(java.lang.String inputStr)

Lower first word.

Parameters:

inputStr - the input str

Returns:

the string

isHTML

public static boolean isHTML(java.lang.String text)

Returns true if text is html.

Parameters:

text - the text

Returns:

true if text is html

toHTMLTooltip

public static java.lang.String toHTMLTooltip(java.lang.String inputStr)

Very simple transformation of a text string with carrier returns into an HTML text with <br/> separators. This method will wrap the input string into an <html> and <body> nodes for convenience. This method is tuned to generate html for a tooltip so it might use specific references to local css styles

Parameters:

inputStr - input string as text.

Returns:

converted version of the input string

textToHTML

public static java.lang.String textToHTML(java.lang.String inputStr)

Very simple transformation of a text string with carrier returns into an HTML text with <br/> separators. Note this method does not wrap the text around <html> nodes 31/05/2012, now the encoding of < into &lt; and > into &gt; and & into &amp; is supported.

Parameters:

inputStr - input string as text.

Returns:

converted version of the input string

textToHTMLtext

public static java.lang.String textToHTMLtext(java.lang.String string)

This is the surrounding method behind textToHTML(String).

Parameters:

string - the string

Returns:

the string

See Also:

textToHTML(String)

htmlToText

public static java.lang.String htmlToText(java.lang.String inputHTML)

Very simple transformation between HTML and Text. This method removes the markup and also removes styling etc.

Parameters:

inputHTML - the input html

Returns:

the string

upperFirstLetter

public static java.lang.String upperFirstLetter(java.lang.String string)

Simple text transformation to capitalize the first letter in the string.

Parameters:

string - the string

Returns:

the string

pluralize

public static java.lang.String pluralize(java.lang.String text,
                                         double days)

Pluralize.

Parameters:

text - the text

days - the days

Returns:

the string

addAfterSpacer

public static void addAfterSpacer(java.lang.StringBuilder sb,
                                  java.lang.String string,
                                  java.lang.String spacer)

Adds the after spacer.

Parameters:

sb - the sb

string - the string

spacer - the spacer

getSignAndDigits

public static java.lang.String getSignAndDigits(java.lang.CharSequence cs)

Returns the optional minus sign and all digits from the left of the incoming CharSequence and ignores other characters that are not digits.

Parameters:

cs - the cs

Returns:

the sign and digits

reencodeText

public static java.lang.String reencodeText(java.lang.String possibleHTMLtext)

Re encode a text string according with the rules defined in the EFM. Search for a '<' sign, followed by a QName, optional white space and > sign. Extra '<' signs are encoded as %lt;

Parameters:

possibleHTMLtext - the possible htm ltext

Returns:

the string

md5

public static java.lang.String md5(java.lang.String source)

Compute md5 of the input text. If the input text is null it is considered as the empty string.

Parameters:

source - the input text

Returns:

a string representation of the MD5 digest such as 78e73127d8fd5ed64234b7c9a63b3

replaceEncodingInformation

public static java.lang.String replaceEncodingInformation(java.lang.String inputHTML,
                                                          java.lang.String instanceEncoding)

This method is used to replace definitions of charcodes to match the charcode of the XBRL instance to be serialized. This way, the output instance can be extracted from the instance and it will work as expected in a browser

Parameters:

inputHTML - incoming html page with encodings that might not match instanceEncoding

instanceEncoding - the encoding used in the output instance, normally this is UTF-8

Returns:

inputHTML filtered and all character encodings transformed to instanceEncoding

computeStringMultilineWidth

public static TextTools.ClsStringWidthAndLines computeStringMultilineWidth(java.awt.FontMetrics fm,
                                                                           java.lang.String text)

Compute the width of the string using a font with the specified "metrics" (sizes). This is similar to SwingUtilities.computeStringWidth() but takes account on multiline strings.

Parameters:

fm - a FontMetrics object to compute with

text - the text

Returns:

an int containing the string width

extractNumber

public static java.lang.String extractNumber(java.lang.String strValueFormatted)

This method will extract a number form the text string received as a parameter by removing all non number characters except the dot "."

Parameters:

strValueFormatted - the str value formatted

Returns:

the number including decimal places from a text string

search

public static boolean search(java.lang.String where,
                             java.lang.String find,
                             boolean bExactWord,
                             boolean ignoreCase)

This method search the 'find' parameter string in 'where' parameter string.

Parameters:

where - the where

find - the find

bExactWord - the b exact word

ignoreCase - the ignore case

Returns:

true, if successful

eliminateCommon

public static java.util.Map<java.lang.String,java.lang.String> eliminateCommon(java.util.Collection<java.lang.String> input)

Prepares a Map of strings that contains the unique parts of each string in the overall collection. This method will serve as a tool to prepare short menu texts form large strings that share large part of the string between all of them. This is normally the case for role types.

Parameters:

input - the input

Returns:

the map

leftCollectToSpaceUnquoting

public static int leftCollectToSpaceUnquoting(java.lang.String address,
                                              int atChar,
                                              java.lang.StringBuilder buffer)

Used to extract the user name form an email address. At this point, RFC822 is not used at all. This method just works around bugs in the license emails

Parameters:

address - the address

atChar - the at char

buffer - the buffer

Returns:

the int

rightCollectToSpaceUnquoting

public static int rightCollectToSpaceUnquoting(java.lang.String address,
                                               int atChar,
                                               java.lang.StringBuilder buffer)

Right collect to space unquoting.

Parameters:

address - the address

atChar - the at char

buffer - the buffer

Returns:

the int

unquote

public static java.lang.String unquote(java.lang.String text)

Removes starting and ending quote marks of a string if they exist.

Parameters:

text - the text

Returns:

the same text if unquoted. If properly quoted (has beginning and ending quote chars) returns the text unquoted

trimToLetterOrDigit

public static java.lang.String trimToLetterOrDigit(java.lang.String text)

Remove non letter or digit to the left and right of the text received as a parameter.

Parameters:

text - to trim

Returns:

text starting and ending with a letter or digit

equalsNullSafe

public static boolean equalsNullSafe(java.lang.Object obj1,
                                     java.lang.Object obj2)

Compares two objects that implements equals and return true if both are null or both are equals using equals on the one that is not null or in obj1 if both are not null.

Parameters:

obj1 - first object to compare or null

obj2 - second object to compare or null

Returns:

comparison result that never raises NullPointerException

normalizeSpace

public static java.lang.String normalizeSpace(java.lang.String source)

Returns a string with space normalized. For example "hello world" will be converted to "hello world" with just one space.

Character eliminated are defined by a regular expression

Parameters:

source - to normalize as String

Returns:

normalized String

randomString

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

Generates a random string of the indicated length. The characters of the string are limited to upper case and lower case letters and digits. All in the ASCII table

Parameters:

len - string length desired

Returns:

generated new random string

convertNumToColString

public static java.lang.String convertNumToColString(int col)

Takes in a 0-based base-10 column and returns a ALPHA-26 representation. eg column #3 -> D NOTE: this is a copy of org.apache.poi.ss.util.CellReference.convertNumToColString(int col) to prevent the inclusion of the POI library.

Parameters:

col - the col

Returns:

the string

reverseFind

public static int reverseFind(java.lang.String string,
                              char c,
                              int i)

Finds character c on the string string starting at character position i decrementing the character position

Parameters:

string - source text

c - character to find

i - starting position

Returns:

the int

addStylesToHTMLString

public static java.lang.String addStylesToHTMLString(java.lang.String html)

Adds the styles to HTML string.

Parameters:

html - the html

Returns:

the string

normalizeSpaces

public static java.lang.String normalizeSpaces(java.lang.String text)

Replaces multiple occurrences of spaces and invisible characters by a single space.

Parameters:

text - the text

Returns:

text after spaces normalization