Package chemaxon.checkers.result

Class MetalloceneCheckerResult

java.lang.Object

chemaxon.checkers.result.DefaultStructureCheckerResult

chemaxon.checkers.result.MetalloceneCheckerResult

All Implemented Interfaces:

StructureCheckerResult

@PublicApi
public class MetalloceneCheckerResult
extends DefaultStructureCheckerResult

Since:

Marvin 5.4

Constructor Summary

Constructors

Constructor	Description
MetalloceneCheckerResult(StructureChecker source, List<MolAtom> atoms, List<MolBond> bonds, StructureCheckerErrorType errorType, Molecule molecule, String description, String name, String localMenuName, String helpText, Icon icon, List<List<MolAtom>> fiveLongRings, List<MolAtom> metalAtoms)	Deprecated. use MetalloceneCheckerResult(StructureChecker, List, List, StructureCheckerErrorType, Molecule, String, String, String, String, Icon, List, List, int) instead
MetalloceneCheckerResult(StructureChecker source, List<MolAtom> atoms, List<MolBond> bonds, StructureCheckerErrorType errorType, Molecule molecule, String description, String name, String localMenuName, String helpText, Icon icon, List<List<MolAtom>> fiveLongRings, List<MolAtom> metalAtoms, int errorCount)	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<List<MolAtom>>	getFiveLongRings()	This method returns the five long rings in the molecule represented by a List of List of MolAtom
List<MolAtom>	getMetalAtoms()	This method returns the metallocene relevant metal atoms represented by a List of MolAtom.
int	hashCode()
void	setFiveLongRings(List<List<MolAtom>> fiveLongRings)	This method sets the fiveLongRings property.
void	setMetalAtoms(List<MolAtom> metalAtoms)	This method sets the metalAtoms 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

MetalloceneCheckerResult

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

Deprecated.

use MetalloceneCheckerResult(StructureChecker, List, List, StructureCheckerErrorType, Molecule, String, String, String, String, Icon, List, List, 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 - a StructureCheckerErrorType instance represents the type of the error

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

fiveLongRings - a List of List of MolAtom represents all the five long rings in the molecule

metalAtoms - a List of MolAtom represents all the metallocene relevant metal atoms in the molecule

MetalloceneCheckerResult

public MetalloceneCheckerResult(StructureChecker source,
 List<MolAtom> atoms,
 List<MolBond> bonds,
 StructureCheckerErrorType errorType,
 Molecule molecule,
 String description,
 String name,
 String localMenuName,
 String helpText,
 Icon icon,
 List<List<MolAtom>> fiveLongRings,
 List<MolAtom> metalAtoms,
 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 - a StructureCheckerErrorType instance represents the type of the error

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

fiveLongRings - a List of List of MolAtom represents all the five long rings in the molecule

metalAtoms - a List of MolAtom represents all the metallocene relevant metal atoms in the molecule

errorCount - count of identified errors

Method Details

getFiveLongRings

public List<List<MolAtom>> getFiveLongRings()

This method returns the five long rings in the molecule represented by a List of List of MolAtom

Returns:

the five long rings in the molecule represented by a List of List of MolAtom

setFiveLongRings

public void setFiveLongRings(List<List<MolAtom>> fiveLongRings)

This method sets the fiveLongRings property.

Parameters:

fiveLongRings - is a List of List of MolAtom represents the five long rings in the Molecule

getMetalAtoms

public List<MolAtom> getMetalAtoms()

This method returns the metallocene relevant metal atoms represented by a List of MolAtom.

Returns:

the metallocene relevant metal atoms represented by a List of MolAtom.

setMetalAtoms

public void setMetalAtoms(List<MolAtom> metalAtoms)

This method sets the metalAtoms property

Parameters:

metalAtoms - is a List of MolAtom represents the metallocene relevant metal atoms in the molecule

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

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultStructureCheckerResult

equals

public boolean equals(Object obj)

Overrides:

equals in class DefaultStructureCheckerResult