org.licas_text.util

Class XmlHtmlHandler

java.lang.Object

org.licas_text.util.XmlHtmlHandler

public class XmlHtmlHandler
extends java.lang.Object

This class can be used for some basic xml or html parsing operations.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
XmlHtmlHandler()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	decodeTextOther(java.lang.String xmlStr) Decode the string to re-add some of the coded symbols &, when for some reason * the parsing process amy have missed this in the text.
static java.lang.String	decodeXml(java.lang.String xmlStr) Decode the whole string-based XML document, to re-add the symbols.
static java.lang.String	decodeXmlContent(java.lang.String xmlStr) Decode the string-based XML content to re-add some of the coded symbols.
static java.lang.String	decodeXmlTag(java.lang.String xmlStr) Decode the string-based XML tag symbols only, to re-add the XML element coding.
static java.lang.String	encodeTextOther(java.lang.String xmlStr) Code the string text to replace some of the symbols & with codes, when for some reason the parsing process amy have missed this in the text.
static java.lang.String	encodeXml(java.lang.String xmlStr) Code the whole string-based XML document.
static java.lang.String	encodeXmlContent(java.lang.String xmlStr) Code the xml-based string content to replace some of the text with symbols.
static java.lang.String	encodeXmlTag(java.lang.String xmlStr) Code the xml-based element tags only, to replace the element brackets only.
static java.util.ArrayList<java.lang.String>	getAnchors(java.lang.String theText) Get a list of all anchors in the text.
static java.lang.String	getBodyPart(java.lang.String theText) Parse the text and return only the body part.
static java.util.ArrayList<java.lang.String>	getHtmlFormatList() Get the list of format tags to remove from any html text.
static java.util.ArrayList<java.lang.String>	getHtmlFormatWithDescriptionList() Get the list of format tags to remove from any html text.
static java.util.ArrayList<java.lang.String>	getHtmlWhitespaceList() Get the list of whitespace format tags to remove from any html text.
static java.lang.String	getNameAttr(org.licas_xml.abs.Element xmlElem) Get the value of a name element in the xml.
static java.lang.String	getNextWholeTag(java.lang.String theText) Get the next whole tag that is contained in the text string.
static java.lang.String	getTagName(java.lang.String theTag) Get the name part of the tag only, without a prefix or brackets.
static java.lang.String	getTitle(java.lang.String theText) Get the title of the document.
static java.lang.String	innerText(org.licas_xml.abs.Element rootElem) Parse the root element to return a concatenated text of all nested elements.
static boolean	isEndHtmlContentTag(java.lang.String theTag) Return true if the tag entered is the end of an html content tag.
static boolean	isHyperLink(java.lang.String httpStr) Return true if the text entered starts with an http address protocol.
static boolean	isHyperLinkTag(java.lang.String theTag) Return true if the tag entered is potentially a hyperlink tag.
static boolean	isRestQuery(java.lang.String httpStr) Return true if the text entered starts with an http address protocol.
static boolean	isStartHtmlContentTag(java.lang.String theTag) Return true if the tag entered is the start of an html content tag.
static java.lang.String	removeCDATA(java.lang.String theText) Remove any CDATA section coding and return the text content only.
static java.lang.String	removeCommented(java.lang.String theText) Remove the sections between comment tags, that is HtmlConst.COMMSTART and COMMEND.
static java.lang.String	removeFooter(java.lang.String theText) Remove the footer section of the document, defined as anything after the body section.
static java.lang.String	removeFormatting(java.lang.String theText) Remove html and other coded formatting, but replace some of them with the actual characters.
static java.lang.String	removeHead(java.lang.String theText) Remove the head section of the document.
static java.lang.String	removeHex(java.lang.String theText) Remove some hex number characters and replace with blanks.
static java.lang.String	removeNextWholeTag(java.lang.String theText) Remove the next whole tag that is contained in the text string.
static java.util.ArrayList<java.lang.String>	removeNoScripts(java.util.ArrayList<java.lang.String> textLines) Remove any no-script parts from the text and return.
static java.util.ArrayList<java.lang.String>	removeOrderedLists(java.util.ArrayList<java.lang.String> textLines) Remove any ordered list parts from the text and return.
static java.util.ArrayList<java.lang.String>	removeScripts(java.util.ArrayList<java.lang.String> textLines) Remove any script parts from the text and return.
static java.util.ArrayList<java.lang.String>	removeStyles(java.util.ArrayList<java.lang.String> textLines) Remove any style parts from the text and return.
static java.lang.String	removeTagBracketed(java.lang.String theText) Remove any bracketed section coding inside a tag and return the rest.
static java.util.ArrayList<java.lang.String>	removeUnorderedLists(java.util.ArrayList<java.lang.String> textLines) Remove any unordered list parts from the text and return.
static java.lang.String	removeVoidTags(java.lang.String theText) Remove void elements from the text.
static java.lang.String	removeXmlCoded(java.lang.String theText) Remove the xml coded content that starts with & and ends with ;.
static java.lang.String	removeXmlTags(java.lang.String theText) Remove the xml element tags from the text and keep only the xml element content.
static java.util.ArrayList<java.lang.String>	removeXmlTagsList(java.lang.String theText) Remove the xml element tags from the text and keep only the xml element content.
static java.lang.String	repairXmlTags(java.lang.String theText, java.lang.String rootTag) Deprecated. should not need to use this method.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlHtmlHandler

public XmlHtmlHandler()

Method Detail

isStartHtmlContentTag

public static boolean isStartHtmlContentTag(java.lang.String theTag)

Return true if the tag entered is the start of an html content tag.

Parameters:

theTag - the tag to check.

Returns:

true if it is part of a section with content to keep.

isEndHtmlContentTag

public static boolean isEndHtmlContentTag(java.lang.String theTag)

Return true if the tag entered is the end of an html content tag.

Parameters:

theTag - the tag to check.

Returns:

true if it is part of a section with content to keep.

isHyperLinkTag

public static boolean isHyperLinkTag(java.lang.String theTag)

Return true if the tag entered is potentially a hyperlink tag. This might be a whole XML tag and not just the hyperlink address.

Parameters:

theTag - the tag to check.

Returns:

true if it could contain a hyperlink.

isHyperLink

public static boolean isHyperLink(java.lang.String httpStr)

Return true if the text entered starts with an http address protocol.

Parameters:

httpStr - the http string to check.

Returns:

true if it could be an http address.

isRestQuery

public static boolean isRestQuery(java.lang.String httpStr)

Return true if the text entered starts with an http address protocol.

Parameters:

httpStr - the http string to check.

Returns:

true if it could be an http address.

getNameAttr

public static java.lang.String getNameAttr(org.licas_xml.abs.Element xmlElem)

Get the value of a name element in the xml. Can be all lower case, all upper case, or capitol first then lower case.

Parameters:

xmlElem - the element to check.

Returns:

the name attribute value, is present.

getTitle

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

Get the title of the document.

Parameters:

theText - the text representation of the html document.

Returns:

the document title if one exists.

removeHead

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

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.

removeFooter

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

Remove the footer section of the document, defined as anything after the body section.

Parameters:

theText - the text representation of the html document.

Returns:

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

getBodyPart

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

Parse the text and return only the body part. This is still unformatted and contains all of the html or other coded tags, etc.

Parameters:

theText - the text to parse.

Returns:

the html body section.

repairXmlTags

public static java.lang.String repairXmlTags(java.lang.String theText,
                                             java.lang.String rootTag)

Deprecated. should not need to use this method.

Try to add missing XML tags to make the document valid. This method does not require a valid XML document as input.

Parameters:

theText - the text representation of the XML document.

rootTag - tag name only to start with, in case the XMl has headers. In general, set to null for the whole text.

Returns:

the text which should now be XML-valid.

removeVoidTags

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

Remove void elements from the text. These are valid html elements that do not have an end tag, or '/', indicator.

Parameters:

theText - the input text.

Returns:

the same text with these tags removed.

removeStyles

public static java.util.ArrayList<java.lang.String> removeStyles(java.util.ArrayList<java.lang.String> textLines)

Remove any style parts from the text and return.

Parameters:

textLines - lines of text to parse.

Returns:

the html with style sections removed.

removeScripts

public static java.util.ArrayList<java.lang.String> removeScripts(java.util.ArrayList<java.lang.String> textLines)

Remove any script parts from the text and return.

Parameters:

textLines - lines of text to parse.

Returns:

the html with script sections removed.

removeNoScripts

public static java.util.ArrayList<java.lang.String> removeNoScripts(java.util.ArrayList<java.lang.String> textLines)

Remove any no-script parts from the text and return.

Parameters:

textLines - lines of text to parse.

Returns:

the html with no-script sections removed.

removeOrderedLists

public static java.util.ArrayList<java.lang.String> removeOrderedLists(java.util.ArrayList<java.lang.String> textLines)

Remove any ordered list parts from the text and return.

Parameters:

textLines - lines of text to parse.

Returns:

the html with ordered list sections removed.

removeUnorderedLists

public static java.util.ArrayList<java.lang.String> removeUnorderedLists(java.util.ArrayList<java.lang.String> textLines)

Remove any unordered list parts from the text and return.

Parameters:

textLines - lines of text to parse.

Returns:

the html with unordered list sections removed.

getAnchors

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

Get a list of all anchors in the text. This includes the hyperlink reference and any associated text content.

Parameters:

theText - the text representation of the XML document.

Returns:

the text where the xml tags have been removed.

removeCommented

public static 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.

removeTagBracketed

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

Remove any bracketed section coding inside a tag and return the rest.

Parameters:

theText - the text representation of the XML document.

Returns:

the same text where the '[', ']' section has been removed.

removeCDATA

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

Remove any CDATA section coding and return the text content only. Note this can add unformatted characters to the text.

Parameters:

theText - the text representation of the XML document.

Returns:

the text where the CDATA tags have been removed.

removeXmlTags

public static 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.

removeXmlTagsList

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

Remove the xml element tags from the text and keep only the xml element content. Each content part is added to a list. This method does not require a valid XML document.

Parameters:

theText - the text representation of the XML document.

Returns:

the list of content parts.

innerText

public static java.lang.String innerText(org.licas_xml.abs.Element rootElem)
                                  throws java.lang.Exception

Parse the root element to return a concatenated text of all nested elements.

Parameters:

rootElem - the element to parse from.

Returns:

a concatenated result of the text of all nested elements.

Throws:

java.lang.Exception - any error.

getNextWholeTag

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

Get the next whole tag that is contained in the text string.

Parameters:

theText - the text representation of the XML document.

Returns:

the next whole tag that is contained in the string.

removeNextWholeTag

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

Remove the next whole tag that is contained in the text string.

Parameters:

theText - the text representation of the XML document.

Returns:

the text with the next whole tag removed.

getTagName

public static java.lang.String getTagName(java.lang.String theTag)

Get the name part of the tag only, without a prefix or brackets.

Parameters:

theTag - the text term to process.

Returns:

the name part of the XML tag only.

removeFormatting

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

Remove html and other coded formatting, but replace some of them with the actual characters. NOTE: this will automatically remove the br html break statements, so you might want to replace them first.

Parameters:

theText - the text representation of the html document.

Returns:

the text where the formatting is either removed or replaced.

removeHex

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

Remove some hex number characters and replace with blanks.

Parameters:

theText - the text representation of the html document.

Returns:

the text where the formatting is removed.

removeXmlCoded

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

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

Parameters:

theText - the text representation of the xml document.

Returns:

the text where the xml coded content has been removed.

Throws:

java.lang.Exception - any error.

getHtmlFormatList

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

Get the list of format tags to remove from any html text.

Returns:

a list of words and symbols that should be removed.

getHtmlWhitespaceList

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

Get the list of whitespace format tags to remove from any html text. This could be new lines, for example.

Returns:

a list of words and symbols that should be removed.

getHtmlFormatWithDescriptionList

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

Get the list of format tags to remove from any html text. This list contains tags that also have descriptive attributes and so can only be defined by the start of the tag.

Returns:

a list of words and symbols that should be removed.

encodeXml

public static java.lang.String encodeXml(java.lang.String xmlStr)

Code the whole string-based XML document.

Parameters:

xmlStr - the string-based version of the XML document.

Returns:

the string with all parts coded, for example, &gt instead of >.

decodeXml

public static java.lang.String decodeXml(java.lang.String xmlStr)

Decode the whole string-based XML document, to re-add the symbols.

Parameters:

xmlStr - the string-based version of the XML document.

Returns:

the string with all parts decoded, for example, > instead of &gt.

encodeXmlTag

public static java.lang.String encodeXmlTag(java.lang.String xmlStr)

Code the xml-based element tags only, to replace the element brackets only.

Parameters:

xmlStr - the string with tag brackets.

Returns:

the string with coded parts, for example, &gt instead of >.

decodeXmlTag

public static java.lang.String decodeXmlTag(java.lang.String xmlStr)

Decode the string-based XML tag symbols only, to re-add the XML element coding.

Parameters:

xmlStr - the string with brackets coded, for example, > instead of &gt.

Returns:

the string with coded parts replaced by appropriate bracket.

encodeXmlContent

public static java.lang.String encodeXmlContent(java.lang.String xmlStr)

Code the xml-based string content to replace some of the text with symbols.

Parameters:

xmlStr - the string content, which is the element text.

Returns:

the string with coded parts.

decodeXmlContent

public static java.lang.String decodeXmlContent(java.lang.String xmlStr)

Decode the string-based XML content to re-add some of the coded symbols.

Parameters:

xmlStr - the string content, which is the element text.

Returns:

the string with coded parts replaced by appropriate symbol.

encodeTextOther

public static java.lang.String encodeTextOther(java.lang.String xmlStr)

Code the string text to replace some of the symbols & with codes, when for some reason the parsing process amy have missed this in the text.

Parameters:

xmlStr - the string content.

Returns:

the string with coded parts.

decodeTextOther

public static java.lang.String decodeTextOther(java.lang.String xmlStr)

Decode the string to re-add some of the coded symbols &, when for some reason * the parsing process amy have missed this in the text.

Parameters:

xmlStr - the string content.

Returns:

the string with coded parts replaced by appropriate symbol.