SearchHandle
public interface SearchResults
Modifier and Type | Method | Description |
---|---|---|
<T extends XMLReadHandle> |
getConstraint(java.lang.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).
|
java.lang.String[] |
getConstraintNames() |
Returns the array of constraint names used in
the search (if requested).
|
java.lang.String[] |
getFacetNames() |
Returns the array of facet names returned by
this search.
|
FacetResult |
getFacetResult(java.lang.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.
|
org.w3c.dom.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).
|
SearchQueryDefinition |
getQueryCriteria() |
Returns the search query definition associated
with this query.
|
SearchHandle.Report[] |
getReports() |
Returns the array of reports returned by this
search.
|
java.lang.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.
|
java.lang.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.
|
SearchQueryDefinition getQueryCriteria()
long getTotalResults()
long getStart()
int getPageLength()
java.lang.String getSnippetTransformType()
SearchMetrics getMetrics()
MatchDocumentSummary[] getMatchResults()
FacetResult[] getFacetResults()
FacetResult getFacetResult(java.lang.String name)
name
- The facet name.java.lang.String[] getFacetNames()
org.w3c.dom.Document getPlan()
SearchHandle.Warning[] getWarnings()
SearchHandle.Report[] getReports()
java.lang.String[] getConstraintNames()
<T extends XMLReadHandle> T getConstraint(java.lang.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> java.util.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.java.lang.String[] getStringQueries()
<T extends XMLReadHandle> T getQuery(T handle)
T
- the type of XMLReadHandle to returnhandle
- An XML handle for reading the query.Copyright © 2022 MarkLogic Corporation