chemaxon.checkers

Class AromaticityErrorChecker

java.lang.Object

chemaxon.checkers.AbstractStructureChecker

chemaxon.checkers.AromaticityErrorChecker

All Implemented Interfaces:

StructureChecker, chemaxon.license.Licensable, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

@PublicAPI
public class AromaticityErrorChecker
extends AbstractStructureChecker

A descendant of AbstractStructureChecker detecting aromatization problems.

Since:

Marvin 5.3

Version:

5.7

Author:

Attila Szabo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_KEY_AROM_TYPE This public constant String represents the name of the property which represents the arom type String property
static java.lang.String	PROPERTY_KEY_TYPE This public constant String 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 and Description
AromaticityErrorChecker() Default constructor.
AromaticityErrorChecker(java.util.Map<java.lang.String,java.lang.String> params) Parameterized constructor.

Method Summary

Modifier and Type	Method and Description
protected StructureCheckerResult	check1(Molecule molecule) This method contains the current checking mechanism.
boolean	equals(java.lang.Object obj)
java.lang.String	getAromType() Returns the aromType
int	getType() Returns the type of the aromatization
int	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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_KEY_TYPE

public static final java.lang.String PROPERTY_KEY_TYPE

This public constant String 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 java.lang.String PROPERTY_KEY_AROM_TYPE

This public constant String represents the name of the property which represents the arom type String property

Since:

5.7

See Also:

Constant Field Values

Constructor Detail

AromaticityErrorChecker

public AromaticityErrorChecker()

Default constructor. General aromatization will be used.

AromaticityErrorChecker

public AromaticityErrorChecker(java.util.Map<java.lang.String,java.lang.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 - a Map 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 class AbstractStructureChecker

Parameters:

molecule - the Molecule instance to be checked for problems

Returns:

a StructureCheckerResult which represents the problem or null if no problem found

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractStructureChecker

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStructureChecker

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 java.lang.String getAromType()

Returns the aromType

Returns:

the aromType