Class ResultsSummary


  • public class ResultsSummary
    extends Object
    Search result summary, with document counts and information about the current page returned.
    Since:
    11.0
    • Field Detail

      • fullyMatching

        private Integer fullyMatching
        Number of documents that fully matched the query terms.
      • collapsed

        private Integer collapsed
        Number of collapsed results
      • partiallyMatching

        private Integer partiallyMatching
        Number of documents that partially matched the query terms.
      • estimatedCounts

        private Boolean estimatedCounts

        Whether the counts within this summary have been estimated.

        Estimation occurs when the result set is only partially scanned (e.g. more results are found than the daat value).

      • carriedOverFtd

        private Integer carriedOverFtd

        Number of events continued from the day when using event search.

        See the -events query processor options.

      • totalDistinctMatchingUrls

        private Integer totalDistinctMatchingUrls

        Number of distinct URLs when using event search.

        See the -events query processor options.

      • numRanks

        private Integer numRanks
        Number of results returned.
      • currStart

        private Integer currStart

        Current offset of the first result returned.

        For example if the second page of results was returned and 10 results were requested, this will be set to 11.

        See: start_rank parameter, num_ranks parameter.

      • currEnd

        private Integer currEnd

        Current offset of the last result returned.

        For example if the second page of results was returned and 10 results were requested, this will be set to 20.

        See: start_rank parameter, num_ranks parameter.

      • prevStart

        private Integer prevStart

        Offset of the first result of the previous page of results.

        For example if the second page of results was returned and 10 results were requested, this will be set to 1.

        See: start_rank parameter, num_ranks parameter.

      • nextStart

        private Integer nextStart

        Offset of the first result of the next page of results.

        For example if the second page of results was returned and 10 results were requested, this will be set to 21.

        See: start_rank parameter, num_ranks parameter.

      • totalSecurityObscuredUrls

        private Integer totalSecurityObscuredUrls

        The number of results which are not viewable to the user

        Only set when Translucent DLS is enabled.

      • anyUrlsPromoted

        private boolean anyUrlsPromoted
        Are any URLs promoted (includes URLs that may have been later removed or collapsed).
        Since:
        15.12
      • resultDiversificationApplied

        private boolean resultDiversificationApplied
        Was any result affected by result diversification.
        Since:
        15.12
    • Constructor Detail

      • ResultsSummary

        public ResultsSummary()