nl.inl.util

Class XmlHighlighter

java.lang.Object

nl.inl.util.XmlHighlighter

public class XmlHighlighter
extends Object

Performs highlighting of the contents of XML elements that we found hits in. NOTE: this class is not threadsafe. Use a separate instance per thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlHighlighter.HitCharSpan The start and end character position of a hit, used for highlighting the content.
static class	XmlHighlighter.UnbalancedTagsStrategy How to deal with non-well-formed snippets: by e.g.

Constructor Summary

Constructors

Constructor and Description
XmlHighlighter()

Method Summary

Modifier and Type	Method and Description
String	cutAroundTags(String elementContent, int stopAfterChars) Cut a string after a specified number of non-tag characters, preferably at a word boundary, keeping all tags after the cut intact.
XmlHighlighter.UnbalancedTagsStrategy	getUnbalancedTagsStrategy() Get how well-formedness problems are fixed
String	highlight(String elementContent, List<XmlHighlighter.HitCharSpan> hits) Highlight a string containing XML tags.
String	highlight(String partialContent, List<XmlHighlighter.HitCharSpan> hits, int offset) Highlight part of an XML document.
static void	main(String[] args)
String	makeWellFormed(String xmlFragment) Make a cut XML fragment well-formed.
void	setRemoveEmptyHlTags(boolean c) Set whether or not to remove empty tags at the end of highlighting (which can form due to the process).
void	setUnbalancedTagsStrategy(XmlHighlighter.UnbalancedTagsStrategy strategy) Set how to fix well-formedness problems.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlHighlighter

public XmlHighlighter()

Method Detail

highlight

public String highlight(String elementContent,
                        List<XmlHighlighter.HitCharSpan> hits)

Highlight a string containing XML tags. The result is still well-formed XML.

Parameters:

elementContent - the string to highlight

hits - where the highlighting tags should go

Returns:

the highlighted string

highlight

public String highlight(String partialContent,
                        List<XmlHighlighter.HitCharSpan> hits,
                        int offset)

Highlight part of an XML document. You cut the XML yourself and supply the part you wish to highlight, along with the offset of where you cut (so we know where the highlight tags should go). Missing tags at the beginning or end of the part will be corrected. As long as you cut at tag boundaries (i.e. not within a tag), the result of this method will still be well-formed XML.

Parameters:

partialContent - the (partial) XML to cut and highlight.

hits - the hits to use for highlighting, or null for no highlighting

offset - position of the first character in the string (i.e. what to subtract from Hit positions to highlight)

Returns:

the highlighted (part of the) XML string

cutAroundTags

public String cutAroundTags(String elementContent,
                            int stopAfterChars)

Cut a string after a specified number of non-tag characters, preferably at a word boundary, keeping all tags after the cut intact. The result is still well-formed XML. You might use this to show the first few lines of an XML document on the results page.

Parameters:

elementContent - the string to cut

stopAfterChars - after how many non-tag characters we should stop (-1 for no limit)

Returns:

the cut string

main

public static void main(String[] args)

setRemoveEmptyHlTags

public void setRemoveEmptyHlTags(boolean c)

Set whether or not to remove empty tags at the end of highlighting (which can form due to the process).

Parameters:

c - true iff empty hl tags should be removed

makeWellFormed

public String makeWellFormed(String xmlFragment)

Make a cut XML fragment well-formed. The only requirement is that tags are intact (i.e. xmlFragment doesn't start with "able cellpadding='3'>" or end with "</bod". The fragment is made well-formed by adding open tags to the beginning or close tags to the end. It is therefore not a generic way of making any non-well-formed document well-formed, it just works for cutting out part of a well-formed document.

Parameters:

xmlFragment -

Returns:

a well-formed fragment

getUnbalancedTagsStrategy

public XmlHighlighter.UnbalancedTagsStrategy getUnbalancedTagsStrategy()

Get how well-formedness problems are fixed

Returns:

the strategy we're using now.

setUnbalancedTagsStrategy

public void setUnbalancedTagsStrategy(XmlHighlighter.UnbalancedTagsStrategy strategy)

Set how to fix well-formedness problems.

Parameters:

strategy - what to do when encountering unbalanced tags.