Package chemaxon.checkers.result

Class DefaultStructureCheckerResult

java.lang.Object

chemaxon.checkers.result.DefaultStructureCheckerResult

All Implemented Interfaces:

StructureCheckerResult

Direct Known Subclasses:

AromaticityCheckerResult, AtomQueryPropertyCheckerResult, BondAngleCheckerResult, BondLengthCheckerResult, DefaultExternalStructureCheckerResult, ExplicitHydrogenResult, MetalloceneCheckerResult, ReactionCheckerResult, RgroupCheckerResult, SgroupCheckerResult, SubstructureCheckerResult

@PublicAPI
public class DefaultStructureCheckerResult
extends Object
implements StructureCheckerResult

This class is the default implementation of StructureCheckerResult

Since:

Marvin 5.3

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	convert(Molecule molecule, Map<String,Map<? extends Object,? extends Object>> convertData)	This method converts the entities contained in this result according to the convertData.
boolean	equals(Object obj)
List<MolAtom>	getAtoms()
List<MolBond>	getBonds()
String	getDescription()
int	getErrorCount()	Return the error count.
protected static String	getErrorDescription(StructureCheckerDescriptor descriptor, int errorCount)
StructureCheckerErrorType	getErrorType()
String	getHelpText()
Icon	getIcon()
String	getLocalMenuName()
Molecule	getMolecule()
String	getName()
StructureChecker	getSource()
int	hashCode()
void	setAtoms(List<MolAtom> atoms)	This method sets the atoms property
void	setBonds(List<MolBond> bonds)	This method sets the bonds property
void	setMolecule(Molecule molecule)	This method sets the molecule
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultStructureCheckerResult

public DefaultStructureCheckerResult(StructureChecker source,
                                     List<MolAtom> atoms,
                                     List<MolBond> bonds,
                                     StructureCheckerErrorType errorType,
                                     Molecule molecule,
                                     String description,
                                     String name,
                                     String localMenuName,
                                     String helpText,
                                     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

errorType - is an instance of StructureCheckerErrorType which identifies 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

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

errorCount - count of identified errors

DefaultStructureCheckerResult

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

Deprecated.

use DefaultStructureCheckerResult(StructureChecker, List, List, StructureCheckerErrorType, Molecule, String, String, String, String, Icon, int) instead

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

errorType - is an instance of StructureCheckerErrorType which identifies 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

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

DefaultStructureCheckerResult

public DefaultStructureCheckerResult(StructureChecker source,
                                     List<MolAtom> atoms,
                                     List<MolBond> bonds,
                                     Molecule molecule)

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

Method Detail

getSource

public StructureChecker getSource()

Specified by:

getSource in interface StructureCheckerResult

Returns:

the StructureChecker instance which created this result

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface StructureCheckerResult

Returns:

the help text of the problem

getLocalMenuName

public String getLocalMenuName()

Specified by:

getLocalMenuName in interface StructureCheckerResult

Returns:

the name should show in the local menu of Marvin Sketch

getAtoms

public List<MolAtom> getAtoms()

Specified by:

getAtoms in interface StructureCheckerResult

Returns:

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

getBonds

public List<MolBond> getBonds()

Specified by:

getBonds in interface StructureCheckerResult

Returns:

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

getDescription

public String getDescription()

Specified by:

getDescription in interface StructureCheckerResult

Returns:

the description of the error

getMolecule

public Molecule getMolecule()

Specified by:

getMolecule in interface StructureCheckerResult

Returns:

the molecule which has the current error

getErrorType

public StructureCheckerErrorType getErrorType()

Specified by:

getErrorType in interface StructureCheckerResult

Returns:

an instance of StructureCheckerErrorType which is the errorCode of the problem

getName

public String getName()

Specified by:

getName in interface StructureCheckerResult

Returns:

the name of the StructureChecker found the problem

getIcon

public Icon getIcon()

Specified by:

getIcon in interface StructureCheckerResult

Returns:

the icon of the problem

getErrorCount

public int getErrorCount()

Return the error count.

Returns:

the error count

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

setAtoms

public void setAtoms(List<MolAtom> atoms)

Description copied from interface: StructureCheckerResult

This method sets the atoms property

Specified by:

setAtoms in interface StructureCheckerResult

Parameters:

atoms - is a List of MolAtom

setBonds

public void setBonds(List<MolBond> bonds)

Description copied from interface: StructureCheckerResult

This method sets the bonds property

Specified by:

setBonds in interface StructureCheckerResult

Parameters:

bonds - is a List of MolBond

setMolecule

public void setMolecule(Molecule molecule)

Description copied from interface: StructureCheckerResult

This method sets the molecule

Specified by:

setMolecule in interface StructureCheckerResult

Parameters:

molecule - is a Molecule instance

convert

public void convert(Molecule molecule,
                    Map<String,Map<? extends Object,? extends Object>> convertData)

Description copied from interface: StructureCheckerResult

This method converts the entities contained in this result according to the convertData. By default this method isn't needed to call from any place.

Specified by:

convert in interface StructureCheckerResult

Parameters:

molecule - the original molecule object

convertData - is a map with String keys and Map values which contains the convert related information

getErrorDescription

protected static String getErrorDescription(StructureCheckerDescriptor descriptor,
                                            int errorCount)