MatchDocumentSummary (MarkLogic Java Client API 4.0.1 2017-05-03)

```
public interface MatchDocumentSummary
```
A MatchDocumentSummary is the information returned for each document found by a search.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double`	`getConfidence()` Returns the confidence messsure associated with the document.
`ExtractedResult`	`getExtracted()`
`<T extends XMLReadHandle> T`	`getFirstSnippet(T handle)` Returns the content of the first snippet for the matched result document as a convenience, especially for a raw snippet that contains the entire result document.
`<T> T`	`getFirstSnippetAs(Class<T> as)` Reads the content of the first snippet for the matched result document in the representation specified by the IO class.
`String`	`getFirstSnippetText()` Returns the text of the first snippet as a convenience, especially for a raw snippet that contains an entire document in JSON or text format.
`double`	`getFitness()` Returns the fitness of the document.
`Format`	`getFormat()` Returns the format associated with this document
`MatchLocation[]`	`getMatchLocations()` Returns an array of match locations.
`Document`	`getMetadata()` Returns the metadata associated with this document.
`<T extends XMLReadHandle> T`	`getMetadata(T handle)` Returns the metadata extracted from the result document.
`<T> T`	`getMetadataAs(Class<T> as)` Reads the metadata extracted from the matched result document in the representation specified by the IO class.
`String`	`getMimeType()` Returns the mime type associated with this document.
`String`	`getPath()` Returns the path of the match.
`Document`	`getRelevanceInfo()` Get relevance info for a particular result.
`<T extends XMLReadHandle> T`	`getRelevanceInfo(T handle)` Returns the relevance information for the result.
`int`	`getScore()` Returns the score associated with the document.
`String[]`	`getSimilarDocumentUris()` Returns the uris for documents similar to the result (if requested).
`<T extends XMLReadHandle> Iterator<T>`	`getSnippetIterator(T handle)` Returns an iterator over the snippets matched for the result.
`Document[]`	`getSnippets()` Returns an array of snippets.
`String`	`getUri()` Returns the URI of the document.

- Method Detail
  - getUri
```
String getUri()
```
    Returns the URI of the document.
    
    Returns:
    
    The uri.
  - getScore
```
int getScore()
```
    Returns the score associated with the document.
    
    Returns:
    
    The score.
  - getConfidence
```
double getConfidence()
```
    Returns the confidence messsure associated with the document.
    
    Returns:
    
    The confidence.
  - getExtracted
```
ExtractedResult getExtracted()
```
  - getFitness
```
double getFitness()
```
    Returns the fitness of the document.
    
    Returns:
    
    The fitness.
  - getPath
```
String getPath()
```
    Returns the path of the match.
    
    Returns:
    
    The path.
  - getMatchLocations
```
MatchLocation[] getMatchLocations()
```
    Returns an array of match locations.
    
    Match locations (and snippets) can be represented as Java objects or DOM Documents, depending on the nature of the snippet and the configuration of the SearchHandle. If they are DOM documents, getMatchLocations() will return null and getSnippets() will return the documents.
    
    Returns:
    
    The array of match locations.
  - getSnippets
```
Document[] getSnippets()
```
    Returns an array of snippets.
    
    Match locations (and snippets) can be represented as Java objects or DOM Documents, depending on the nature of the snippet and the configuration of the SearchHandle. If they are DOM documents, getMatchLocations() will return null and getSnippets() will return the documents.
    
    Returns:
    
    The array of snippet documents.
  - getSnippetIterator
```
<T extends XMLReadHandle> Iterator<T> getSnippetIterator(T handle)
```
    Returns an iterator over the snippets matched for the result.
    
    Type Parameters:
    
    T - the type of XMLReadHandle to iterate over
    
    Parameters:
    
    handle - An XML handle for reading the snippets.
    
    Returns:
    
    An iterator that populates the handle with each snippet.
  - getFirstSnippetAs
```
<T> T getFirstSnippetAs(Class<T> as)
```
    Reads the content of the first snippet for the matched result document in the representation specified by the IO class. This method provides particular convenience for a raw snippet that contains the entire result document.
    
    The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered.
    Learn more about shortcut methods
    
    Type Parameters:
    
    T - the type of object that will be returned by the handle registered for it
    
    Parameters:
    
    as - the IO class for reading the first snippet for the result
    
    Returns:
    
    an object of the IO class with the content of the document in the first snippet
  - getFirstSnippet
```
<T extends XMLReadHandle> T getFirstSnippet(T handle)
```
    Returns the content of the first snippet for the matched result document as a convenience, especially for a raw snippet that contains the entire result document.
    
    Type Parameters:
    
    T - the type of XMLReadHandle to return
    
    Parameters:
    
    handle - An XML handle for reading the first snippet.
    
    Returns:
    
    The handle populated with the first snippet.
  - getFirstSnippetText
```
String getFirstSnippetText()
```
    Returns the text of the first snippet as a convenience, especially for a raw snippet that contains an entire document in JSON or text format.
    
    Returns:
    
    The text of the first snippet
  - getMetadata
```
Document getMetadata()
```
    Returns the metadata associated with this document.
    
    Returns:
    
    the metadata
  - getMetadataAs
```
<T> T getMetadataAs(Class<T> as)
```
    Reads the metadata extracted from the matched result document in the representation specified by the IO class.
    
    The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered.
    Learn more about shortcut methods
    
    Type Parameters:
    
    T - the type of object that will be returned by the handle registered for it
    
    Parameters:
    
    as - the IO class for reading the metadata for the result
    
    Returns:
    
    an object of the IO class with the extracted result document metadata
  - getMetadata
```
<T extends XMLReadHandle> T getMetadata(T handle)
```
    Returns the metadata extracted from the result document.
    
    Type Parameters:
    
    T - the type of XMLReadHandle to return
    
    Parameters:
    
    handle - An XML handle for reading the metadata.
    
    Returns:
    
    The handle on the metadata.
  - getMimeType
```
String getMimeType()
```
    Returns the mime type associated with this document.
    
    Returns:
    
    the mime type associated with this document.
  - getFormat
```
Format getFormat()
```
    Returns the format associated with this document
    
    Returns:
    
    the format
  - getRelevanceInfo
```
Document getRelevanceInfo()
```
    Get relevance info for a particular result. Includes data only if a query was sent with the ‘relevance-trace’ search option.
    
    Returns:
    
    A DOM Element containing relevance trace info. In the absence of the ‘relevance-trace’ option, returns null.
  - getRelevanceInfo
```
<T extends XMLReadHandle> T getRelevanceInfo(T handle)
```
    Returns the relevance information for the result.
    
    Type Parameters:
    
    T - the type of XMLReadHandle to return
    
    Parameters:
    
    handle - An XML handle for reading the relevance information.
    
    Returns:
    
    The handle on the relevance information.
  - getSimilarDocumentUris
```
String[] getSimilarDocumentUris()
```
    Returns the uris for documents similar to the result (if requested).
    
    Returns:
    
    The document uris.

Interface MatchDocumentSummary

Method Summary

Method Detail

getUri

getScore

getConfidence

getExtracted

getFitness

getPath

getMatchLocations

getSnippets

getSnippetIterator

getFirstSnippetAs

getFirstSnippet

getFirstSnippetText

getMetadata

getMetadataAs

getMetadata

getMimeType

getFormat

getRelevanceInfo

getRelevanceInfo

getSimilarDocumentUris