org.openscience.cdk.atomtype
Class CDKAtomTypeMatcher

java.lang.Object
  org.openscience.cdk.atomtype.CDKAtomTypeMatcher

All Implemented Interfaces:

IAtomTypeMatcher

@TestClass(value="org.openscience.cdk.atomtype.CDKAtomTypeMatcherTest")
public class CDKAtomTypeMatcher
extends Object
implements IAtomTypeMatcher

Atom Type matcher that perceives atom types as defined in the CDK atom type list org/openscience/cdk/dict/data/cdk-atom-types.owl. If there is not an atom type defined for the tested atom, then NULL is returned.

Author:

egonw

Created on:

2007-07-20

Belongs to CDK module:

core

This class is affected by these bug(s):

1802998

Source code:

cdk-1.4.x

Field Summary

static int	REQUIRE_EXPLICIT_HYDROGENS
static int	REQUIRE_NOTHING

Method Summary

IAtomType[]	findMatchingAtomType(IAtomContainer atomContainer) Method that assigns atom types to atoms in the given atom container.
IAtomType	findMatchingAtomType(IAtomContainer atomContainer, IAtom atom) Method that assigns an atom type to a given atom belonging to an atom container.
static CDKAtomTypeMatcher	getInstance(IChemObjectBuilder builder)
static CDKAtomTypeMatcher	getInstance(IChemObjectBuilder builder, int mode)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REQUIRE_NOTHING

public static final int REQUIRE_NOTHING

See Also:

Constant Field Values

REQUIRE_EXPLICIT_HYDROGENS

public static final int REQUIRE_EXPLICIT_HYDROGENS

See Also:

Constant Field Values

Method Detail

getInstance

@TestMethod(value="testGetInstance_IChemObjectBuilder")
public static CDKAtomTypeMatcher getInstance(IChemObjectBuilder builder)

getInstance

@TestMethod(value="testGetInstance_IChemObjectBuilder_int")
public static CDKAtomTypeMatcher getInstance(IChemObjectBuilder builder,
                                                             int mode)

findMatchingAtomType

@TestMethod(value="testFindMatchingAtomType_IAtomContainer")
public IAtomType[] findMatchingAtomType(IAtomContainer atomContainer)
                                 throws CDKException

Description copied from interface: IAtomTypeMatcher

Method that assigns atom types to atoms in the given atom container.

Specified by:

findMatchingAtomType in interface IAtomTypeMatcher

Parameters:

atomContainer - AtomContainer for which atom types are perceived

Returns:

The matching AtomType

Throws:

CDKException - when something went wrong with going through the AtomType's

findMatchingAtomType

@TestMethod(value="testFindMatchingAtomType_IAtomContainer_IAtom")
public IAtomType findMatchingAtomType(IAtomContainer atomContainer,
                                                      IAtom atom)
                               throws CDKException

Description copied from interface: IAtomTypeMatcher

Method that assigns an atom type to a given atom belonging to an atom container.

Specified by:

findMatchingAtomType in interface IAtomTypeMatcher

Parameters:

atomContainer - AtomContainer of which the atom is part

atom - Atom for which a matching atom type is searched

Returns:

The matching AtomType

Throws:

CDKException - when something went wrong with going through the AtomType's