org.galagosearch.core.store
Class SnippetGenerator

java.lang.Object
  org.galagosearch.core.store.SnippetGenerator

public class SnippetGenerator
extends java.lang.Object

This is a very simple snippet generator for generating small summaries of returned documents.

Author:

trevor

Nested Class Summary

static class	SnippetGenerator.Match
class	SnippetGenerator.Snippet
static class	SnippetGenerator.SnippetRegion

Field Summary

static int

width

Constructor Summary

SnippetGenerator()

Method Summary

java.lang.String	buildHtmlString(SnippetGenerator.Snippet best, Document document, java.util.ArrayList<TagTokenizer.Pair> positions)
java.util.ArrayList<SnippetGenerator.SnippetRegion>	combineRegions(java.util.ArrayList<SnippetGenerator.SnippetRegion> regions)
java.lang.String	getSnippet(java.lang.String documentText, java.util.Set<java.lang.String> queryTerms) Produces a short query-dependent summary of a document with query terms highlighted.
java.lang.String	highlight(java.lang.String documentText, java.util.Set<java.lang.String> queryTerms) Highlights query terms in a string of document text.
java.lang.String	stripTag(java.lang.String tag, java.lang.String input)
java.lang.String	stripTags(java.lang.String input)

Methods inherited from class java.lang.Object

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

Field Detail

width

public static final int width

See Also:

Constant Field Values

Constructor Detail

SnippetGenerator

public SnippetGenerator()

Method Detail

highlight

public java.lang.String highlight(java.lang.String documentText,
                                  java.util.Set<java.lang.String> queryTerms)
                           throws java.io.IOException

Highlights query terms in a string of document text. This is most useful for highlighting query terms in document titles.

Throws:

java.io.IOException

getSnippet

public java.lang.String getSnippet(java.lang.String documentText,
                                   java.util.Set<java.lang.String> queryTerms)
                            throws java.io.IOException

Produces a short query-dependent summary of a document with query terms highlighted. The result is an HTML string.

Throws:

java.io.IOException

buildHtmlString

public java.lang.String buildHtmlString(SnippetGenerator.Snippet best,
                                        Document document,
                                        java.util.ArrayList<TagTokenizer.Pair> positions)

stripTag

public java.lang.String stripTag(java.lang.String tag,
                                 java.lang.String input)

stripTags

public java.lang.String stripTags(java.lang.String input)

combineRegions

public java.util.ArrayList<SnippetGenerator.SnippetRegion> combineRegions(java.util.ArrayList<SnippetGenerator.SnippetRegion> regions)