org.ai_heuristic.util

Class TextHandler

java.lang.Object

org.ai_heuristic.util.TextHandler

public class TextHandler
extends java.lang.Object

This class can be used for some basic text parsing operations.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INDENT
static java.lang.String	NODESCRIPTION Text constants

Constructor Summary

Constructors

Constructor and Description
TextHandler()

Method Summary

Modifier and Type	Method and Description
static boolean	containsLetters(java.lang.String theText) Return true if the text contains letters.
static boolean	containsNumbers(java.lang.String theText) Return true if the text contains numbers.
static boolean	containsSymbols(java.lang.String theText) Return true if the text contains symbols.
static boolean	containsTerm(java.lang.String theText, java.lang.String searchTerm, boolean exactMatch, boolean caseSensitive) Return true if the text sequence contains the search term.
static boolean	containsWhiteSpace(java.lang.String theText) Return true if the text contains any whitespace characters.
static java.util.ArrayList<java.lang.String>	createWordList(java.util.ArrayList<java.lang.String> wordList) Create a full word list from the list entered.
static java.util.ArrayList<java.lang.String>	createWordListLC(java.util.ArrayList<java.lang.String> wordList) Create a full lower case word list from the list entered.
static boolean	isNumerical(java.lang.String theText) Return true if the text is numerical.
static boolean	isStartSentence(java.lang.String endChars, java.lang.String theText) Return true if the text is the start of a new sentence.
static boolean	isSymbol(char theText) Return true if the text is a symbol, excluding characters and numbers.
static boolean	isUpperCase(char theChar) Return true if the character is upper case.
static boolean	isWhitespace(java.lang.String theText) Return true if the text is all whitespace.
static java.lang.String	removeNumbers(java.lang.String theText) Remove all numbers from the text.
static java.lang.String	removePunctuation(java.lang.String theText) Remove punctuation from the text.
static java.lang.String	removeSymbols(java.lang.String theText, boolean wordRules) Remove all symbols from the text.
static java.lang.String	removeToNextWhitespace(java.lang.String theText, int position) Remove a text sequence to the next whitespace character.
static java.lang.String	removeWords(java.lang.String theText, java.util.ArrayList<java.lang.String> wordList) Remove all words that are in the list of common words.
static java.lang.String	replaceSymbolsWithWhitespace(java.lang.String theText, boolean wordRules) Replace all symbols in the text with whitespace.
static java.lang.String	singleLine(java.lang.String theText) Convert the text back to a single line of text.
static java.lang.String	singleList(java.lang.String theText) Create a single list of words from the text input.
static java.util.ArrayList<java.lang.String>	singleListVec(java.lang.String theText) Create a single list of words from the text input.
static java.lang.String	singleSpaces(java.lang.String theText) Remove double or more spaces between words.
static boolean	startsWithCapitol(java.lang.String theWord) Return true if the word starts with a capitol letter.
static java.lang.String	trimNumber(java.lang.String theSymbol, boolean keepNegative) Trim a potential number value by removing all non-numerical characters from the start or the end of the string value.
static java.lang.String	trimSymbols(java.lang.String theText) Trim all symbols from the start or the end of the text string.

Methods inherited from class java.lang.Object

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

Field Detail

NODESCRIPTION

public static final java.lang.String NODESCRIPTION

Text constants

See Also:

Constant Field Values

INDENT

public static final java.lang.String INDENT

See Also:

Constant Field Values

Constructor Detail

TextHandler

public TextHandler()

Method Detail

isUpperCase

public static boolean isUpperCase(char theChar)

Return true if the character is upper case.

Parameters:

theChar - the character to check.

Returns:

true if it is an upper case character.

isNumerical

public static boolean isNumerical(java.lang.String theText)

Return true if the text is numerical.

Parameters:

theText - the text to check.

Returns:

true if a valid number.

isSymbol

public static boolean isSymbol(char theText)

Return true if the text is a symbol, excluding characters and numbers.

Parameters:

theText - the text to check.

Returns:

true if a valid symbol.

isStartSentence

public static boolean isStartSentence(java.lang.String endChars,
                                      java.lang.String theText)
                               throws java.lang.Exception

Return true if the text is the start of a new sentence.

Parameters:

endChars - the last characters of the previous sentence. This must be quotes of some sort and then a full stop, or a full stop directly.

theText - the new text to check. This can be whitespace and punctuation (symbols) followed by a capitol letter, or a capitol letter immediately.

Returns:

true if the start of a sentence, false otherwise.

Throws:

java.lang.Exception - any error.

startsWithCapitol

public static boolean startsWithCapitol(java.lang.String theWord)
                                 throws java.lang.Exception

Return true if the word starts with a capitol letter.

Parameters:

theWord - the word to check.

Returns:

true if the first char in the word is upper case.

Throws:

java.lang.Exception - any error.

containsTerm

public static boolean containsTerm(java.lang.String theText,
                                   java.lang.String searchTerm,
                                   boolean exactMatch,
                                   boolean caseSensitive)

Return true if the text sequence contains the search term.

Parameters:

theText - the text to process.

searchTerm - the term to search for.

exactMatch - if true an exact non-case sensitive match is required. If false only a non-case sensitive sequence anywhere in the text is required.

caseSensitive - if true case is also considered.

Returns:

true if the term is found, false otherwise.

containsLetters

public static boolean containsLetters(java.lang.String theText)

Return true if the text contains letters.

Parameters:

theText - the text to check.

Returns:

true if it contains any letters.

containsNumbers

public static boolean containsNumbers(java.lang.String theText)

Return true if the text contains numbers.

Parameters:

theText - the text to check.

Returns:

true if it contains any numbers.

containsSymbols

public static boolean containsSymbols(java.lang.String theText)

Return true if the text contains symbols.

Parameters:

theText - the text to check.

Returns:

true if it contains any symbols.

containsWhiteSpace

public static boolean containsWhiteSpace(java.lang.String theText)

Return true if the text contains any whitespace characters.

Parameters:

theText - the text to check.

Returns:

true if the text contains any whitespace characters.

isWhitespace

public static boolean isWhitespace(java.lang.String theText)

Return true if the text is all whitespace.

Parameters:

theText - the text to check.

Returns:

true if all whitespace.

removeSymbols

public static java.lang.String removeSymbols(java.lang.String theText,
                                             boolean wordRules)
                                      throws java.lang.Exception

Remove all symbols from the text. If include the rules, this will keep some symbols if they are part of normal grammar, such as 'there's' represents 'there is'. The rules can also try to re-combine words split by hyphens on sequential lines. There is a different removePunctuation method for removing only full stops, commas, etc. automatically.

Parameters:

theText - the input text.

wordRules - if true then apply an extra set of separation rules that can also keep some of the symbols. If false then all symbols are automatically removed.

Returns:

the text with only characters remaining.

Throws:

java.lang.Exception - any error.

removePunctuation

public static java.lang.String removePunctuation(java.lang.String theText)

Remove punctuation from the text. This replaces a specific set of symbols, namely: full stops, commas, colons, semi-colons, question marks and double quotes, with spaces. Single quotes are used by removeSymbols or replaceSymbolsWithWhitespace and so are not removed.

Parameters:

theText - th text to process.

Returns:

the text with punctuation removed.

replaceSymbolsWithWhitespace

public static java.lang.String replaceSymbolsWithWhitespace(java.lang.String theText,
                                                            boolean wordRules)
                                                     throws java.lang.Exception

Replace all symbols in the text with whitespace. Can also apply some basic rules for particular punctuation cases, where a space is not inserted, but the symbol is still removed, such as 'there's' will become 'there'. Also tries to re-combine words split by hyphens on sequential lines. Note that there is a different removePunctuation method for full stops, commas, etc.

Parameters:

theText - the input text.

wordRules - if true apply the extra separation rules. If false just perform an automatic symbol replacement.

Returns:

the text with only the original characters remaining.

Throws:

java.lang.Exception - any error.

removeToNextWhitespace

public static java.lang.String removeToNextWhitespace(java.lang.String theText,
                                                      int position)

Remove a text sequence to the next whitespace character.

Parameters:

theText - the text to process.

position - the position to start from. Can be 0 or less for the start of the string.

Returns:

the text string with the text sequence removed.

removeNumbers

public static java.lang.String removeNumbers(java.lang.String theText)
                                      throws java.lang.Exception

Remove all numbers from the text.

Parameters:

theText - the input text.

Returns:

the text with each number replaced by a space.

Throws:

java.lang.Exception - any error.

trimNumber

public static java.lang.String trimNumber(java.lang.String theSymbol,
                                          boolean keepNegative)
                                   throws java.lang.Exception

Trim a potential number value by removing all non-numerical characters from the start or the end of the string value. Optionally, allow a minus sign, to indicate a negative number.

Parameters:

theSymbol - the input text sequence - single word or symbol.

keepNegative - if true, try to keep the negative 'minus' sign.

Returns:

the text with all non-numerical characters removed from the start or the end.

Throws:

java.lang.Exception - any error.

trimSymbols

public static java.lang.String trimSymbols(java.lang.String theText)
                                    throws java.lang.Exception

Trim all symbols from the start or the end of the text string.

Parameters:

theText - the text string.

Returns:

the text string with symbols at the start or end removed..

Throws:

java.lang.Exception - any error.

removeWords

public static java.lang.String removeWords(java.lang.String theText,
                                           java.util.ArrayList<java.lang.String> wordList)

Remove all words that are in the list of common words.

Parameters:

theText - the input text.

wordList - the list of words to remove.

Returns:

the text with the specified words removed.

singleList

public static java.lang.String singleList(java.lang.String theText)

Create a single list of words from the text input.

Parameters:

theText - the input text.

Returns:

the text as a single list of words.

singleListVec

public static java.util.ArrayList<java.lang.String> singleListVec(java.lang.String theText)

Create a single list of words from the text input.

Parameters:

theText - the input text.

Returns:

the text as a single list of words, but placed in a ArrayList - one word each element.

singleLine

public static java.lang.String singleLine(java.lang.String theText)

Convert the text back to a single line of text.

Parameters:

theText - the input text.

Returns:

the text with newline characters replaced by spaces.

singleSpaces

public static java.lang.String singleSpaces(java.lang.String theText)

Remove double or more spaces between words.

Parameters:

theText - the input text.

Returns:

the text with only single spaces between the words.

createWordList

public static java.util.ArrayList<java.lang.String> createWordList(java.util.ArrayList<java.lang.String> wordList)

Create a full word list from the list entered.

Parameters:

wordList - the word list entered.

Returns:

a new list with all relevant possibilities.

createWordListLC

public static java.util.ArrayList<java.lang.String> createWordListLC(java.util.ArrayList<java.lang.String> wordList)

Create a full lower case word list from the list entered.

Parameters:

wordList - the word list entered.

Returns:

a new list with all words in lower case.