org.licas_text.filter

Class FilterHtml

java.lang.Object

org.licas_text.filter.FilterHtml

public class FilterHtml
extends java.lang.Object

This class can be used to filter HTML content.

Author:

Kieran Greer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeContent(java.lang.String tagName, java.lang.String attributeName, java.lang.String theText) Get the value of the attribute that is part of the first occurrence of the element with the specified tag name.
java.lang.String	getReadableContent(java.lang.String theText, boolean removeLists) Get only the readable content of the html document.
java.lang.String	getSectionContent(java.lang.String startTag, java.lang.String endTag, java.lang.String theText, boolean removeOther) Get the section of text that starts with the first occurrence of the start tag and ends with the first occurrence of the end tag.
boolean	hasSection(java.lang.String tagName, java.lang.String theText) Return true if the text contains a section that starts with the specified tag.
static int	quoteIndex(java.lang.String theText) Return the first index of a quote character in the text.
static int	quoteIndex(java.lang.String theText, int startFrom) Return the first index of a quote character in the text.
java.lang.String	removeCommented(java.lang.String theText) Remove the sections between comment tags, that is HtmlConst.COMMSTART and COMMEND.
java.lang.String	removeHead(java.lang.String theText) Remove the head section of the document.
java.lang.String	removeHtmlCoded(java.lang.String theText) Remove the html coded content that starts with & and ends with ;.
java.lang.String	removeHtmlFormatting(java.lang.String theText) Remove the html formatting tags only.
java.lang.String	removeTagsAndSymbols(java.lang.String theText) Remove any existing XML or HTML tags, plus any symbols from the text.
java.lang.String	removeTagsHtml(java.lang.String theText) Remove any existing tags XML or HTML from the text.
java.lang.String	removeTagsInsideTag(java.lang.String theText, java.lang.String insideTag) Remove all tags inside another specified tag.
java.lang.String	removeXmlTags(java.lang.String theText) Remove the xml element tags from the text and keep only the xml element content.
void	resetForParsing() Reset intermediary tags for the start of parsing
java.lang.String	trimBeforeAfterNewlines(java.lang.String theText) Trim the text just before and after each new line character, to remove the whitespace.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterHtml

public FilterHtml()

Create a new instance of FilterHtml

Method Detail

resetForParsing

public void resetForParsing()

Reset intermediary tags for the start of parsing

hasSection

public boolean hasSection(java.lang.String tagName,
                          java.lang.String theText)

Return true if the text contains a section that starts with the specified tag.

Parameters:

tagName - the name of the section tag.

theText - the html text to parse.

Returns:

true if the text contains a tag with the specified name.

getAttributeContent

public java.lang.String getAttributeContent(java.lang.String tagName,
                                            java.lang.String attributeName,
                                            java.lang.String theText)

Get the value of the attribute that is part of the first occurrence of the element with the specified tag name.

Parameters:

tagName - the name of the element.

attributeName - the name of the attribute..

theText - the html text to parse.

Returns:

the value of the attribute.

getSectionContent

public java.lang.String getSectionContent(java.lang.String startTag,
                                          java.lang.String endTag,
                                          java.lang.String theText,
                                          boolean removeOther)
                                   throws java.lang.Exception

Get the section of text that starts with the first occurrence of the start tag and ends with the first occurrence of the end tag.

Parameters:

startTag - the name of the start tag.

endTag - the name of the end tag.

theText - the html text to parse.

removeOther - is true Only return the text content and not any tag information, otherwise return everything.

Returns:

the text section that starts and ends with the specified tag.

Throws:

java.lang.Exception - any error.

removeTagsHtml

public java.lang.String removeTagsHtml(java.lang.String theText)
                                throws java.lang.Exception

Remove any existing tags XML or HTML from the text.

Parameters:

theText - the text to format.

Returns:

the formatted text.

Throws:

java.lang.Exception - any error.

removeTagsAndSymbols

public java.lang.String removeTagsAndSymbols(java.lang.String theText)
                                      throws java.lang.Exception

Remove any existing XML or HTML tags, plus any symbols from the text.

Parameters:

theText - the text to format.

Returns:

the formatted text.

Throws:

java.lang.Exception - any error.

getReadableContent

public java.lang.String getReadableContent(java.lang.String theText,
                                           boolean removeLists)
                                    throws java.lang.Exception

Get only the readable content of the html document. This will perform some pre-defined operations and also remove all of the xml formatting or markup tags.

Parameters:

theText - the text representation of the html document.

removeLists - if true remove ordered and unordered lists. These might relate to menus, for example. The default is true.

Returns:

the text where only the content between the readable tags has been kept.

Throws:

java.lang.Exception - any error.

trimBeforeAfterNewlines

public java.lang.String trimBeforeAfterNewlines(java.lang.String theText)
                                         throws java.lang.Exception

Trim the text just before and after each new line character, to remove the whitespace. This is particularly useful if the text lines are represented by a single string.

Parameters:

theText - the text to trim.

Returns:

the text with whitespace removed.

Throws:

java.lang.Exception - any error.

removeHead

public java.lang.String removeHead(java.lang.String theText)
                            throws java.lang.Exception

Remove the head section of the document.

Parameters:

theText - the text representation of the html document.

Returns:

the text where the head section, ending in </head> is removed.

Throws:

java.lang.Exception - any error.

removeHtmlCoded

public java.lang.String removeHtmlCoded(java.lang.String theText)
                                 throws java.lang.Exception

Remove the html coded content that starts with & and ends with ;.

Parameters:

theText - the text representation of the html document.

Returns:

the text where the html coded content has been removed.

Throws:

java.lang.Exception - any error.

removeHtmlFormatting

public java.lang.String removeHtmlFormatting(java.lang.String theText)
                                      throws java.lang.Exception

Remove the html formatting tags only. This is useful if they include non-valid XML, such as with no end tag.

Parameters:

theText - the text representation of the html document.

Returns:

the formatted text.

Throws:

java.lang.Exception - any error.

removeTagsInsideTag

public java.lang.String removeTagsInsideTag(java.lang.String theText,
                                            java.lang.String insideTag)
                                     throws java.lang.Exception

Remove all tags inside another specified tag.

Parameters:

theText - the text representation of the html document.

insideTag - the tag to find and remove sub-tags from.

Returns:

the documentation tag with sub-tags removed.

Throws:

java.lang.Exception - any error.

removeCommented

public java.lang.String removeCommented(java.lang.String theText)

Remove the sections between comment tags, that is HtmlConst.COMMSTART and COMMEND. Each tag is replaced by a space. This method does not require a valid XML document.

Parameters:

theText - the text representation of the XML document.

Returns:

the text where the xml tags have been removed.

removeXmlTags

public java.lang.String removeXmlTags(java.lang.String theText)

Remove the xml element tags from the text and keep only the xml element content. Each tag is replaced by a space. This method does not require a valid XML document.

Parameters:

theText - the text representation of the XML document.

Returns:

the text where the xml tags have been removed.

quoteIndex

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

Return the first index of a quote character in the text.

Parameters:

theText - the text to check.

Returns:

the index value of the first quote character.

quoteIndex

public static int quoteIndex(java.lang.String theText,
                             int startFrom)

Return the first index of a quote character in the text.

Parameters:

theText - the text to check.

startFrom - the index to start the search from.

Returns:

the index value of the first quote character.