public interface SearchResults
Modifier and Type | Method and Description |
---|---|
<T extends XMLReadHandle> |
getConstraint(String name,
T handle)
Returns the named constraint used in the search
(if requested).
|
<T extends XMLReadHandle> |
getConstraintIterator(T handle)
Returns an iterator over the constraints used in the search
(if requested).
|
String[] |
getConstraintNames()
Returns the array of constraint names used in the search
(if requested).
|
String[] |
getFacetNames()
Returns the array of facet names returned by this search.
|
FacetResult |
getFacetResult(String name)
Returns the facet results for the named facet.
|
FacetResult[] |
getFacetResults()
Returns the array of facet results.
|
MatchDocumentSummary[] |
getMatchResults()
Returns the match results.
|
SearchMetrics |
getMetrics()
Returns the search metrics.
|
int |
getPageLength()
Returns the maximum number of results in the search response page.
|
Document |
getPlan()
Returns the query plan.
|
<T extends XMLReadHandle> |
getPlan(T handle)
Returns the plan for the search (if requested).
|
<T extends XMLReadHandle> |
getQuery(T handle)
Returns the cts:query used in the search (if requested).
|
QueryDefinition |
getQueryCriteria()
Returns the query definition associated with this query.
|
SearchHandle.Report[] |
getReports()
Returns the array of reports returned by this search.
|
String |
getSnippetTransformType()
The type of transform used to produce the result snippets.
|
long |
getStart()
Returns the offset of the first result in the search reponse page.
|
String[] |
getStringQueries()
Returns the string query input (if provided and requested).
|
long |
getTotalResults()
Returns an estimate of the total number of results, which is accurate for unfiltered
queries.
|
SearchHandle.Warning[] |
getWarnings()
Returns the array of warnings returned by this search.
|
QueryDefinition getQueryCriteria()
long getTotalResults()
long getStart()
int getPageLength()
String getSnippetTransformType()
SearchMetrics getMetrics()
MatchDocumentSummary[] getMatchResults()
FacetResult[] getFacetResults()
FacetResult getFacetResult(String name)
name
- The facet name.String[] getFacetNames()
Document getPlan()
SearchHandle.Warning[] getWarnings()
SearchHandle.Report[] getReports()
String[] getConstraintNames()
<T extends XMLReadHandle> T getConstraint(String name, T handle)
T
- the type of XMLReadHandle to returnname
- The constraint name.handle
- An XML handle for reading the constraint.<T extends XMLReadHandle> Iterator<T> getConstraintIterator(T handle)
T
- the type of XMLReadHandle's to return in the Iteratorhandle
- An XML handle for reading the constraints.<T extends XMLReadHandle> T getPlan(T handle)
T
- the type of XMLReadHandle to returnhandle
- An XML handle for reading the plan.String[] getStringQueries()
<T extends XMLReadHandle> T getQuery(T handle)
T
- the type of XMLReadHandle to returnhandle
- An XML handle for reading the query.Copyright © 2013-2016 MarkLogic Corporation.