com.marklogic.client.query

Interface MatchSnippet

public interface MatchSnippet

A MatchSnippet is a Java object representation of a part of a snippet.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getText() Returns the string value of the run of text in this part of the snippet.
boolean	isHighlighted() Identifies whether this run of text in the snippet matches the search criteria or not.

Method Detail

isHighlighted

boolean isHighlighted()

Identifies whether this run of text in the snippet matches the search criteria or not. If the text matches the criteria, it will be highlighted.

Returns:

The hightlight value.

getText

java.lang.String getText()

Returns the string value of the run of text in this part of the snippet.

Returns:

The text string.