Interface SearchResults

All Known Implementing Classes:

SearchHandle

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  <T extends XMLReadHandle>
T

  getConstraint(String name, T handle)

  Returns the named constraint used in the search (if requested).

  <T extends XMLReadHandle>
Iterator<T>

  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>
T

  getPlan(T handle)

  Returns the plan for the search (if requested).

  <T extends XMLReadHandle>
T

  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.

  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.

• Method Details

  • getQueryCriteria

    SearchQueryDefinition getQueryCriteria()
    Returns the search query definition associated with this query.

    Returns:

    The search query definition.

  • getTotalResults

    long getTotalResults()
    Returns an estimate of the total number of results, which is accurate for unfiltered queries. In unfiltered queries, documents are matched based entirely on indexes. In filtered queries, documents are inspected during retrieval, which allows criteria for which indexes don't exist but makes the final result count unpredictable.

    Returns:

    The result estimate.

  • getStart

    long getStart()
    Returns the offset of the first result in the search reponse page.

    Returns:

    The first result number.

  • getPageLength

    int getPageLength()
    Returns the maximum number of results in the search response page.

    Returns:

    The page size.

  • getSnippetTransformType

    String getSnippetTransformType()
    The type of transform used to produce the result snippets.

    Returns:

    The snippet transform type

  • getMetrics

    SearchMetrics getMetrics()
    Returns the search metrics.

    Returns:

    The metrics.

  • getMatchResults

    MatchDocumentSummary[] getMatchResults()
    Returns the match results.

    Returns:

    The match results.

  • getFacetResults

    FacetResult[] getFacetResults()
    Returns the array of facet results.

    Returns:

    The facet results.

  • getFacetResult

    FacetResult getFacetResult(String name)
    Returns the facet results for the named facet.

    Parameters:

    name - The facet name.

    Returns:

    The facet results, or null if no facet with the specified name exists.

  • getFacetNames

    String[] getFacetNames()
    Returns the array of facet names returned by this search.

    Returns:

    The array facet names.

  • getPlan

    Document getPlan()
    Returns the query plan.

    Returns:

    The query plan.

  • getWarnings

    SearchHandle.Warning[] getWarnings()
    Returns the array of warnings returned by this search.

    Returns:

    The warnings.

  • getReports

    SearchHandle.Report[] getReports()
    Returns the array of reports returned by this search.

    Returns:

    The reports.

  • getConstraintNames

    String[] getConstraintNames()
    Returns the array of constraint names used in the search (if requested).

    Returns:

    The constraint names.

  • getConstraint

    <T extends XMLReadHandle> T getConstraint(String name, T handle)
    Returns the named constraint used in the search (if requested).

    Type Parameters:

    T - the type of XMLReadHandle to return

    Parameters:

    name - The constraint name.

    handle - An XML handle for reading the constraint.

    Returns:

    The handle on the constraint.

  • getConstraintIterator

    <T extends XMLReadHandle> Iterator<T> getConstraintIterator(T handle)
    Returns an iterator over the constraints used in the search (if requested).

    Type Parameters:

    T - the type of XMLReadHandle's to return in the Iterator

    Parameters:

    handle - An XML handle for reading the constraints.

    Returns:

    An iterator that populates the handle with each constraint.

  • getPlan

    <T extends XMLReadHandle> T getPlan(T handle)
    Returns the plan for the search (if requested).

    Type Parameters:

    T - the type of XMLReadHandle to return

    Parameters:

    handle - An XML handle for reading the plan.

    Returns:

    The handle on the plan.

  • getStringQueries

    String[] getStringQueries()
    Returns the string query input (if provided and requested).

    Returns:

    The string queries.

  • getQuery

    <T extends XMLReadHandle> T getQuery(T handle)
    Returns the cts:query used in the search (if requested).

    Type Parameters:

    T - the type of XMLReadHandle to return

    Parameters:

    handle - An XML handle for reading the query.

    Returns:

    The handle on the query.

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.