Package chemaxon.checkers.result

Class DefaultExternalStructureCheckerResult

java.lang.Object

chemaxon.checkers.result.DefaultStructureCheckerResult

chemaxon.checkers.result.DefaultExternalStructureCheckerResult

All Implemented Interfaces:

ExternalStructureCheckerResult, StructureCheckerResult

@PublicAPI
public class DefaultExternalStructureCheckerResult
extends DefaultStructureCheckerResult
implements ExternalStructureCheckerResult

This descendant of DefaultStructureCheckerResult also implements the ExternalStructureCheckerResult interface thus providing a default implementation base class for external structure checkers' results.

Since:

Marvin 5.3

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getErrorCode()	This function returns a String which identifies the problems thus this must be unique for each class that implements this interface
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

Methods inherited from interface chemaxon.checkers.result.StructureCheckerResult

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

Constructor Detail

DefaultExternalStructureCheckerResult

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

Constructor which initialize all the properties.

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

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

errorCode - is a String which represents a unique identifier of the result

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

errorCount - count of identified errors

DefaultExternalStructureCheckerResult

@Deprecated
public DefaultExternalStructureCheckerResult(StructureChecker source,
                                             List<MolAtom> atoms,
                                             List<MolBond> bonds,
                                             Molecule molecule,
                                             String description,
                                             String name,
                                             String localMenuName,
                                             String helpText,
                                             String errorCode,
                                             Icon icon)

Deprecated.

use DefaultExternalStructureCheckerResult(StructureChecker, List, List, Molecule, String, String, String, String, String, Icon, int)

Constructor which initialize all the properties.

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

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

errorCode - is a String which represents a unique identifier of the result

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

DefaultExternalStructureCheckerResult

public DefaultExternalStructureCheckerResult(StructureChecker source,
                                             List<MolAtom> atoms,
                                             List<MolBond> bonds,
                                             Molecule molecule,
                                             String errorCode)

Constructor which initialize all the properties.

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

errorCode - is a String which represents a unique identifier of the result

Method Detail

getErrorCode

public String getErrorCode()

Description copied from interface: ExternalStructureCheckerResult

This function returns a String which identifies the problems thus this must be unique for each class that implements this interface

Specified by:

getErrorCode in interface ExternalStructureCheckerResult

Returns:

a String object which is the error code of the problem

equals

public boolean equals(Object obj)

Overrides:

equals in class DefaultStructureCheckerResult

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultStructureCheckerResult