org.licas_text.util

Class WordHandler

java.lang.Object

org.licas_text.util.WordHandler

public final class WordHandler
extends java.lang.Object

This class performs operations over words.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
WordHandler() Create a new instance of WordHandler

Method Summary

Modifier and Type	Method and Description
static java.util.ArrayList<java.lang.String>	asLines(java.lang.String theText) Parse the text from a single line into list of new lines.
static java.lang.String	asString(java.util.ArrayList<java.lang.String> theText) Convert the text back to a single string but keep any newlines.
static int	getLineWordNumber(java.lang.String theTextLine) Get the number of words in a single line of text.
static java.util.ArrayList<java.lang.String>	loadWordFile(java.io.File wordFile) Load the specified word file and parse into a list.
static int	removeLineWhitespaceCount(java.lang.String theText) Remove the whitespace from the existing line of text and return the number of characters.
static java.util.ArrayList<java.lang.String>	tagsToWords(java.util.ArrayList<java.lang.String> theText) Convert a text document containing XML tags into one where each tag is a separate word that can be read in isolation.
static java.util.ArrayList<java.lang.String>	wordsToTags(java.util.ArrayList<java.lang.String> theText) Convert a text document containing tags that have been separated into isolated words back into XML tags again.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordHandler

public WordHandler()

Create a new instance of WordHandler

Method Detail

tagsToWords

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

Convert a text document containing XML tags into one where each tag is a separate word that can be read in isolation. This is a more specialised operation that is not typically used.

Parameters:

theText - the original XML document as a list of lines.

Returns:

the text with spaces separating all tags from their content.

wordsToTags

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

Convert a text document containing tags that have been separated into isolated words back into XML tags again. This is a more specialised operation that is not typically used.

Parameters:

theText - the text with the separated XML tags.

Returns:

the text with the tag spaces removed to produce XML elements again.

removeLineWhitespaceCount

public static int removeLineWhitespaceCount(java.lang.String theText)

Remove the whitespace from the existing line of text and return the number of characters.

Parameters:

theText - the original line of text.

Returns:

the number of characters with all whitespace removed.

getLineWordNumber

public static int getLineWordNumber(java.lang.String theTextLine)

Get the number of words in a single line of text.

Parameters:

theTextLine - the line of text.

Returns:

the number of words in the line.

loadWordFile

public static java.util.ArrayList<java.lang.String> loadWordFile(java.io.File wordFile)
                                                          throws java.lang.Exception

Load the specified word file and parse into a list.

Parameters:

wordFile - the path to the file to load. Each line represents a new word.

Returns:

a parsed list of words.

Throws:

java.lang.Exception - any error.

asString

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

Convert the text back to a single string but keep any newlines.

Parameters:

theText - the input text.

Returns:

the text with newline characters kept.

asLines

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

Parse the text from a single line into list of new lines.

Parameters:

theText - the input text.

Returns:

the text with lines created each newline character.