Package chemaxon.checkers.result

Class AromaticityCheckerResult

java.lang.Object

chemaxon.checkers.result.DefaultStructureCheckerResult

chemaxon.checkers.result.AromaticityCheckerResult

All Implemented Interfaces:

StructureCheckerResult

@PublicAPI
public class AromaticityCheckerResult
extends DefaultStructureCheckerResult

A descendant of DefaultStructureCheckerResult for identifying aromaticity problems, thus errorType property is StructureCheckerErrorType.AROMATICITY

Since:

Marvin 5.3

Constructor Summary

Constructors

Constructor	Description
AromaticityCheckerResult(StructureChecker source, List<MolAtom> atoms, List<MolBond> bonds, Molecule molecule, String description, int aromataType, String name, String localMenuName, String helpText, Icon icon)	Constructor which initialize all the properties.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getAromataType()	Returns the type of the aromatization
int	hashCode()

Methods inherited from class chemaxon.checkers.result.DefaultStructureCheckerResult

convert, getAtoms, getBonds, getDescription, getErrorCount, getErrorDescription, getErrorType, getHelpText, getIcon, getLocalMenuName, getMolecule, getName, getSource, setAtoms, setBonds, setMolecule, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AromaticityCheckerResult

public AromaticityCheckerResult(StructureChecker source,
                                List<MolAtom> atoms,
                                List<MolBond> bonds,
                                Molecule molecule,
                                String description,
                                int aromataType,
                                String name,
                                String localMenuName,
                                String helpText,
                                Icon icon)

Constructor which initialize all the properties. errorType property is StructureCheckerErrorType.AROMATICITY by default.

Parameters:

source - is the StructureChecker instance which identified the problem

atoms - a List of MolAtom which contains the affected atoms of the problem

bonds - a List of MolBond which contains the affected bonds of the problem

molecule - is a Molecule instance which contains the described problem

description - is short information about the problem

aromataType - is the type of the aromatization method what the checker instance used to identify the problem

name - is the name of the checker which found the described problem

localMenuName - is a String which should be shown in the local menu of Marvin Sketch

helpText - is help message for the problem

icon - is an instance of Icon which will be shown in Marvin Sketch checker dialogs

Method Detail

getAromataType

public int getAromataType()

Returns the type of the aromatization

Returns:

the type of the aromatization

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultStructureCheckerResult

equals

public boolean equals(Object obj)

Overrides:

equals in class DefaultStructureCheckerResult