Logo Search packages:      
Sourcecode: cdk version File versions  Download package

RearrangementCation3Reaction.java

/*
 *  $RCSfile$
 *  $Author: egonw $
 *  $Date: 2006-03-29 10:27:08 +0200 (Wed, 29 Mar 2006) $
 *  $Revision: 5855 $
 *
 *  Copyright (C) 2006-2007  Miguel Rojas <miguel.rojas@uni-koeln.de>
 *
 *  Contact: cdk-devel@lists.sourceforge.net
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2.1
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 */
package org.openscience.cdk.reaction.type;


import org.openscience.cdk.CDKConstants;
import org.openscience.cdk.DefaultChemObjectBuilder;
import org.openscience.cdk.exception.CDKException;
import org.openscience.cdk.interfaces.IAtom;
import org.openscience.cdk.interfaces.IAtomContainer;
import org.openscience.cdk.interfaces.IBond;
import org.openscience.cdk.interfaces.ILonePair;
import org.openscience.cdk.interfaces.IMapping;
import org.openscience.cdk.interfaces.IMolecule;
import org.openscience.cdk.interfaces.IReaction;
import org.openscience.cdk.interfaces.IMoleculeSet;
import org.openscience.cdk.interfaces.IReactionSet;
import org.openscience.cdk.reaction.IReactionProcess;
import org.openscience.cdk.reaction.ReactionSpecification;
import org.openscience.cdk.tools.LoggingTool;
import org.openscience.cdk.tools.manipulator.AtomContainerManipulator;

/**
 * <p>IReactionProcess which participate in movement resonance. 
 * This reaction could be represented as [A+]=B => A|-[B+]. Due to 
 * deficiency of charge of the atom A, the double bond is desplaced to atom A.</p>
 * <p>Make sure that the molecule has the corresponend lone pair electrons
 * for each atom. You can use the method: <pre> LonePairElectronChecker </pre>
 * 
 * <pre>
 *  IMoleculeSet setOfReactants = DefaultChemObjectBuilder.getInstance().newMoleculeSet();
 *  setOfReactants.addMolecule(new Molecule());
 *  IReactionProcess type = new RearrangementCation3Reaction();
 *  Object[] params = {Boolean.FALSE};
    type.setParameters(params);
 *  IReactionSet setOfReactions = type.initiate(setOfReactants, null);
 *  </pre>
 * 
 * <p>We have the possibility to localize the reactive center. Good method if you
 * want to localize the reaction in a fixed point</p>
 * <pre>atoms[0].setFlag(CDKConstants.REACTIVE_CENTER,true);</pre>
 * <p>Moreover you must put the parameter Boolean.TRUE</p>
 * <p>If the reactive center is not localized then the reaction process will
 * try to find automatically the posible reactive center.</p>
 * 
 * 
 * @author         Miguel Rojas
 * 
 * @cdk.created    2006-05-05
 * @cdk.module     reaction
 * @cdk.set        reaction-types
 * 
 **/
00076 public class RearrangementCation3Reaction implements IReactionProcess{
      private LoggingTool logger;
      private boolean hasActiveCenter;
      private static final int BONDTOFLAG1 = 8;

      /**
       * Constructor of the RearrangementCation3Reaction object
       *
       */
00085       public RearrangementCation3Reaction(){
            logger = new LoggingTool(this);
      }
      /**
       *  Gets the specification attribute of the RearrangementCation3Reaction object
       *
       *@return    The specification value
       */
00093       public ReactionSpecification getSpecification() {
            return new ReactionSpecification(
                        "http://almost.cubic.uni-koeln.de/jrg/Members/mrc/reactionDict/reactionDict#RearrangementCation3Reaction",
                        this.getClass().getName(),
                        "$Id: RearrangementCation3Reaction.java,v 1.6 2006/04/01 08:26:47 mrc Exp $",
                        "The Chemistry Development Kit");
      }
      
      /**
       *  Sets the parameters attribute of the RearrangementCation3Reaction object
       *
       *@param  params            The parameter is if the molecule has already fixed the center active or not. It 
       *                                        should be set before to inize the reaction with a setFlag:  CDKConstants.REACTIVE_CENTER
       *@exception  CDKException  Description of the Exception
       */
00108       public void setParameters(Object[] params) throws CDKException {
            if (params.length > 1) {
                  throw new CDKException("RearrangementCation3Reaction only expects one parameter");
            }
            if (!(params[0] instanceof Boolean)) {
                  throw new CDKException("The parameter 1 must be of type boolean");
            }
            hasActiveCenter = ((Boolean) params[0]).booleanValue();
      }


      /**
       *  Gets the parameters attribute of the RearrangementCation3Reaction object
       *
       *@return    The parameters value
       */
00124       public Object[] getParameters() {
            Object[] params = new Object[1];
            params[0] = new Boolean (hasActiveCenter);
            return params;
      }
      
      /**
       *  Initiate process.
       *  It is needed to call the addExplicitHydrogensToSatisfyValency
       *  from the class tools.HydrogenAdder.
       *
       *@param  reactants         reactants of the reaction.
       *@param  agents            agents of the reaction (Must be in this case null).
       *
       *@exception  CDKException  Description of the Exception
       */
00140       public IReactionSet initiate(IMoleculeSet reactants, IMoleculeSet agents) throws CDKException{

            logger.debug("initiate reaction: RearrangementCation3Reaction");
            
            if (reactants.getMoleculeCount() != 1) {
                  throw new CDKException("RearrangementCation3Reaction only expects one reactant");
            }
            if (agents != null) {
                  throw new CDKException("RearrangementCation3Reaction don't expects agents");
            }
            
            IReactionSet setOfReactions = DefaultChemObjectBuilder.getInstance().newReactionSet();
            IMolecule reactant = reactants.getMolecule(0);
            
            /* if the parameter hasActiveCenter is not fixed yet, set the active centers*/
            if(!hasActiveCenter){
                  setActiveCenters(reactant);
            }
            /*control of the volume of number of charge - it will be made possible if
             * if the atoms[i] is the only atom with charge*/
            int negCharge = AtomContainerManipulator.getTotalNegativeFormalCharge((IAtomContainer)reactant);
            int posCharge = AtomContainerManipulator.getTotalPositiveFormalCharge((IAtomContainer)reactant);
            if(posCharge+Math.abs(negCharge) > 1)
                  return setOfReactions;

            IAtom atomi = null;
            IBond bondj = null;
            for(int i = 0 ; i < reactant.getAtomCount() ; i++){
;                 atomi = reactant.getAtom(i);
                  if(atomi.getFlag(CDKConstants.REACTIVE_CENTER) && atomi.getFormalCharge() == 1 ){

                        java.util.List bonds = reactant.getConnectedBondsList(atomi);
                        
                        for(int j = 0 ; j < bonds.size() ; j++){
                              bondj = (IBond)bonds.get(j);
                              if(bondj.getFlag(CDKConstants.REACTIVE_CENTER) && bondj.getOrder() > 1.0){
                                    IAtom atom = bondj.getConnectedAtom(atomi);
                                    if(atom.getFlag(CDKConstants.REACTIVE_CENTER) && atom.getFormalCharge() == 0)
                                          if(reactant.getConnectedSingleElectronsCount(atom) == 0){
                                                
                                                IReaction reaction = DefaultChemObjectBuilder.getInstance().newReaction();
                                                reaction.addReactant(reactant);
                                                
                                                cleanFlagBOND(reactant);
                                                /* positions atoms and bonds */
                                          int atom0P = reactant.getAtomNumber(atomi);
                                          bondj.setFlag(BONDTOFLAG1, true);
                                          int atom1P = reactant.getAtomNumber(atom);
                                          
                                          /* action */
                                          IAtomContainer acCloned;
                                          try {
                                                acCloned = (IAtomContainer)reactant.clone();
                                          } catch (CloneNotSupportedException e) {
                                                throw new CDKException("Could not clone IMolecule!", e);
                                          }
                                                      
                                          ILonePair lp = acCloned.getBuilder().newLonePair(acCloned.getAtom(atom0P));
                                          acCloned.addLonePair(lp);
                                                      
                                          IBond bondjClon = null;
                                          for(int l = 0 ; l<acCloned.getBondCount();l++){
                                                IBond bb = acCloned.getBond(l);
                                                if(bb.getFlag(BONDTOFLAG1)){
                                                      double order = bb.getOrder();
                                                      bb.setOrder(order-1);
                                                      bondjClon = bb;
                                                      break;
                                                }
                                          }
                                          double charge = acCloned.getAtom(atom0P).getFormalCharge();
                                          acCloned.getAtom(atom0P).setFormalCharge((int)charge-1);
      
                                          charge = acCloned.getAtom(atom1P).getFormalCharge();
                                          acCloned.getAtom(atom1P).setFormalCharge((int)charge+1);
                                          
                                          /* mapping */
                                          IMapping mapping = DefaultChemObjectBuilder.getInstance().newMapping(atomi, acCloned.getAtom(atom0P));
                                      reaction.addMapping(mapping);
                                      mapping = DefaultChemObjectBuilder.getInstance().newMapping(atom, acCloned.getAtom(atom1P));
                                      reaction.addMapping(mapping);
                                      mapping = DefaultChemObjectBuilder.getInstance().newMapping(bondj, bondjClon);
                                      reaction.addMapping(mapping);
                                      
                                          reaction.addProduct((IMolecule) acCloned);
                                          setOfReactions.addReaction(reaction);
                                          
                                          bondj.setFlag(BONDTOFLAG1, false);
                                    }
                              }
                        }
                  }
            }
            return setOfReactions;  
            
            
      }
      /**
       * set the active center for this molecule. 
       * The active center will be those which correspond with [A+]=B. 
       * <pre>
       * A: Atom with positive charge
       * =: Double bond
       * B: Atom
       *  </pre>
       * 
       * @param reactant The molecule to set the activity
       * @throws CDKException 
       */
00249       private void setActiveCenters(IMolecule reactant) throws CDKException {
            cleanFlagReactiveCenter(reactant);
            IAtom atomi = null;
            IBond bondj = null;
            for(int i = 0; i < reactant.getAtomCount(); i++) {
                  atomi = reactant.getAtom(i);
                  if((atomi.getFormalCharge() == 1)&& (!atomi.getSymbol().equals("C"))/*Carbon don't acquire charge*/ ){
                        java.util.List bonds = reactant.getConnectedBondsList(atomi);
                        for(int j = 0 ; j < bonds.size() ; j++){
                              bondj = (IBond)bonds.get(j);
                              if(bondj.getOrder() > 1.0){
                                    IAtom atom = bondj.getConnectedAtom(atomi);
                                    if(atom.getFormalCharge() == 0)
                                          if(reactant.getConnectedSingleElectronsCount(atom) == 0){
                                          atomi.setFlag(CDKConstants.REACTIVE_CENTER,true);
                                          bondj.setFlag(CDKConstants.REACTIVE_CENTER,true);
                                          atom.setFlag(CDKConstants.REACTIVE_CENTER,true);
                                    }
                              }
                        }
                  }
            }
      }
      /**
       *  Gets the parameterNames attribute of the RearrangementCation3Reaction object
       *
       *@return    The parameterNames value
       */
00277       public String[] getParameterNames() {
            String[] params = new String[1];
            params[0] = "hasActiveCenter";
            return params;
      }


      /**
       *  Gets the parameterType attribute of the RearrangementCation3Reaction object
       *
       *@param  name  Description of the Parameter
       *@return       The parameterType value
       */
00290       public Object getParameterType(String name) {
            return new Boolean(false);
      }
      /**
     * clean the flags BONDTOFLAG from the molecule
     * 
       * @param mol
       */
00298       public void cleanFlagBOND(IAtomContainer ac){
            for(int j = 0 ; j < ac.getBondCount(); j++){
                  ac.getBond(j).setFlag(BONDTOFLAG1, false);
            }
      }
      /**
     * clean the flags CDKConstants.REACTIVE_CENTER from the molecule
     * 
       * @param mol
       */
00308       public void cleanFlagReactiveCenter(IMolecule molecule){
            for(int j = 0 ; j < molecule.getAtomCount(); j++)
                  molecule.getAtom(j).setFlag(CDKConstants.REACTIVE_CENTER, false);
            for(int j = 0 ; j < molecule.getBondCount(); j++)
                  molecule.getBond(j).setFlag(CDKConstants.REACTIVE_CENTER, false);
      }
}

Generated by  Doxygen 1.6.0   Back to index