public interface MatchDocumentSummary
Modifier and Type | Method and Description |
---|---|
double |
getConfidence()
Returns the confidence messsure associated with the document.
|
ExtractedResult |
getExtracted() |
<T extends XMLReadHandle> |
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> |
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> |
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> |
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.
|
String getUri()
int getScore()
double getConfidence()
ExtractedResult getExtracted()
double getFitness()
String getPath()
MatchLocation[] getMatchLocations()
Document[] getSnippets()
<T extends XMLReadHandle> Iterator<T> getSnippetIterator(T handle)
T
- the type of XMLReadHandle to iterate overhandle
- An XML handle for reading the snippets.<T> T getFirstSnippetAs(Class<T> as)
ContentHandle
are registered.
Learn more about shortcut methodsT
- the type of object that will be returned by the handle registered for itas
- the IO class for reading the first snippet for the result<T extends XMLReadHandle> T getFirstSnippet(T handle)
T
- the type of XMLReadHandle to returnhandle
- An XML handle for reading the first snippet.String getFirstSnippetText()
Document getMetadata()
<T> T getMetadataAs(Class<T> as)
ContentHandle
are registered.
Learn more about shortcut methodsT
- the type of object that will be returned by the handle registered for itas
- the IO class for reading the metadata for the result<T extends XMLReadHandle> T getMetadata(T handle)
T
- the type of XMLReadHandle to returnhandle
- An XML handle for reading the metadata.String getMimeType()
Format getFormat()
Document getRelevanceInfo()
<T extends XMLReadHandle> T getRelevanceInfo(T handle)
T
- the type of XMLReadHandle to returnhandle
- An XML handle for reading the relevance information.String[] getSimilarDocumentUris()
Copyright © 2013-2016 MarkLogic Corporation.