com.groupdocs.search.highlighters

Class DocumentHighlighter

java.lang.Object

com.groupdocs.search.common.ResultBuilderFactory

com.groupdocs.search.highlighters.Highlighter

com.groupdocs.search.highlighters.DocumentHighlighter

All Implemented Interfaces:

IResultBuilderFactory, IDocumentHighlighter, IHighlighter

public class DocumentHighlighter
extends Highlighter
implements IDocumentHighlighter

Represents a search result highlighter that highlights search results in an entire document text.

Learn more

• Highlighting search results

The example demonstrates a typical usage of the class.

 
 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Search for the phase 'Theory of Relativity'
 SearchResult result = index.search("\"Theory of Relativity\"");
 // Highlighting found words in the text of a document
 FoundDocument document = result.getFoundDocument(0);
 OutputAdapter outputAdapter = new FileOutputAdapter(OutputFormat.Html, "Highlighted.html");
 Highlighter highlighter = new DocumentHighlighter(outputAdapter);
 index.highlight(document, highlighter);
 
 

Field Summary

Fields inherited from class com.groupdocs.search.common.ResultBuilderFactory

core

Constructor Summary

Constructors

Constructor and Description
DocumentHighlighter(OutputAdapter outputAdapter) Initializes a new instance of the DocumentHighlighter class.

Method Summary

Modifier and Type	Method and Description
OutputAdapter	getOutputAdapter() Gets the output adapter passed in the constructor.

Methods inherited from class com.groupdocs.search.common.ResultBuilderFactory

getCore, getOutputFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.groupdocs.search.common.IResultBuilderFactory

getOutputFormat

Constructor Detail

DocumentHighlighter

public DocumentHighlighter(OutputAdapter outputAdapter)

Initializes a new instance of the DocumentHighlighter class.

Parameters:

outputAdapter - The output adapter transferring a result of the highlighting.

Method Detail

getOutputAdapter

public final OutputAdapter getOutputAdapter()

Gets the output adapter passed in the constructor.

Specified by:

getOutputAdapter in interface IDocumentHighlighter

Returns:

The output adapter passed in the constructor.