com.marklogic.client.query.MatchLocation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of marklogic-client-api Show documentation

The official MarkLogic Java client API.

The newest version!

/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.client.query;

/**
 * A MatchLocation represents a location in a document matched by a search.
 */
public interface MatchLocation {
  /**
   * Returns the path to the matching location in the document.
   * @return The path.
   */
  String getPath();

  /**
   * Returns the entire text only of the snippet, excluding any highlight tags.
   * @return The snippet text.
   */

  String getAllSnippetText();

  /**
   * Returns the array of elements in the snippet.
   *
   * Some snippets are highlighted, others are not.
   *
   * @return The array of snippet elements.
   */
  MatchSnippet[] getSnippets();
}