Package chemaxon.sss.search

Class MatchCountOptions

java.lang.Object
chemaxon.sss.search.MatchCountOptions
All Implemented Interfaces:
SearchConstants, Serializable
@PublicAPI public class MatchCountOptions extends Object implements Serializable, SearchConstants
Class to encapsulate Match count option parameters used by JChemSearch.
Since:
JChem 5.0
See Also:

  • Constructor Details

    • MatchCountOptions

      public MatchCountOptions(int hitLimitLow, boolean isLowerLimitIncluded, int hitLimitHigh, boolean isHigherLimitIncluded)
      Public constructor for MatchCountOptions in between mode
      Parameters:
      hitLimitLow - The lower limit for the number of hits.
      isLowerLimitIncluded - If true, equality is allowed with hitLimitLow.
      hitLimitHigh - The upper limit for the number of hits. If you pass Integer.MAX_VALUE, it will be treated as infinity. (I.e. only the lower limit is applied.)
      isHigherLimitIncluded - If true, equality is allowed with hitLimitHigh.
      Since:
      JChem 5.0

    • MatchCountOptions

      public MatchCountOptions(String relation, int hitLimit)
      Public constructor for MatchCountOptions in relation mode
      Parameters:
      relation - The relational operation of the question. This operation will be used to compare the number of hits to hitLimit. Available values:
      "=" - tests equality to hitLimit.
      "<" - returns true if the number of found hits is less than hitLimit.
      "<=" - less than or equality
      ">" - greater than
      ">=" - greater than or equality
      Specifying null disables match count rules.
      hitLimit - The limit for the number of hits.
      Since:
      JChem 5.0

  • Method Details

    • getMatchCountHighLimit

      public int getMatchCountHighLimit()
      Returns:
      the matchCountHighLimit
      Since:
      JChem 5.0

    • setMatchCountHighLimit

      public void setMatchCountHighLimit(int matchCountHighLimit)
      Parameters:
      matchCountHighLimit - the matchCountHighLimit to set
      Since:
      JChem 5.0

    • isMatchCountHighLimitInclusive

      public boolean isMatchCountHighLimitInclusive()
      Returns:
      the matchCountHighLimitInclusive
      Since:
      JChem 5.0

    • setMatchCountHighLimitInclusive

      public void setMatchCountHighLimitInclusive(boolean matchCountHighLimitInclusive)
      Parameters:
      matchCountHighLimitInclusive - the matchCountHighLimitInclusive to set
      Since:
      JChem 5.0

    • getMatchCounthitLimit

      public int getMatchCounthitLimit()
      Returns:
      the matchCounthitLimit
      Since:
      JChem 5.0

    • setMatchCounthitLimit

      public void setMatchCounthitLimit(int matchCounthitLimit)
      Parameters:
      matchCounthitLimit - the matchCounthitLimit to set

    • isMatchCountIncludesZero

      public boolean isMatchCountIncludesZero()
      Returns:
      the matchCountIncludesZero
      Since:
      JChem 5.0

    • setMatchCountIncludesZero

      public void setMatchCountIncludesZero(boolean matchCountIncludesZero)
      Parameters:
      matchCountIncludesZero - the matchCountIncludesZero to set
      Since:
      JChem 5.0

    • getMatchCountLowLimit

      public int getMatchCountLowLimit()
      Returns:
      the matchCountLowLimit
      Since:
      JChem 5.0

    • setMatchCountLowLimit

      public void setMatchCountLowLimit(int matchCountLowLimit)
      Parameters:
      matchCountLowLimit - the matchCountLowLimit to set
      Since:
      JChem 5.0

    • isMatchCountLowLimitInclusive

      public boolean isMatchCountLowLimitInclusive()
      Returns:
      the matchCountLowLimitInclusive
      Since:
      JChem 5.0

    • setMatchCountLowLimitInclusive

      public void setMatchCountLowLimitInclusive(boolean matchCountLowLimitInclusive)
      Parameters:
      matchCountLowLimitInclusive - the matchCountLowLimitInclusive to set
      Since:
      JChem 5.0

    • getMode

      public int getMode()
      Returns:
      the mode
      Since:
      JChem 5.0

    • getMatchCountRelation

      public String getMatchCountRelation()
      Returns:
      the matchCountRelation
      Since:
      JChem 5.0

    • setMatchCountRelation

      public void setMatchCountRelation(String matchCountRelation)
      Parameters:
      matchCountRelation - the matchCountRelation to set
      Since:
      JChem 5.0

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      There are two possible representations of object:
      • "matchCountOptions:[lower limit]_[is lower limit included]_ [higher limit]_[is higher limit included]"
      • "matchCountOptions:[relation]_[hit limit]"
      Example:
      • "matchCountOptions:3_true_7_false"
      • "matchCountOptions:>=_9"