Package com.funnelback.publicui.search.model.padre

Class ResultsSummary

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ResultsSummary.Schema
      Constants for the PADRE XML result packet tags.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean anyUrlsPromoted
      Are any URLs promoted (includes URLs that may have been later removed or collapsed).
      private java.lang.Integer carriedOverFtd
      Number of events continued from the day when using event search.
      private java.lang.Integer collapsed
      Number of collapsed results
      private java.lang.Integer currEnd
      Current offset of the last result returned.
      private java.lang.Integer currStart
      Current offset of the first result returned.
      private java.lang.Boolean estimatedCounts
      Whether or not the counts within this summary have been estimated.
      private java.lang.Integer fullyMatching
      Number of documents that fully matched the query terms.
      private java.lang.Integer nextStart
      Offset of the first result of the next page of results.
      private java.lang.Integer numRanks
      Number of results returned.
      private java.lang.Integer partiallyMatching
      Number of documents that partially matched the query terms.
      private java.lang.Integer prevStart
      Offset of the first result of the previous page of results.
      private boolean resultDiversificationApplied
      Was any result afected by result diversification.
      private java.lang.Integer totalDistinctMatchingUrls
      Number of distinct URLs when using event search.
      private java.lang.Integer totalMatching
      Total number of documents matching the query terms, fully or partially.
      private java.lang.Integer totalSecurityObscuredUrls
      The number of results which are not viewable to the user

    • Constructor Summary

      Constructors 
      Constructor Description
      ResultsSummary()  
      ResultsSummary​(java.lang.Integer fullyMatching, java.lang.Integer collapsed, java.lang.Integer partiallyMatching, java.lang.Integer totalMatching, java.lang.Boolean estimatedCounts, java.lang.Integer carriedOverFtd, java.lang.Integer totalDistinctMatchingUrls, java.lang.Integer numRanks, java.lang.Integer currStart, java.lang.Integer currEnd, java.lang.Integer prevStart, java.lang.Integer nextStart, java.lang.Integer totalSecurityObscuredUrls, boolean anyUrlsPromoted, boolean resultDiversificationApplied)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Integer getCarriedOverFtd()
      Number of events continued from the day when using event search.
      java.lang.Integer getCollapsed()
      Number of collapsed results
      java.lang.Integer getCurrEnd()
      Current offset of the last result returned.
      java.lang.Integer getCurrStart()
      Current offset of the first result returned.
      java.lang.Boolean getEstimatedCounts()
      Whether or not the counts within this summary have been estimated.
      java.lang.Integer getFullyMatching()
      Number of documents that fully matched the query terms.
      java.lang.Integer getNextStart()
      Offset of the first result of the next page of results.
      java.lang.Integer getNumRanks()
      Number of results returned.
      java.lang.Integer getPartiallyMatching()
      Number of documents that partially matched the query terms.
      java.lang.Integer getPrevStart()
      Offset of the first result of the previous page of results.
      java.lang.Integer getTotalDistinctMatchingUrls()
      Number of distinct URLs when using event search.
      java.lang.Integer getTotalMatching()
      Total number of documents matching the query terms, fully or partially.
      java.lang.Integer getTotalSecurityObscuredUrls()
      The number of results which are not viewable to the user
      boolean isAnyUrlsPromoted()
      Are any URLs promoted (includes URLs that may have been later removed or collapsed).
      boolean isResultDiversificationApplied()
      Was any result afected by result diversification.
      void setAnyUrlsPromoted​(boolean anyUrlsPromoted)
      Are any URLs promoted (includes URLs that may have been later removed or collapsed).
      void setCarriedOverFtd​(java.lang.Integer carriedOverFtd)
      Number of events continued from the day when using event search.
      void setCollapsed​(java.lang.Integer collapsed)
      Number of collapsed results
      void setCurrEnd​(java.lang.Integer currEnd)
      Current offset of the last result returned.
      void setCurrStart​(java.lang.Integer currStart)
      Current offset of the first result returned.
      void setEstimatedCounts​(java.lang.Boolean estimatedCounts)
      Whether or not the counts within this summary have been estimated.
      void setFullyMatching​(java.lang.Integer fullyMatching)
      Number of documents that fully matched the query terms.
      void setNextStart​(java.lang.Integer nextStart)
      Offset of the first result of the next page of results.
      void setNumRanks​(java.lang.Integer numRanks)
      Number of results returned.
      void setPartiallyMatching​(java.lang.Integer partiallyMatching)
      Number of documents that partially matched the query terms.
      void setPrevStart​(java.lang.Integer prevStart)
      Offset of the first result of the previous page of results.
      void setResultDiversificationApplied​(boolean resultDiversificationApplied)
      Was any result afected by result diversification.
      void setTotalDistinctMatchingUrls​(java.lang.Integer totalDistinctMatchingUrls)
      Number of distinct URLs when using event search.
      void setTotalMatching​(java.lang.Integer totalMatching)
      Total number of documents matching the query terms, fully or partially.
      void setTotalSecurityObscuredUrls​(java.lang.Integer totalSecurityObscuredUrls)
      The number of results which are not viewable to the user

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • fullyMatching

        private java.lang.Integer fullyMatching
        Number of documents that fully matched the query terms.

      • collapsed

        private java.lang.Integer collapsed
        Number of collapsed results

      • partiallyMatching

        private java.lang.Integer partiallyMatching
        Number of documents that partially matched the query terms.

      • totalMatching

        private java.lang.Integer totalMatching

        Total number of documents matching the query terms, fully or partially.

        Should be fullyMatching + partiallyMatching.

      • estimatedCounts

        private java.lang.Boolean estimatedCounts

        Whether or not 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 java.lang.Integer carriedOverFtd

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

        See the -events query processor options.

      • totalDistinctMatchingUrls

        private java.lang.Integer totalDistinctMatchingUrls

        Number of distinct URLs when using event search.

        See the -events query processor options.

      • numRanks

        private java.lang.Integer numRanks
        Number of results returned.

      • currStart

        private java.lang.Integer currStart

        Current offset of the first result returned.

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

        See: start_rank parameter, num_ranks parameter.

      • currEnd

        private java.lang.Integer currEnd

        Current offset of the last result returned.

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

        See: start_rank parameter, num_ranks parameter.

      • prevStart

        private java.lang.Integer prevStart

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

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

        See: start_rank parameter, num_ranks parameter.

      • nextStart

        private java.lang.Integer nextStart

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

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

        See: start_rank parameter, num_ranks parameter.

      • totalSecurityObscuredUrls

        private java.lang.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 afected by result diversification.
        Since:
        15.12

    • Constructor Detail

      • ResultsSummary

        public ResultsSummary​(java.lang.Integer fullyMatching,
                      java.lang.Integer collapsed,
                      java.lang.Integer partiallyMatching,
                      java.lang.Integer totalMatching,
                      java.lang.Boolean estimatedCounts,
                      java.lang.Integer carriedOverFtd,
                      java.lang.Integer totalDistinctMatchingUrls,
                      java.lang.Integer numRanks,
                      java.lang.Integer currStart,
                      java.lang.Integer currEnd,
                      java.lang.Integer prevStart,
                      java.lang.Integer nextStart,
                      java.lang.Integer totalSecurityObscuredUrls,
                      boolean anyUrlsPromoted,
                      boolean resultDiversificationApplied)

      • ResultsSummary

        public ResultsSummary()

    • Method Detail

      • getFullyMatching

        public java.lang.Integer getFullyMatching()
        Number of documents that fully matched the query terms.

      • setFullyMatching

        public void setFullyMatching​(java.lang.Integer fullyMatching)
        Number of documents that fully matched the query terms.

      • getCollapsed

        public java.lang.Integer getCollapsed()
        Number of collapsed results

      • setCollapsed

        public void setCollapsed​(java.lang.Integer collapsed)
        Number of collapsed results

      • getPartiallyMatching

        public java.lang.Integer getPartiallyMatching()
        Number of documents that partially matched the query terms.

      • setPartiallyMatching

        public void setPartiallyMatching​(java.lang.Integer partiallyMatching)
        Number of documents that partially matched the query terms.

      • getTotalMatching

        public java.lang.Integer getTotalMatching()

        Total number of documents matching the query terms, fully or partially.

        Should be fullyMatching + partiallyMatching.

      • setTotalMatching

        public void setTotalMatching​(java.lang.Integer totalMatching)

        Total number of documents matching the query terms, fully or partially.

        Should be fullyMatching + partiallyMatching.

      • getEstimatedCounts

        public java.lang.Boolean getEstimatedCounts()

        Whether or not 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).

      • setEstimatedCounts

        public void setEstimatedCounts​(java.lang.Boolean estimatedCounts)

        Whether or not 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).

      • getCarriedOverFtd

        public java.lang.Integer getCarriedOverFtd()

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

        See the -events query processor options.

      • setCarriedOverFtd

        public void setCarriedOverFtd​(java.lang.Integer carriedOverFtd)

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

        See the -events query processor options.

      • getTotalDistinctMatchingUrls

        public java.lang.Integer getTotalDistinctMatchingUrls()

        Number of distinct URLs when using event search.

        See the -events query processor options.

      • setTotalDistinctMatchingUrls

        public void setTotalDistinctMatchingUrls​(java.lang.Integer totalDistinctMatchingUrls)

        Number of distinct URLs when using event search.

        See the -events query processor options.

      • getNumRanks

        public java.lang.Integer getNumRanks()
        Number of results returned.

      • setNumRanks

        public void setNumRanks​(java.lang.Integer numRanks)
        Number of results returned.

      • getCurrStart

        public java.lang.Integer getCurrStart()

        Current offset of the first result returned.

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

        See: start_rank parameter, num_ranks parameter.

      • setCurrStart

        public void setCurrStart​(java.lang.Integer currStart)

        Current offset of the first result returned.

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

        See: start_rank parameter, num_ranks parameter.

      • getCurrEnd

        public java.lang.Integer getCurrEnd()

        Current offset of the last result returned.

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

        See: start_rank parameter, num_ranks parameter.

      • setCurrEnd

        public void setCurrEnd​(java.lang.Integer currEnd)

        Current offset of the last result returned.

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

        See: start_rank parameter, num_ranks parameter.

      • getPrevStart

        public java.lang.Integer getPrevStart()

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

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

        See: start_rank parameter, num_ranks parameter.

      • setPrevStart

        public void setPrevStart​(java.lang.Integer prevStart)

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

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

        See: start_rank parameter, num_ranks parameter.

      • getNextStart

        public java.lang.Integer getNextStart()

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

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

        See: start_rank parameter, num_ranks parameter.

      • setNextStart

        public void setNextStart​(java.lang.Integer nextStart)

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

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

        See: start_rank parameter, num_ranks parameter.

      • getTotalSecurityObscuredUrls

        public java.lang.Integer getTotalSecurityObscuredUrls()

        The number of results which are not viewable to the user

        Only set when Translucent DLS is enabled.

      • setTotalSecurityObscuredUrls

        public void setTotalSecurityObscuredUrls​(java.lang.Integer totalSecurityObscuredUrls)

        The number of results which are not viewable to the user

        Only set when Translucent DLS is enabled.

      • isAnyUrlsPromoted

        public boolean isAnyUrlsPromoted()
        Are any URLs promoted (includes URLs that may have been later removed or collapsed).
        Since:
        15.12

      • setAnyUrlsPromoted

        public void setAnyUrlsPromoted​(boolean anyUrlsPromoted)
        Are any URLs promoted (includes URLs that may have been later removed or collapsed).
        Since:
        15.12

      • isResultDiversificationApplied

        public boolean isResultDiversificationApplied()
        Was any result afected by result diversification.
        Since:
        15.12

      • setResultDiversificationApplied

        public void setResultDiversificationApplied​(boolean resultDiversificationApplied)
        Was any result afected by result diversification.
        Since:
        15.12