org.openscience.cdk.qsar.descriptors.atomic
Class AtomDegreeDescriptor

java.lang.Object
  org.openscience.cdk.qsar.descriptors.atomic.AtomDegreeDescriptor

All Implemented Interfaces:

IAtomicDescriptor, IDescriptor

@TestClass(value="org.openscience.cdk.qsar.descriptors.atomic.AtomDegreeDescriptorTest")
public class AtomDegreeDescriptor
extends Object
implements IAtomicDescriptor

This class returns the number of not-Hs substituents of an atom, also defined as "atom degree".

This descriptor uses these parameters:

Name	Default	Description
		no parameters

Author:

mfe4

Belongs to the set:

qsar-descriptors

Created on:

2004-11-13

Belongs to CDK module:

qsaratomic

Dictionary pointer(s):

atomDegree in the QSAR.sf.net Descriptors Dictionary [qsar-descriptors:atomDegree]

Source code:

cdk-1.4.x

Constructor Summary

AtomDegreeDescriptor()

Method Summary

DescriptorValue	calculate(IAtom atom, IAtomContainer container) This method calculates the number of not-H substituents of an atom.
String[]	getDescriptorNames() Returns an array of names for each descriptor value calculated.
String[]	getParameterNames() Gets the parameterNames attribute of the AtomDegreeDescriptor object.
Object[]	getParameters() Gets the parameters attribute of the AtomDegreeDescriptor object.
Object	getParameterType(String name) Gets the parameterType attribute of the AtomDegreeDescriptor object.
DescriptorSpecification	getSpecification() Returns a IImplementationSpecification which specifies which descriptor is implemented by this class.
void	setParameters(Object[] params) This descriptor does not have any parameter to be set.

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomDegreeDescriptor

public AtomDegreeDescriptor()

Method Detail

getSpecification

@TestMethod(value="testGetSpecification")
public DescriptorSpecification getSpecification()

Description copied from interface: IDescriptor

Returns a IImplementationSpecification which specifies which descriptor is implemented by this class. These fields are used in the map:

• Specification-Reference: refers to an entry in a unique dictionary
• Implementation-Title: anything
• Implementation-Identifier: a unique identifier for this version of this class
• Implementation-Vendor: CDK, JOELib, or anything else

Specified by:

getSpecification in interface IDescriptor

Returns:

An object containing the descriptor specification

setParameters

@TestMethod(value="testSetParameters_arrayObject")
public void setParameters(Object[] params)
                   throws CDKException

This descriptor does not have any parameter to be set.

Specified by:

setParameters in interface IDescriptor

Parameters:

params - An array of Object containing the parameters for this descriptor

Throws:

CDKException - if invalid number of type of parameters are passed to it

See Also:

IDescriptor.getParameters()

getParameters

@TestMethod(value="testGetParameters")
public Object[] getParameters()

Gets the parameters attribute of the AtomDegreeDescriptor object.

Specified by:

getParameters in interface IDescriptor

Returns:

The parameters value

See Also:

setParameters(java.lang.Object[])

getDescriptorNames

@TestMethod(value="testNamesConsistency")
public String[] getDescriptorNames()

Description copied from interface: IDescriptor

Returns an array of names for each descriptor value calculated.

Many descriptors return multiple values. In general it is useful for the descriptor to indicate the names for each value.

In many cases, these names can be as simple as X1, X2, ..., XN where X is a prefix and 1, 2, ..., N are the indices. On the other hand it is also possible to return other arbitrary names, which should be documented in the Javadocs for the decsriptor (e.g., the CPSA descriptor).

Note that by default if a descriptor returns a single value (such as ALOGPDescriptor the return array will have a single element

Specified by:

getDescriptorNames in interface IDescriptor

Returns:

An array of descriptor names, equal in length to the number of descriptor calculated..

calculate

@TestMethod(value="testCalculate_IAtomContainer")
public DescriptorValue calculate(IAtom atom,
                                                 IAtomContainer container)

This method calculates the number of not-H substituents of an atom.

Specified by:

calculate in interface IAtomicDescriptor

Parameters:

atom - The IAtom for which the DescriptorValue is requested

container - The IAtomContainer for which this descriptor is to be calculated for

Returns:

The number of bonds on the shortest path between two atoms

getParameterNames

@TestMethod(value="testGetParameterNames")
public String[] getParameterNames()

Gets the parameterNames attribute of the AtomDegreeDescriptor object.

Specified by:

getParameterNames in interface IDescriptor

Returns:

The parameterNames value

getParameterType

@TestMethod(value="testGetParameterType_String")
public Object getParameterType(String name)

Gets the parameterType attribute of the AtomDegreeDescriptor object.

Specified by:

getParameterType in interface IDescriptor

Parameters:

name - Description of the Parameter

Returns:

An Object of class equal to that of the parameter being requested