Package chemaxon.checkers
Class AromaticityErrorChecker
- java.lang.Object
-
- chemaxon.checkers.AbstractStructureChecker
-
- chemaxon.checkers.AromaticityErrorChecker
-
- All Implemented Interfaces:
StructureChecker
,chemaxon.license.Licensable
,PropertyChangeListener
,Cloneable
,EventListener
@PublicAPI public class AromaticityErrorChecker extends AbstractStructureChecker
A descendant ofAbstractStructureChecker
detecting aromatization problems.- Since:
- Marvin 5.3
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROPERTY_KEY_AROM_TYPE
static String
PROPERTY_KEY_TYPE
This public constantString
represents the name of the property which is responsible for using the given aromatization type during the check mechanism.-
Fields inherited from class chemaxon.checkers.AbstractStructureChecker
errorType, propertyChangeSupport
-
Fields inherited from interface chemaxon.checkers.StructureChecker
PROPERTY_KEY_VALID
-
-
Constructor Summary
Constructors Constructor Description AromaticityErrorChecker()
Default constructor.AromaticityErrorChecker(Map<String,String> params)
Parameterized constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StructureCheckerResult
check1(Molecule molecule)
This method contains the current checking mechanism.boolean
equals(Object obj)
String
getAromType()
Returns the aromTypeint
getType()
Returns the type of the aromatizationint
hashCode()
void
setType(int type)
-
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_TYPE
public static final String PROPERTY_KEY_TYPE
This public constantString
represents the name of the property which is responsible for using the given aromatization type during the check mechanism.- Since:
- 5.4
- See Also:
- Constant Field Values
-
PROPERTY_KEY_AROM_TYPE
public static final String PROPERTY_KEY_AROM_TYPE
This public constantString
represents the name of the property which represents the arom typeString
property- Since:
- 5.7
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AromaticityErrorChecker
public AromaticityErrorChecker()
Default constructor. General aromatization will be used.
-
AromaticityErrorChecker
public AromaticityErrorChecker(Map<String,String> params)
Parameterized constructor. If type parameter is given and its value is basic or loose then basic/loose aromatization will be used during checking mechanism otherwise general.- Parameters:
params
- aMap
instance which contains String pairs. Key is the name of the parameter.
-
-
Method Detail
-
check1
protected StructureCheckerResult check1(Molecule molecule)
Description copied from class:AbstractStructureChecker
This method contains the current checking mechanism.- Specified by:
check1
in classAbstractStructureChecker
- Parameters:
molecule
- theMolecule
instance to be checked for problems- Returns:
- a
StructureCheckerResult
which represents the problem or null if no problem found
-
equals
public boolean equals(Object obj)
- Overrides:
equals
in classAbstractStructureChecker
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractStructureChecker
-
getType
public int getType()
Returns the type of the aromatization- Returns:
- the type of the aromatization
-
setType
public void setType(int type)
- Parameters:
type
- is the type of the aromatization
-
getAromType
public String getAromType()
Returns the aromType- Returns:
- the aromType
-
-