com.marklogic.client.query

Interface MatchLocation

public interface MatchLocation

A MatchLocation represents a location in a document matched by a search.

Method Summary

Modifier and Type	Method and Description
String	getAllSnippetText() Returns the entire text only of the snippet, excluding any highlight tags.
String	getPath() Returns the path to the matching location in the document.
MatchSnippet[]	getSnippets() Returns the array of elements in the snippet.

Method Detail

getPath

String getPath()

Returns the path to the matching location in the document.

Returns:

The path.

getAllSnippetText

String getAllSnippetText()

Returns the entire text only of the snippet, excluding any highlight tags.

Returns:

The snippet text.

getSnippets

MatchSnippet[] getSnippets()

Returns the array of elements in the snippet.

Some snippets are highlighted, others are not.

Returns:

The array of snippet elements.