Package chemaxon.checkers
Class ExplicitHydrogenChecker
- java.lang.Object
-
- chemaxon.checkers.AbstractStructureChecker
-
- chemaxon.checkers.ExplicitHydrogenChecker
-
- All Implemented Interfaces:
StructureChecker
,chemaxon.license.Licensable
,PropertyChangeListener
,Cloneable
,EventListener
@PublicAPI public class ExplicitHydrogenChecker extends AbstractStructureChecker
A descendant ofAtomChecker
detecting explicit hydrogens.- Since:
- Marvin 5.3
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROPERTY_KEY_BRIDGEHEAD
This public constantString
represents the name of the configuration file property which is responsible for searching Bridgehead propertystatic String
PROPERTY_KEY_CHARGED
This public constantString
represents the name of the configuration file property which is responsible for searching charged explicit hydrogens in the moleculestatic String
PROPERTY_KEY_H_CONNECTED
This public constantString
represents the name of the configuration file property which is responsible for searching H connected propertystatic String
PROPERTY_KEY_ISOTOPIC
This public constantString
represents the name of the configuration file property which is responsible for searching isotopic explicit hydrogens in the moleculestatic String
PROPERTY_KEY_LONELY
This public constantString
represents the name of the configuration file property which is responsible for searching lonely explicit hydrogens in the moleculestatic String
PROPERTY_KEY_MAPPED
This public constantString
represents the name of the configuration file property which is responsible for searching mapped explicit hydrogens in the moleculestatic String
PROPERTY_KEY_POLYMER_END_GROUP
This public constantString
represents the name of the configuration file property which is responsible for searching Polymer end group propertystatic String
PROPERTY_KEY_RADICAL
This public constantString
represents the name of the configuration file property which is responsible for searching radical explicit hydrogens in the moleculestatic String
PROPERTY_KEY_SEARCH_BRIDGEHEAD
This public constantString
represents the name of the property which is responsible for searchingBridgehead propertystatic String
PROPERTY_KEY_SEARCH_CHARGED
This public constantString
represents the name of the property which is responsible for searching charged explicit hydrogens in the moleculestatic String
PROPERTY_KEY_SEARCH_H_CONNECTED
This public constantString
represents the name of the property which is responsible for searching H connected propertystatic String
PROPERTY_KEY_SEARCH_ISOTOPIC
This public constantString
represents the name of the property which is responsible for searching isotopic explicit hydrogens in the moleculestatic String
PROPERTY_KEY_SEARCH_LONELY
This public constantString
represents the name of the property which is responsible for searching lonely explicit hydrogens in the moleculestatic String
PROPERTY_KEY_SEARCH_MAPPED
This public constantString
represents the name of the property which is responsible for searching mapped explicit hydrogens in the moleculestatic String
PROPERTY_KEY_SEARCH_POLYMER_END_GROUP
This public constantString
represents the name of the property which is responsible for searchingPolymer end group propertystatic String
PROPERTY_KEY_SEARCH_RADICAL
This public constantString
represents the name of the property which is responsible for searching radical explicit hydrogens in the moleculestatic String
PROPERTY_KEY_SEARCH_SGROUP
This public constantString
represents the name of the property which is responsible for searchingS-group propertystatic String
PROPERTY_KEY_SEARCH_SGROUP_END
This public constantString
represents the name of the property which is responsible for searchingS-group end propertystatic String
PROPERTY_KEY_SEARCH_VALENCE_ERROR
This public constantString
represents the name of the property which is responsible for searchingValence error propertystatic String
PROPERTY_KEY_SEARCH_WEDGED
This public constantString
represents the name of the property which is responsible for searching wedged explicit hydrogens in the moleculestatic String
PROPERTY_KEY_SGROUP
This public constantString
represents the name of the configuration file property which is responsible for searching S-group propertystatic String
PROPERTY_KEY_SGROUP_END
This public constantString
represents the name of the configuration file property which is responsible for searching S-group end propertystatic String
PROPERTY_KEY_VALENCE_ERROR
This public constantString
represents the name of the configuration file property which is responsible for searching Valence error propertystatic String
PROPERTY_KEY_WEDGED
This public constantString
represents the name of the configuration file property which is responsible for searching wedged explicit hydrogens in the molecule-
Fields inherited from class chemaxon.checkers.AbstractStructureChecker
errorType, propertyChangeSupport
-
Fields inherited from interface chemaxon.checkers.StructureChecker
PROPERTY_KEY_VALID
-
-
Constructor Summary
Constructors Constructor Description ExplicitHydrogenChecker()
Default constructor All types of explicit hydrogens will be searched.ExplicitHydrogenChecker(Map<String,String> params)
Parameterized constructor If map contains lonely/charged/mapped/isotopic/radical/wedged keys with value false then hydrogens with these types won't be detected.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StructureCheckerResult
check1(Molecule molecule)
Detects implicitizable hydrogen atoms.boolean
equals(Object obj)
int
hashCode()
boolean
isSearchBridgehead()
Returns if the checker search for bridgehead explicit hydrogensboolean
isSearchCharged()
Returns if the checker search for charged explicit hydrogensboolean
isSearchHConnected()
Returns if the checker search for H connected explicit hydrogensboolean
isSearchIsotopic()
Returns if the checker search for isotopic explicit hydrogensboolean
isSearchLonely()
Returns if the checker search for lonely explicit hydrogensboolean
isSearchMapped()
Returns if the checker search for mapped explicit hydrogensboolean
isSearchPolymerEndGroup()
Returns if the checker search for polymer end group explicit hydrogensboolean
isSearchRadical()
Returns if the checker search for radical explicit hydrogensboolean
isSearchSgroup()
Returns if the checker search for S-group explicit hydrogensboolean
isSearchSgroupEnd()
Returns if the checker search for S-group end explicit hydrogensboolean
isSearchValenceError()
Returns if the checker search for valence errored explicit hydrogensboolean
isSearchWedged()
Returns if the checker search for wedged explicit hydrogensvoid
setSearchBridgehead(boolean searchBridgehead)
Sets whether the checker search for bridgehead explicit hydrogensvoid
setSearchCharged(boolean searchCharged)
Sets whether the checker search for charged explicit hydrogensvoid
setSearchHConnected(boolean searchHConnected)
Sets whether the checker search for H connected explicit hydrogensvoid
setSearchIsotopic(boolean searchIsotopic)
Sets whether the checker search for isotopic explicit hydrogensvoid
setSearchLonely(boolean searchLonely)
Sets whether the checker search for lonely explicit hydrogensvoid
setSearchMapped(boolean searchMapped)
Sets whether the checker search for mapped explicit hydrogensvoid
setSearchPolymerEndGroup(boolean searchPolymerEndGroup)
Sets whether the checker search for polymer end group explicit hydrogensvoid
setSearchRadical(boolean searchRadical)
Sets whether the checker search for radical explicit hydrogensvoid
setSearchSgroup(boolean searchSgroup)
Sets whether the checker search for S-group explicit hydrogensvoid
setSearchSgroupEnd(boolean searchSgroupEnd)
Sets whether the checker search for S-group end explicit hydrogensvoid
setSearchValenceError(boolean searchValenceError)
Sets whether the checker search for valence errored explicit hydrogensvoid
setSearchWedged(boolean searchWedged)
Sets whether the checker search for wedged explicit hydrogens-
Methods inherited from class chemaxon.checkers.AbstractStructureChecker
addPropertyChangeListener, addPropertyChangeListener, check, clone, cloneItem, convertResult, expandMolecule, getDescription, getDescriptor, getEditorClassName, getErrorCode, getErrorDescription, getErrorType, getHelpText, getIcon, getLocalMenuName, getName, isAvailable, isLicensed, isValid, propertyChange, removePropertyChangeListener, removePropertyChangeListener, setDescription, setHelpText, setIcon, setLicenseEnvironment, setLocalMenuName, setMoreErrorMessage, setName, setNoErrorMessage, setOneErrorMessage, toString
-
-
-
-
Field Detail
-
PROPERTY_KEY_LONELY
public static final String PROPERTY_KEY_LONELY
This public constantString
represents the name of the configuration file property which is responsible for searching lonely explicit hydrogens in the molecule- Since:
- 5.4
- See Also:
- Constant Field Values
-
PROPERTY_KEY_CHARGED
public static final String PROPERTY_KEY_CHARGED
This public constantString
represents the name of the configuration file property which is responsible for searching charged explicit hydrogens in the molecule- Since:
- 5.4
- See Also:
- Constant Field Values
-
PROPERTY_KEY_MAPPED
public static final String PROPERTY_KEY_MAPPED
This public constantString
represents the name of the configuration file property which is responsible for searching mapped explicit hydrogens in the molecule- Since:
- 5.4
- See Also:
- Constant Field Values
-
PROPERTY_KEY_ISOTOPIC
public static final String PROPERTY_KEY_ISOTOPIC
This public constantString
represents the name of the configuration file property which is responsible for searching isotopic explicit hydrogens in the molecule- Since:
- 5.4
- See Also:
- Constant Field Values
-
PROPERTY_KEY_RADICAL
public static final String PROPERTY_KEY_RADICAL
This public constantString
represents the name of the configuration file property which is responsible for searching radical explicit hydrogens in the molecule- Since:
- 5.4
- See Also:
- Constant Field Values
-
PROPERTY_KEY_WEDGED
public static final String PROPERTY_KEY_WEDGED
This public constantString
represents the name of the configuration file property which is responsible for searching wedged explicit hydrogens in the molecule- Since:
- 5.4
- See Also:
- Constant Field Values
-
PROPERTY_KEY_H_CONNECTED
public static final String PROPERTY_KEY_H_CONNECTED
This public constantString
represents the name of the configuration file property which is responsible for searching H connected property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_POLYMER_END_GROUP
public static final String PROPERTY_KEY_POLYMER_END_GROUP
This public constantString
represents the name of the configuration file property which is responsible for searching Polymer end group property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SGROUP_END
public static final String PROPERTY_KEY_SGROUP_END
This public constantString
represents the name of the configuration file property which is responsible for searching S-group end property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SGROUP
public static final String PROPERTY_KEY_SGROUP
This public constantString
represents the name of the configuration file property which is responsible for searching S-group property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_VALENCE_ERROR
public static final String PROPERTY_KEY_VALENCE_ERROR
This public constantString
represents the name of the configuration file property which is responsible for searching Valence error property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_BRIDGEHEAD
public static final String PROPERTY_KEY_BRIDGEHEAD
This public constantString
represents the name of the configuration file property which is responsible for searching Bridgehead property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_CHARGED
public static final String PROPERTY_KEY_SEARCH_CHARGED
This public constantString
represents the name of the property which is responsible for searching charged explicit hydrogens in the molecule- Since:
- 5.7
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_ISOTOPIC
public static final String PROPERTY_KEY_SEARCH_ISOTOPIC
This public constantString
represents the name of the property which is responsible for searching isotopic explicit hydrogens in the molecule- Since:
- 5.7
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_LONELY
public static final String PROPERTY_KEY_SEARCH_LONELY
This public constantString
represents the name of the property which is responsible for searching lonely explicit hydrogens in the molecule- Since:
- 5.7
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_MAPPED
public static final String PROPERTY_KEY_SEARCH_MAPPED
This public constantString
represents the name of the property which is responsible for searching mapped explicit hydrogens in the molecule- Since:
- 5.7
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_RADICAL
public static final String PROPERTY_KEY_SEARCH_RADICAL
This public constantString
represents the name of the property which is responsible for searching radical explicit hydrogens in the molecule- Since:
- 5.7
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_WEDGED
public static final String PROPERTY_KEY_SEARCH_WEDGED
This public constantString
represents the name of the property which is responsible for searching wedged explicit hydrogens in the molecule- Since:
- 5.7
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_H_CONNECTED
public static final String PROPERTY_KEY_SEARCH_H_CONNECTED
This public constantString
represents the name of the property which is responsible for searching H connected property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_POLYMER_END_GROUP
public static final String PROPERTY_KEY_SEARCH_POLYMER_END_GROUP
This public constantString
represents the name of the property which is responsible for searchingPolymer end group property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_SGROUP_END
public static final String PROPERTY_KEY_SEARCH_SGROUP_END
This public constantString
represents the name of the property which is responsible for searchingS-group end property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_SGROUP
public static final String PROPERTY_KEY_SEARCH_SGROUP
This public constantString
represents the name of the property which is responsible for searchingS-group property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_VALENCE_ERROR
public static final String PROPERTY_KEY_SEARCH_VALENCE_ERROR
This public constantString
represents the name of the property which is responsible for searchingValence error property- Since:
- 5.11
- See Also:
- Constant Field Values
-
PROPERTY_KEY_SEARCH_BRIDGEHEAD
public static final String PROPERTY_KEY_SEARCH_BRIDGEHEAD
This public constantString
represents the name of the property which is responsible for searchingBridgehead property- Since:
- 5.11
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ExplicitHydrogenChecker
public ExplicitHydrogenChecker()
Default constructor All types of explicit hydrogens will be searched.
-
ExplicitHydrogenChecker
public ExplicitHydrogenChecker(Map<String,String> params)
Parameterized constructor If map contains lonely/charged/mapped/isotopic/radical/wedged keys with value false then hydrogens with these types won't be detected.- Parameters:
params
- aMap
instance which contains String pairs. Key is the name of the parameter.
-
-
Method Detail
-
isSearchLonely
public boolean isSearchLonely()
Returns if the checker search for lonely explicit hydrogens- Returns:
- if the checker search for lonely explicit hydrogens
-
isSearchCharged
public boolean isSearchCharged()
Returns if the checker search for charged explicit hydrogens- Returns:
- if the checker search for charged explicit hydrogens
-
isSearchMapped
public boolean isSearchMapped()
Returns if the checker search for mapped explicit hydrogens- Returns:
- if the checker search for mapped explicit hydrogens
-
isSearchIsotopic
public boolean isSearchIsotopic()
Returns if the checker search for isotopic explicit hydrogens- Returns:
- if the checker search for isotopic explicit hydrogens
-
isSearchRadical
public boolean isSearchRadical()
Returns if the checker search for radical explicit hydrogens- Returns:
- if the checker search for radical explicit hydrogens
-
isSearchWedged
public boolean isSearchWedged()
Returns if the checker search for wedged explicit hydrogens- Returns:
- if the checker search for wedged explicit hydrogens
-
isSearchHConnected
public boolean isSearchHConnected()
Returns if the checker search for H connected explicit hydrogens- Returns:
- if the checker search for H connected explicit hydrogens
-
isSearchPolymerEndGroup
public boolean isSearchPolymerEndGroup()
Returns if the checker search for polymer end group explicit hydrogens- Returns:
- if the checker search for polymer end group explicit hydrogens
-
isSearchSgroupEnd
public boolean isSearchSgroupEnd()
Returns if the checker search for S-group end explicit hydrogens- Returns:
- if the checker search for S-group end explicit hydrogens
-
isSearchSgroup
public boolean isSearchSgroup()
Returns if the checker search for S-group explicit hydrogens- Returns:
- if the checker search for S-group explicit hydrogens
-
isSearchValenceError
public boolean isSearchValenceError()
Returns if the checker search for valence errored explicit hydrogens- Returns:
- if the checker search for valence errored explicit hydrogens
-
isSearchBridgehead
public boolean isSearchBridgehead()
Returns if the checker search for bridgehead explicit hydrogens- Returns:
- if the checker search for bridgehead explicit hydrogens
-
setSearchLonely
public void setSearchLonely(boolean searchLonely)
Sets whether the checker search for lonely explicit hydrogens- Parameters:
searchLonely
- whether the checker search for lonely explicit hydrogens
-
setSearchCharged
public void setSearchCharged(boolean searchCharged)
Sets whether the checker search for charged explicit hydrogens- Parameters:
searchCharged
- whether the checker search for charged explicit hydrogens
-
setSearchMapped
public void setSearchMapped(boolean searchMapped)
Sets whether the checker search for mapped explicit hydrogens- Parameters:
searchMapped
- whether the checker search for mapped explicit hydrogens
-
setSearchIsotopic
public void setSearchIsotopic(boolean searchIsotopic)
Sets whether the checker search for isotopic explicit hydrogens- Parameters:
searchIsotopic
- whether the checker search for isotopic explicit hydrogens
-
setSearchRadical
public void setSearchRadical(boolean searchRadical)
Sets whether the checker search for radical explicit hydrogens- Parameters:
searchRadical
- whether the checker search for radical explicit hydrogens
-
setSearchWedged
public void setSearchWedged(boolean searchWedged)
Sets whether the checker search for wedged explicit hydrogens- Parameters:
searchWedged
- whether the checker search for wedged explicit hydrogens
-
setSearchHConnected
public void setSearchHConnected(boolean searchHConnected)
Sets whether the checker search for H connected explicit hydrogens- Parameters:
searchHConnected
- whether the checker search for H connected explicit hydrogens
-
setSearchPolymerEndGroup
public void setSearchPolymerEndGroup(boolean searchPolymerEndGroup)
Sets whether the checker search for polymer end group explicit hydrogens- Parameters:
searchPolymerEndGroup
- whether the checker search for polymer end group explicit hydrogens
-
setSearchSgroupEnd
public void setSearchSgroupEnd(boolean searchSgroupEnd)
Sets whether the checker search for S-group end explicit hydrogens- Parameters:
searchSgroupEnd
- whether the checker search for S-group end explicit hydrogens
-
setSearchSgroup
public void setSearchSgroup(boolean searchSgroup)
Sets whether the checker search for S-group explicit hydrogens- Parameters:
searchSgroup
- whether the checker search for S-group explicit hydrogens
-
setSearchValenceError
public void setSearchValenceError(boolean searchValenceError)
Sets whether the checker search for valence errored explicit hydrogens- Parameters:
searchValenceError
- whether the checker search for valence errored explicit hydrogens
-
setSearchBridgehead
public void setSearchBridgehead(boolean searchBridgehead)
Sets whether the checker search for bridgehead explicit hydrogens- Parameters:
searchBridgehead
- whether the checker search for bridgehead explicit hydrogens
-
check1
protected StructureCheckerResult check1(Molecule molecule)
Detects implicitizable hydrogen atoms.- Specified by:
check1
in classAbstractStructureChecker
- Parameters:
molecule
- theMolecule
instance to be checked for problems- Returns:
- checker result containing implicitizable hydrogen atoms.
-
equals
public boolean equals(Object obj)
- Overrides:
equals
in classAbstractStructureChecker
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractStructureChecker
-
-