/*
* $RCSfile$
* $Author$
* $Date$
* $Revision$
*
* Copyright (C) 2008 Miguel Rojas <miguelrojasch@users.sf.net>
*
* 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 java.util.ArrayList;
import java.util.Iterator;
import org.openscience.cdk.CDKConstants;
import org.openscience.cdk.DefaultChemObjectBuilder;
import org.openscience.cdk.Molecule;
import org.openscience.cdk.Ring;
import org.openscience.cdk.annotations.TestClass;
import org.openscience.cdk.annotations.TestMethod;
import org.openscience.cdk.aromaticity.CDKHueckelAromaticityDetector;
import org.openscience.cdk.exception.CDKException;
import org.openscience.cdk.interfaces.IAtom;
import org.openscience.cdk.interfaces.IBond;
import org.openscience.cdk.interfaces.IMolecule;
import org.openscience.cdk.interfaces.IMoleculeSet;
import org.openscience.cdk.interfaces.IReaction;
import org.openscience.cdk.interfaces.IReactionSet;
import org.openscience.cdk.interfaces.IRingSet;
import org.openscience.cdk.reaction.IReactionProcess;
import org.openscience.cdk.reaction.ReactionEngine;
import org.openscience.cdk.reaction.ReactionSpecification;
import org.openscience.cdk.reaction.mechanism.RadicalSiteRearrangementMechanism;
import org.openscience.cdk.reaction.type.parameters.IParameterReact;
import org.openscience.cdk.reaction.type.parameters.SetReactionCenter;
import org.openscience.cdk.ringsearch.AllRingsFinder;
import org.openscience.cdk.tools.HOSECodeGenerator;
import org.openscience.cdk.tools.ILoggingTool;
import org.openscience.cdk.tools.LoggingToolFactory;
import org.openscience.cdk.tools.manipulator.AtomContainerManipulator;
/**
* <p>
* This reaction could be represented as [A*]-C1-C2-C3[H] => A([H])-C1-C2-[C3*]. Due to
* the single electron of atom A the proton is moved.</p>
* <p>It is processed by the RadicalSiteRearrangementMechanism class</p>
*
* <pre>
* IMoleculeSet setOfReactants = DefaultChemObjectBuilder.getInstance().newMoleculeSet();
* setOfReactants.addMolecule(new Molecule());
* IReactionProcess type = new RadicalSiteHrGammaReaction();
* 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 possible reactive center.</p>
* <p>The rearrangements are not possible with the atomtype is inside of a ring</p>
*
* @author Miguel Rojas
*
* @cdk.created 2006-10-20
* @cdk.module reaction
* @cdk.githash
* @cdk.set reaction-types
*
* @see RadicalSiteRearrangementMechanism
**/
@TestClass(value="org.openscience.cdk.reaction.type.RadicalSiteHrGammaReactionTest")
public class RadicalSiteHrGammaReaction extends ReactionEngine implements IReactionProcess{
private static ILoggingTool logger =
LoggingToolFactory.createLoggingTool(RadicalSiteHrGammaReaction.class);
/**
* Constructor of the RadicalSiteHrGammaReaction object
*
*/
public RadicalSiteHrGammaReaction(){
}
/**
* Gets the specification attribute of the RadicalSiteHrGammaReaction object
*
*@return The specification value
*/
@TestMethod("testGetSpecification")
public ReactionSpecification getSpecification() {
return new ReactionSpecification(
"http://almost.cubic.uni-koeln.de/jrg/Members/mrc/reactionDict/reactionDict#RadicalSiteHrGamma",
this.getClass().getName(),
"$Id$",
"The Chemistry Development Kit");
}
/**
* 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
*/
@TestMethod("testInitiate_IMoleculeSet_IMoleculeSet")
public IReactionSet initiate(IMoleculeSet reactants, IMoleculeSet agents) throws CDKException{
logger.debug("initiate reaction: RadicalSiteHrGammaReaction");
if (reactants.getMoleculeCount() != 1) {
throw new CDKException("RadicalSiteHrGammaReaction only expects one reactant");
}
if (agents != null) {
throw new CDKException("RadicalSiteHrGammaReaction don't expects agents");
}
IReactionSet setOfReactions = DefaultChemObjectBuilder.getInstance().newReactionSet();
IMolecule reactant = reactants.getMolecule(0);
AtomContainerManipulator.percieveAtomTypesAndConfigureAtoms(reactant);
CDKHueckelAromaticityDetector.detectAromaticity(reactant);
AllRingsFinder arf = new AllRingsFinder();
IRingSet ringSet = arf.findAllRings((Molecule) reactant);
for (int ir = 0; ir < ringSet.getAtomContainerCount(); ir++) {
Ring ring = (Ring)ringSet.getAtomContainer(ir);
for (int jr = 0; jr < ring.getAtomCount(); jr++) {
IAtom aring = ring.getAtom(jr);
aring.setFlag(CDKConstants.ISINRING, true);
}
}
/* if the parameter hasActiveCenter is not fixed yet, set the active centers*/
IParameterReact ipr = super.getParameterClass(SetReactionCenter.class);
if( ipr != null && !ipr.isSetParameter())
setActiveCenters(reactant);
HOSECodeGenerator hcg = new HOSECodeGenerator();
Iterator<IAtom> atomis = reactant.atoms().iterator();
while(atomis.hasNext()){
IAtom atomi = atomis.next();
if(atomi.getFlag(CDKConstants.REACTIVE_CENTER) && atomi.getSymbol().equals("C")
&& reactant.getConnectedSingleElectronsCount(atomi) == 1) {
hcg.getSpheres((Molecule) reactant, atomi, 4, true);
Iterator<IAtom> atomls = hcg.getNodesInSphere(4).iterator();
while(atomls.hasNext()){
IAtom atoml = atomls.next();
if(atoml != null && atoml.getFlag(CDKConstants.REACTIVE_CENTER) && !atoml.getFlag(CDKConstants.ISINRING) &&
(atoml.getFormalCharge() == CDKConstants.UNSET ? 0 : atoml.getFormalCharge()) == 0 && !atoml.equals("H") &&
reactant.getMaximumBondOrder(atoml) == IBond.Order.SINGLE){
Iterator<IAtom> atomhs = reactant.getConnectedAtomsList(atoml).iterator();
while(atomhs.hasNext()){
IAtom atomh = atomhs.next();
if( reactant.getBond(atomh, atoml).getFlag(CDKConstants.REACTIVE_CENTER) &&
atomh.getFlag(CDKConstants.REACTIVE_CENTER) && atomh.getSymbol().equals("H")){
ArrayList<IAtom> atomList = new ArrayList<IAtom>();
atomList.add(atomh);
atomList.add(atomi);
atomList.add(atoml);
ArrayList<IBond> bondList = new ArrayList<IBond>();
bondList.add(reactant.getBond(atomh, atoml));
IMoleculeSet moleculeSet = reactant.getBuilder().newMoleculeSet();
moleculeSet.addMolecule(reactant);
IReaction reaction = mechanism.initiate(moleculeSet, atomList, bondList);
if(reaction == null)
continue;
else
setOfReactions.addReaction(reaction);
}
}
}
}
}
}
return setOfReactions;
}
/**
* set the active center for this molecule.
* The active center will be those which correspond with [A*]=B.
* <pre>
* C: Atom with single electron
* C3: Atom with Hydrogen
* </pre>
*
* @param reactant The molecule to set the activity
* @throws CDKException
*/
private void setActiveCenters(IMolecule reactant) throws CDKException {
HOSECodeGenerator hcg = new HOSECodeGenerator();
Iterator<IAtom> atomis = reactant.atoms().iterator();
while(atomis.hasNext()){
IAtom atomi = atomis.next();
if(atomi.getSymbol().equals("C")
&& reactant.getConnectedSingleElectronsCount(atomi) == 1) {
hcg.getSpheres((Molecule) reactant, atomi, 4, true);
Iterator<IAtom> atomls = hcg.getNodesInSphere(4).iterator();
while(atomls.hasNext()){
IAtom atoml = atomls.next();
if(atoml != null && !atoml.getFlag(CDKConstants.ISINRING) &&
(atoml.getFormalCharge() == CDKConstants.UNSET ? 0 : atoml.getFormalCharge()) == 0 && !atoml.equals("H") &&
reactant.getMaximumBondOrder(atoml) == IBond.Order.SINGLE){
Iterator<IAtom> atomhs = reactant.getConnectedAtomsList(atoml).iterator();
while(atomhs.hasNext()){
IAtom atomh = atomhs.next();
if(atomh.getSymbol().equals("H")){
atomi.setFlag(CDKConstants.REACTIVE_CENTER,true);
atoml.setFlag(CDKConstants.REACTIVE_CENTER,true);
atomh.setFlag(CDKConstants.REACTIVE_CENTER,true);
reactant.getBond(atomh, atoml).setFlag(CDKConstants.REACTIVE_CENTER,true);
}
}
}
}
}
}
}
}