Package com.chemaxon.search
Class MatchingOptions
java.lang.Object
com.chemaxon.search.MatchingOptions
- Direct Known Subclasses:
McsSearchOptions
Abstract class containing search options used by multiple algorithms.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Abstract builder class for creating the base part of immutable instances of any class inheriting the enclosingMatchingOptions
class. -
Constructor Summary
ModifierConstructorDescriptionprotected
MatchingOptions
(MatchingOptions.Builder builder) Creates aMatchingOptions
instance with the settings of the given builder object. -
Method Summary
Modifier and TypeMethodDescriptionGets the factory that is used to create the custom matcher.boolean
Gets whether atom map numbers are considered in search.boolean
Gets whether atom types are considered in search.boolean
Gets whether bond types are considered in search.boolean
Gets whether formal charges are considered in search.boolean
Gets whether query atoms are matched only to query atoms of exactly the same type.boolean
Gets whether query bonds are matched only to query bonds of exactly the same type.boolean
Gets whether isotopes are considered in search.boolean
Gets whether search is sensitive to the order of the matched atoms and bonds when searching for multiple hits.boolean
Gets whether radicals are considered in search.
-
Constructor Details
-
MatchingOptions
Creates aMatchingOptions
instance with the settings of the given builder object.- Parameters:
builder
- theMatchingOptions.Builder
object
-
-
Method Details
-
isAtomTypeMatching
public boolean isAtomTypeMatching()Gets whether atom types are considered in search. SeeMatchingOptions.Builder.atomTypeMatching(boolean)
.- Returns:
- true if atoms with different atom types are considered different
-
isBondTypeMatching
public boolean isBondTypeMatching()Gets whether bond types are considered in search. SeeMatchingOptions.Builder.bondTypeMatching(boolean)
.- Returns:
- true if bonds with different bond types are considered different
-
isChargeMatching
public boolean isChargeMatching()Gets whether formal charges are considered in search. SeeMatchingOptions.Builder.chargeMatching(boolean)
.- Returns:
- true if atoms with different charges are considered different
-
isIsotopeMatching
public boolean isIsotopeMatching()Gets whether isotopes are considered in search. SeeMatchingOptions.Builder.isotopeMatching(boolean)
.- Returns:
- true if atoms with different mass numbers are considered different
-
isRadicalMatching
public boolean isRadicalMatching()Gets whether radicals are considered in search. SeeMatchingOptions.Builder.radicalMatching(boolean)
.- Returns:
- true if atoms with different radicals are considered different
-
isAtomMapMatching
public boolean isAtomMapMatching()Gets whether atom map numbers are considered in search. SeeMatchingOptions.Builder.atomMapMatching(boolean)
.- Returns:
- true if atoms with different atom map numbers are considered different
-
isExactQueryAtomMatching
public boolean isExactQueryAtomMatching()Gets whether query atoms are matched only to query atoms of exactly the same type. SeeMatchingOptions.Builder.exactQueryAtomMatching(boolean)
.- Returns:
- true if query atoms match only the same query atoms
-
isExactQueryBondMatching
public boolean isExactQueryBondMatching()Gets whether query bonds are matched only to query bonds of exactly the same type. SeeMatchingOptions.Builder.exactQueryBondMatching(boolean)
.- Returns:
- true if query bonds match only the same query bonds
-
getCustomMatching
Gets the factory that is used to create the custom matcher. If no custom matcher is used, this method returnsnull
. SeeMatchingOptions.Builder.customMatching(CustomMatcherFactory)
.- Returns:
- the custom matcher factory, or null if it is not defined
-
isOrderSensitiveSearch
public boolean isOrderSensitiveSearch()Gets whether search is sensitive to the order of the matched atoms and bonds when searching for multiple hits. SeeMatchingOptions.Builder.orderSensitive(boolean)
.- Returns:
- true if the search is order sensitive
-