MatchCountOptions (JChem Base API documentation (c) 1998-2020 ChemAxon Ltd.)

java.lang.Object
- chemaxon.sss.search.MatchCountOptions

All Implemented Interfaces:

SearchConstants, java.io.Serializable
```
@PublicAPI
public class MatchCountOptions
extends java.lang.Object
implements java.io.Serializable, SearchConstants
```
Class to encapsulate Match count option parameters used by JChemSearch.

Since:

JChem 5.0

Author:

Edvard Buki

See Also:

Serialized Form

Field Summary
- Fields inherited from interface chemaxon.sss.SearchConstants
  ABS_STEREO_ALWAYS_ON, ABS_STEREO_CHIRAL_FLAG, ABS_STEREO_TABLE_OPTION, ATTACHED_DATA_MATCH_EXACT, ATTACHED_DATA_MATCH_GENERAL, ATTACHED_DATA_MATCH_IGNORE, ATTACHMENT_ATOM, ATTACHMENT_LABEL, ATTACHMENT_MAP, ATTACHMENT_NONE, ATTACHMENT_POINT, ATTACHMENT_RLABEL, CHARGE_MATCHING_DEFAULT, CHARGE_MATCHING_EXACT, CHARGE_MATCHING_IGNORE, DEFAULT_DISSIMILARITY_THRESHOLD, DEFAULT_SEARCHTYPE, DISSIMILARITY_PROPERTY_NAME, DUPLICATE, FULL, FULL_FRAGMENT, HCOUNT_MATCHING_AUTO, HCOUNT_MATCHING_EQUAL, HCOUNT_MATCHING_GREATER_OR_EQUAL, HIT_EXCLUDEDQ, HIT_LP, HIT_MULTICENTER, HIT_NON_R, HIT_ORDERING_NONE, HIT_ORDERING_UNDEF_R_MATCHING_GROUP_FIRST, HIT_R, HIT_R_EMPTY_MATCH, HIT_UNMAPABLE, IMPLICIT_H_MATCHING_DEFAULT, IMPLICIT_H_MATCHING_DISABLED, IMPLICIT_H_MATCHING_ENABLED, IMPLICIT_H_MATCHING_IGNORE, ISOTOPE_MATCHING_DEFAULT, ISOTOPE_MATCHING_EXACT, ISOTOPE_MATCHING_IGNORE, MARKUSH_HIT_INNER, MARKUSH_HIT_ORIGINAL, MATCH_COUNT_BETWEEN, MATCH_COUNT_RELATION, NO_ABAS, NO_SCREEN, POSITION_ON_0TH_HEAVY_ATOM, RADICAL_MATCHING_DEFAULT, RADICAL_MATCHING_EXACT, RADICAL_MATCHING_IGNORE, SEARCH_MODE_NAMES, SEARCH_TYPE_NAMES, SIMILARITY, STEREO_DIASTEREOMER, STEREO_ENANTIOMER, STEREO_EXACT, STEREO_IGNORE, STEREO_MODEL_COMPREHENSIVE, STEREO_MODEL_DEFAULT, STEREO_MODEL_GLOBAL, STEREO_MODEL_LOCAL, STEREO_SPECIFIC, SUBSTRUCTURE, SUPERSTRUCTURE, TAUTOMER_SEARCH_DEFAULT, TAUTOMER_SEARCH_OFF, TAUTOMER_SEARCH_ON, TAUTOMER_SEARCH_ON_IGNORE_TAUTOMERSTEREO, UNDEF_R_MATCHING_ALL, UNDEF_R_MATCHING_GROUP, UNDEF_R_MATCHING_GROUP_H, UNDEF_R_MATCHING_GROUP_H_EMPTY, UNDEF_R_MATCHING_UNDEF_R, VAGUE_BOND_DEFAULT, VAGUE_BOND_LEVEL_HALF, VAGUE_BOND_LEVEL1, VAGUE_BOND_LEVEL2, VAGUE_BOND_LEVEL3, VAGUE_BOND_LEVEL4, VAGUE_BOND_OFF

Constructor Summary

Constructors
Constructor and Description
`MatchCountOptions(int hitLimitLow, boolean isLowerLimitIncluded, int hitLimitHigh, boolean isHigherLimitIncluded)` Public constructor for MatchCountOptions in between mode
`MatchCountOptions(java.lang.String relation, int hitLimit)` Public constructor for MatchCountOptions in relation mode

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getMatchCountHighLimit()`
`int`	`getMatchCounthitLimit()`
`int`	`getMatchCountLowLimit()`
`java.lang.String`	`getMatchCountRelation()`
`int`	`getMode()`
`boolean`	`isMatchCountHighLimitInclusive()`
`boolean`	`isMatchCountIncludesZero()`
`boolean`	`isMatchCountLowLimitInclusive()`
`void`	`setMatchCountHighLimit(int matchCountHighLimit)`
`void`	`setMatchCountHighLimitInclusive(boolean matchCountHighLimitInclusive)`
`void`	`setMatchCounthitLimit(int matchCounthitLimit)`
`void`	`setMatchCountIncludesZero(boolean matchCountIncludesZero)`
`void`	`setMatchCountLowLimit(int matchCountLowLimit)`
`void`	`setMatchCountLowLimitInclusive(boolean matchCountLowLimitInclusive)`
`void`	`setMatchCountRelation(java.lang.String matchCountRelation)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - 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(java.lang.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 Detail
  - 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 java.lang.String getMatchCountRelation()
```
    Returns:
    
    the matchCountRelation
    
    Since:
    
    JChem 5.0
  - setMatchCountRelation
```
public void setMatchCountRelation(java.lang.String matchCountRelation)
```
    Parameters:
    
    matchCountRelation - the matchCountRelation to set
    
    Since:
    
    JChem 5.0
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.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"

Class MatchCountOptions

Field Summary

Fields inherited from interface chemaxon.sss.SearchConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MatchCountOptions

MatchCountOptions

Method Detail

getMatchCountHighLimit

setMatchCountHighLimit

isMatchCountHighLimitInclusive

setMatchCountHighLimitInclusive

getMatchCounthitLimit

setMatchCounthitLimit

isMatchCountIncludesZero

setMatchCountIncludesZero

getMatchCountLowLimit

setMatchCountLowLimit

isMatchCountLowLimitInclusive

setMatchCountLowLimitInclusive

getMode

getMatchCountRelation

setMatchCountRelation

toString