chemaxon.checkers

Class AtomTypeChecker

java.lang.Object

chemaxon.checkers.AbstractStructureChecker

chemaxon.checkers.ComponentChecker<MolAtom>

chemaxon.checkers.AtomChecker

chemaxon.checkers.AtomTypeChecker

All Implemented Interfaces:

StructureChecker, chemaxon.license.Licensable, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

RareElementChecker

@PublicAPI
public class AtomTypeChecker
extends AtomChecker

A descendant of AtomChecker checking different atom types (represented by atom's symbol) in the molecule.

Since:

Marvin 5.4

Version:

5.7

Author:

Attila Szabo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_KEY_TYPES Types property
protected java.util.List<java.lang.String>	types A List of String which represents the types should be checked in the molecule

Fields inherited from class chemaxon.checkers.AbstractStructureChecker

errorType, propertyChangeSupport

Fields inherited from interface chemaxon.checkers.StructureChecker

PROPERTY_KEY_VALID

Constructor Summary

Constructors

Modifier	Constructor and Description
	AtomTypeChecker() Default constructor.
	AtomTypeChecker(java.util.Map<java.lang.String,java.lang.String> params) Parameterized constructor.
protected	AtomTypeChecker(StructureCheckerErrorType type) Parameterized constructor providing the possibility for descendants to initialize with their own error type.

Method Summary

Modifier and Type	Method and Description
protected boolean	check(Molecule molecule, MolAtom component) Checks if the component with index i has problem
java.util.List<java.lang.String>	getTypes() Returns the checked atom types
void	setTypes(java.util.List<java.lang.String> types) Sets the checked atom types

Methods inherited from class chemaxon.checkers.AtomChecker

createResult, getComponent, getComponentCount

Methods inherited from class chemaxon.checkers.ComponentChecker

check1, initialize

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_TYPES

public static final java.lang.String PROPERTY_KEY_TYPES

Types property

See Also:

Constant Field Values

types

protected java.util.List<java.lang.String> types

A List of String which represents the types should be checked in the molecule

Constructor Detail

AtomTypeChecker

protected AtomTypeChecker(StructureCheckerErrorType type)

Parameterized constructor providing the possibility for descendants to initialize with their own error type.

Parameters:

type - is an instance is StructureCheckerErrorType

AtomTypeChecker

public AtomTypeChecker()

Default constructor.

AtomTypeChecker

public AtomTypeChecker(java.util.Map<java.lang.String,java.lang.String> params)

Parameterized constructor. If types parameter is given its value will be parsed and split along "," characters and all substring which represents a type will be search during the checking mechanism.

Parameters:

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

Method Detail

check

protected boolean check(Molecule molecule,
                        MolAtom component)

Description copied from class: ComponentChecker

Checks if the component with index i has problem

Specified by:

check in class ComponentChecker<MolAtom>

Parameters:

molecule - is a Molecule instance

component - the current component to check

Returns:

true if the component has problem, false otherwise

getTypes

public java.util.List<java.lang.String> getTypes()

Returns the checked atom types

Returns:

the checked atom types

Since:

5.7

setTypes

public void setTypes(java.util.List<java.lang.String> types)

Sets the checked atom types

Parameters:

types - the new value

Since:

5.7