Package chemaxon.checkers

Class ValenceErrorChecker

java.lang.Object

chemaxon.checkers.AbstractStructureChecker

chemaxon.checkers.ValenceErrorChecker

All Implemented Interfaces:

StructureChecker, chemaxon.license.Licensable, PropertyChangeListener, Cloneable, EventListener

@PublicAPI
public class ValenceErrorChecker
extends AbstractStructureChecker

A descendant of AtomChecker detecting atoms with invalid valences.

Since:

Marvin 5.3

See Also:

MoleculeGraph.hasValenceError()

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_KEY_TRADITIONAL_N_ALLOWED	This public constant String represents the name of the configuration file property which is responsible for traditional N representation is allowed

Fields inherited from class chemaxon.checkers.AbstractStructureChecker

errorType, propertyChangeSupport

Fields inherited from interface chemaxon.checkers.StructureChecker

PROPERTY_KEY_VALID

Constructor Summary

Constructors

Constructor	Description
ValenceErrorChecker()	Default constructor
ValenceErrorChecker(Map<String,String> params)	Parameterized constructor.

Method Summary

Modifier and Type	Method	Description
protected StructureCheckerResult	check1(Molecule molecule)	This method contains the current checking mechanism.
boolean	isAllowTraditionalNitrogen()	Gets whether the checker allows traditional N representation
void	setAllowTraditionalNitrogen(boolean traditionalNallowed)	Sets if the checker should allow traditional N representation

Methods inherited from class chemaxon.checkers.AbstractStructureChecker

addPropertyChangeListener, addPropertyChangeListener, check, clone, cloneItem, convertResult, equals, expandMolecule, getDescription, getDescriptor, getEditorClassName, getErrorCode, getErrorDescription, getErrorType, getHelpText, getIcon, getLocalMenuName, getName, hashCode, isAvailable, isLicensed, isValid, propertyChange, removePropertyChangeListener, removePropertyChangeListener, setDescription, setHelpText, setIcon, setLicenseEnvironment, setLocalMenuName, setMoreErrorMessage, setName, setNoErrorMessage, setOneErrorMessage, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_KEY_TRADITIONAL_N_ALLOWED

public static final String PROPERTY_KEY_TRADITIONAL_N_ALLOWED

This public constant String represents the name of the configuration file property which is responsible for traditional N representation is allowed

Since:

6.0

See Also:

Constant Field Values

Constructor Detail

ValenceErrorChecker

public ValenceErrorChecker()

Default constructor

ValenceErrorChecker

public ValenceErrorChecker(Map<String,String> params)

Parameterized constructor. If "traditionalNitrogen" parameter is given and its value is "true" traditional representation of N will not be valence error

Parameters:

params - a Map instance which contains String pairs. Key is the name of the parameter.

Method Detail

setAllowTraditionalNitrogen

public void setAllowTraditionalNitrogen(boolean traditionalNallowed)

Sets if the checker should allow traditional N representation

Parameters:

traditionalNallowed - is a boolean instance

Since:

6.0

isAllowTraditionalNitrogen

public boolean isAllowTraditionalNitrogen()

Gets whether the checker allows traditional N representation

Returns:

whether the checker allows traditional N representation

check1

protected StructureCheckerResult check1(Molecule molecule)

Description copied from class: AbstractStructureChecker

This method contains the current checking mechanism.

Specified by:

check1 in class AbstractStructureChecker

Parameters:

molecule - the Molecule instance to be checked for problems

Returns:

a StructureCheckerResult which represents the problem or null if no problem found