Package org.opengrok.indexer.search

Class Summary

java.lang.Object

org.opengrok.indexer.search.Summary

public class Summary
extends Object

A document summary dynamically generated to match a query.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Summary.Ellipsis	An ellipsis fragment within a summary.
static class	Summary.Fragment	A fragment of text within a summary.
static class	Summary.Highlight	A highlighted fragment of text within a summary.

Constructor Summary

Constructors

Constructor	Description
Summary()

Method Summary

Modifier and Type	Method	Description
void	add(Summary.Fragment fragment)
Summary.Fragment[]	getFragments()	Returns an array of all of this summary's fragments.
protected static String	htmlize(String q)
String	toString()	Returns an HTML representation of this fragment.

Methods inherited from class java.lang.Object

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

Constructor Details

Summary

public Summary()

Method Details

htmlize

protected static String htmlize(String q)

add

public void add(Summary.Fragment fragment)

getFragments

public Summary.Fragment[] getFragments()

Returns an array of all of this summary's fragments.

Returns:

fragment array

toString

public String toString()

Returns an HTML representation of this fragment.

Overrides:

toString in class Object

Returns:

string representation