Package chemaxon.checkers.result

Class SgroupCheckerResult

java.lang.Object

chemaxon.checkers.result.DefaultStructureCheckerResult

chemaxon.checkers.result.SgroupCheckerResult

All Implemented Interfaces:

StructureCheckerResult

Direct Known Subclasses:

DataSgroupCheckerResult

@PublicApi
public class SgroupCheckerResult
extends DefaultStructureCheckerResult

A descendant of DefaultStructureCheckerResult for identifying Sgroup problems.

Since:

Marvin 5.3

Constructor Summary

Constructors

Constructor	Description
SgroupCheckerResult(StructureChecker source, List<MolAtom> atoms, List<MolBond> bonds, StructureCheckerErrorType errorType, Molecule molecule, String description, List<Sgroup> groups, String name, String localMenuName, String helpText, Icon icon)	Constructor which initialize all the properties.

Method Summary

Modifier and Type	Method	Description
void	convert(Molecule molecule, Map<String,Map<?,?>> convertData)	This method converts the entities contained in this result according to the convertData.
boolean	equals(Object obj)
List<Sgroup>	getSgroups()	Returns a List which contains the affected groups of the problem
int	hashCode()
void	setSrgoups(List<Sgroup> groups)	This method sets the groups property

Methods inherited from class chemaxon.checkers.result.DefaultStructureCheckerResult

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 Details

SgroupCheckerResult

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

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

groups - is a List of Sgroup which contains the affected groups of 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 Details

getSgroups

public List<Sgroup> getSgroups()

Returns a List which contains the affected groups of the problem

Returns:

a List of Sgroup

setSrgoups

public void setSrgoups(List<Sgroup> groups)

This method sets the groups property

Parameters:

groups - is a List of Sgroup

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultStructureCheckerResult

equals

public boolean equals(Object obj)

Overrides:

equals in class DefaultStructureCheckerResult

convert

public void convert(Molecule molecule,
 Map<String,Map<?,?>> 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

Overrides:

convert in class DefaultStructureCheckerResult

Parameters:

molecule - the original molecule object

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