Class RuleOfFiveDescriptor

All Implemented Interfaces:
IDescriptor, IMolecularDescriptor

public class RuleOfFiveDescriptor extends AbstractMolecularDescriptor implements IMolecularDescriptor
This Class contains a method that returns the number failures of the Lipinski's Rule Of 5. See
Parameters for this descriptor:
Name Default Description
checkAromaticity false True is the aromaticity has to be checked
Returns a single value named LipinskiFailures.
Dictionary pointer(s):
lipinskifailures in the Descriptors Dictionary [qsar-descriptors:lipinskifailures]
Source code:
Belongs to CDK module:
Lipinski, rule-of-five, descriptor
Created on:
  • Constructor Details

    • RuleOfFiveDescriptor

      public RuleOfFiveDescriptor()
      Constructor for the RuleOfFiveDescriptor object.
  • Method Details

    • getSpecification

      public DescriptorSpecification getSpecification()
      Returns a Map 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
      An object containing the descriptor specification
    • setParameters

      public void setParameters(Object[] params) throws CDKException
      Sets the parameters attribute of the RuleOfFiveDescriptor object. There is only one parameter, which should be a Boolean indicating whether aromaticity should be checked or has already been checked. The name of the paramete is checkAromaticity.
      Specified by:
      setParameters in interface IDescriptor
      params - Parameter is only one: a boolean.
      CDKException - if more than 1 parameter or a non-Boolean parameter is specified
      See Also:
    • getParameters

      public Object[] getParameters()
      Gets the parameters attribute of the RuleOfFiveDescriptor object.
      Specified by:
      getParameters in interface IDescriptor
      The parameters value
      See Also:
    • getDescriptorNames

      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 descriptor (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
      An array of descriptor names, equal in length to the number of descriptor calculated..
    • calculate

      public DescriptorValue calculate(IAtomContainer mol)
      the method take a boolean checkAromaticity: if the boolean is true, it means that aromaticity has to be checked.
      Specified by:
      calculate in interface IMolecularDescriptor
      mol - AtomContainer for which this descriptor is to be calculated
      The number of failures of the Lipinski rule
    • getDescriptorResultType

      public IDescriptorResult getDescriptorResultType()
      Returns the specific type of the DescriptorResult object. The return value from this method really indicates what type of result will be obtained from the DescriptorValue object. Note that the same result can be achieved by interrogating the DescriptorValue object; this method allows you to do the same thing, without actually calculating the descriptor.
      Specified by:
      getDescriptorResultType in interface IMolecularDescriptor
      an object that implements the IDescriptorResult interface indicating the actual type of values returned by the descriptor in the DescriptorValue object
    • getParameterNames

      public String[] getParameterNames()
      Gets the parameterNames attribute of the RuleOfFiveDescriptor object.
      Specified by:
      getParameterNames in interface IDescriptor
      The parameterNames value
    • getParameterType

      public Object getParameterType(String name)
      Gets the parameterType attribute of the RuleOfFiveDescriptor object.
      Specified by:
      getParameterType in interface IDescriptor
      name - The name of the parameter. In this case it is 'checkAromaticity'.
      An Object of class equal to that of the parameter being requested
    • initialise

      public void initialise(IChemObjectBuilder builder)
      Default implementation of initialise allows optional override.
      Specified by:
      initialise in interface IDescriptor
      builder - chem object build