Package oracle.webcenter.search.refine

Class DateRefinement

java.lang.Object
oracle.webcenter.search.refine.Refinement<Calendar>
oracle.webcenter.search.refine.DateRefinement
All Implemented Interfaces:
Serializable, Cloneable
@Exported public class DateRefinement extends Refinement<Calendar>
A Calendar based refinement that captures a lot of the logic dates go through when used as Refiners for a search.
Since:
11.1.1.0.0 Beta 2
See Also:

  • Constructor Details

    • DateRefinement

      public DateRefinement(List<Refinement.Clause<Calendar>> clauses, int count, DateRefinement.DateRefinementListener listener)
      Constructs a DateRefinement with a List of clauses and a count.
      Parameters:
      clauses - the List off Refinement.Clause objects to be used in this Refinement.
      count - the number of results expected when this DateRefinement is applied
      listener - the implementation class of the listener interface

    • DateRefinement

      public DateRefinement(Calendar date, int count, DateRefinement.DateRefinementListener listener)
      Constructs a DateRefinement with one single Calendar value and the number of times that Calendar value shows up.
      Parameters:
      date - the Calendar value based on which an EQUALS clause is built
      count - the number of results expected when this DateRefinement
      listener - the implementation class of the listener interface is applied

  • Method Details

    • initClauses

      protected List<Refinement.Clause<Calendar>> initClauses(Calendar value, String comparator)
      Overrides:
      initClauses in class Refinement<Calendar>

    • isAccumulative

      public boolean isAccumulative()
      Is this refinement accumulative over another refinement?

    • setAccumulative

      public void setAccumulative(boolean value)
      Set the accumulative characteristic of this refinement

    • setCalendarType

      public void setCalendarType(int value)
      Set calendar type
      Parameters:
      value - Calendar field constant

    • isYearly

      public boolean isYearly()
      Is calendar type yearly?

    • isMonthly

      public boolean isMonthly()
      Is calendar type monthly?

    • isDaily

      public boolean isDaily()
      Is calendar type daily?

    • isSinceNumDays

      public boolean isSinceNumDays()
      Is calender type since num days?

    • getYear

      public Calendar getYear()
      If refinement is a yearly refinement, return a calendar object of the year.

    • createPredicate

      protected AttributePredicate<Calendar> createPredicate(QName name, String comparator, Calendar value)
      Overrides:
      createPredicate in class Refinement<Calendar>

    • buildName

      protected void buildName(Calendar calendar)
      Builds the name of the DateRefinement with a Calendar by formatting it and setting the name to be that String value.
      Specified by:
      buildName in class Refinement<Calendar>
      Parameters:
      calendar - the Calendar value to use to build the name

    • getConjunctionOp

      public ComplexPredicate.ConjunctionOp getConjunctionOp()
      Returns the conjunction operator for this DateRefinement.
      Specified by:
      getConjunctionOp in class Refinement<Calendar>
      Returns:
      a ConjunctionOp value that is either an And or an Or.

    • addAttributePredicate

      protected void addAttributePredicate(List<Predicate> children, AttributePredicate<Calendar> newPredicate) throws ContradictionException
      Adds an attribute predicate to the list of Predicate objects held within a top-level ComplexPredicate. The assumption on the top-level ComplexPredicate is that it serves only one Refiner and therefore in this case, we only care about the DateRefiner.
      Overrides:
      addAttributePredicate in class Refinement<Calendar>
      Parameters:
      children - a List of child Predicates coming from a ComplexPredicate dedicated to a DateRefiner.
      newPredicate - the new Predicate to be added to the list of child Predicates.
      Throws:
      ContradictionException

    • hasMatch

      public final boolean hasMatch(Calendar value)
      Returns whether the calendar value passed in matches the criteria held in this Refinement.
      Specified by:
      hasMatch in class Refinement<Calendar>
      Parameters:
      value - the Calendar value to be matched.
      Returns:
      true if the value falls within the range defined by this Refinement.

    • hasMatch

      public final boolean hasMatch(Calendar value, String comparator, Calendar clauseValue)
      Matches a Calendar value with a criterion made up of a comparator and another Calendar.
      Parameters:
      value - the value to compare
      comparator - the comparator to use
      clauseValue - the value to compare against
      Returns:
      true if the value compares positively with the comparator and the clause value.

    • getNumDaysAsCalendar

      public static final Calendar getNumDaysAsCalendar(int num)
      Get Calendar object for operand of SinceNumDays comparator
      Parameters:
      num - number of days
      Returns:
      Calendar representing the operand of SinceNumDays comparator

    • getCalendarSinceNumDays

      public final Calendar getCalendarSinceNumDays(Calendar cal)

    • getCalendarSinceNumDays

      public static final Calendar getCalendarSinceNumDays(Calendar cal, TimeZone timeZone)
      Get Calendar object for query execution of SinceNumDays comparator
      Parameters:
      cal - representing the operand of SinceNumDays comparator
      Returns:
      Calendar representing the calendar for SinceNumDays comparator

    • getNumDays

      public static final int getNumDays(Date date)
      Get number of days from Date object of operand of SinceNumDays comparator
      Parameters:
      date - Date object of operand of SinceNumDays comparator
      int - value of NumDays