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

Class TierBar

  • All Implemented Interfaces:
    ResultType
    public class TierBar
extends java.lang.Object
implements ResultType

    A tier bar

    Results are grouped by tier bars depending of how they match the query terms. There is usually one tier bar for the fully matching results and anoter one for the partially matching results.

    Since:
    11.0

    • Nested Class Summary

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DATE_PATTERN
      Date format used in tier bar, when the -event query processor option is used.
      private java.util.Date eventDate
      Date of the events for this tier bar when the -events query processor option is set.
      private int firstRank
      Rank of the first search result contained within this tier bar
      private int lastRank
      Rank of the last search result contained within this tier bar
      private int matched
      Number of query terms matched by this tier bar
      private int outOf
      Total number of query terms, including the one matched by this tier bar.

    • Constructor Summary

      Constructors 
      Constructor Description
      TierBar()  
      TierBar​(int matched, int outOf, int firstRank, int lastRank, java.util.Date eventDate)  
      TierBar​(int matched, int outOf, java.util.Date eventDate)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Date getEventDate()
      Date of the events for this tier bar when the -events query processor option is set.
      int getFirstRank()
      Rank of the first search result contained within this tier bar
      int getLastRank()
      Rank of the last search result contained within this tier bar
      int getMatched()
      Number of query terms matched by this tier bar
      int getOutOf()
      Total number of query terms, including the one matched by this tier bar.
      void setEventDate​(java.util.Date eventDate)
      Date of the events for this tier bar when the -events query processor option is set.
      void setFirstRank​(int firstRank)
      Rank of the first search result contained within this tier bar
      void setLastRank​(int lastRank)
      Rank of the last search result contained within this tier bar
      void setMatched​(int matched)
      Number of query terms matched by this tier bar
      void setOutOf​(int outOf)
      Total number of query terms, including the one matched by this tier bar.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DATE_PATTERN

        public static final java.lang.String DATE_PATTERN
        Date format used in tier bar, when the -event query processor option is used.
        See Also:
        Constant Field Values

      • matched

        private int matched
        Number of query terms matched by this tier bar

      • outOf

        private int outOf
        Total number of query terms, including the one matched by this tier bar.

      • firstRank

        private int firstRank
        Rank of the first search result contained within this tier bar

      • lastRank

        private int lastRank
        Rank of the last search result contained within this tier bar

      • eventDate

        private java.util.Date eventDate

        Date of the events for this tier bar when the -events query processor option is set.

    • Constructor Detail

      • TierBar

        public TierBar​(int matched,
               int outOf,
               java.util.Date eventDate)

      • TierBar

        public TierBar​(int matched,
               int outOf,
               int firstRank,
               int lastRank,
               java.util.Date eventDate)

      • TierBar

        public TierBar()

    • Method Detail

      • getMatched

        public int getMatched()
        Number of query terms matched by this tier bar

      • setMatched

        public void setMatched​(int matched)
        Number of query terms matched by this tier bar

      • getOutOf

        public int getOutOf()
        Total number of query terms, including the one matched by this tier bar.

      • setOutOf

        public void setOutOf​(int outOf)
        Total number of query terms, including the one matched by this tier bar.

      • getFirstRank

        public int getFirstRank()
        Rank of the first search result contained within this tier bar

      • setFirstRank

        public void setFirstRank​(int firstRank)
        Rank of the first search result contained within this tier bar

      • getLastRank

        public int getLastRank()
        Rank of the last search result contained within this tier bar

      • setLastRank

        public void setLastRank​(int lastRank)
        Rank of the last search result contained within this tier bar

      • getEventDate

        public java.util.Date getEventDate()

        Date of the events for this tier bar when the -events query processor option is set.

      • setEventDate

        public void setEventDate​(java.util.Date eventDate)

        Date of the events for this tier bar when the -events query processor option is set.