/
MDLReader.java
589 lines (540 loc) · 23.1 KB
/
MDLReader.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
/* $Revision$ $Author$ $Date$
*
* Copyright (C) 1997-2007 Christoph Steinbeck <steinbeck@users.sourceforge.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.
* All we ask is that proper credit is given for our work, which includes
* - but is not limited to - adding the above copyright notice to the beginning
* of your source code files, and to any copyright notice that you may distribute
* with programs based on this work.
*
* 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.io;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.StringReader;
import java.util.Iterator;
import javax.vecmath.Point2d;
import javax.vecmath.Point3d;
import org.openscience.cdk.CDKConstants;
import org.openscience.cdk.annotations.TestClass;
import org.openscience.cdk.annotations.TestMethod;
import org.openscience.cdk.config.IsotopeFactory;
import org.openscience.cdk.exception.CDKException;
import org.openscience.cdk.interfaces.IAtom;
import org.openscience.cdk.interfaces.IBond;
import org.openscience.cdk.interfaces.IChemFile;
import org.openscience.cdk.interfaces.IChemModel;
import org.openscience.cdk.interfaces.IChemObject;
import org.openscience.cdk.interfaces.IChemSequence;
import org.openscience.cdk.interfaces.IIsotope;
import org.openscience.cdk.interfaces.IMolecule;
import org.openscience.cdk.interfaces.IMoleculeSet;
import org.openscience.cdk.interfaces.IPseudoAtom;
import org.openscience.cdk.io.formats.IResourceFormat;
import org.openscience.cdk.io.formats.MDLFormat;
import org.openscience.cdk.io.setting.BooleanIOSetting;
import org.openscience.cdk.io.setting.IOSetting;
import org.openscience.cdk.tools.ILoggingTool;
import org.openscience.cdk.tools.LoggingToolFactory;
/**
* Reads a molecule from the original MDL MOL or SDF file {@cdk.cite DAL92}. An SD files
* is read into a {@link IChemSequence} of {@link IChemModel}'s. Each ChemModel will contain one
* Molecule. If the MDL molfile contains a property block, the {@link MDLV2000Reader} should be
* used.
*
* <p>If all z coordinates are 0.0, then the xy coordinates are taken as
* 2D, otherwise the coordinates are read as 3D.
*
* <p>The title of the MOL file is read and can be retrieved with:
* <pre>
* molecule.getProperty(CDKConstants.TITLE);
* </pre>
*
* @cdk.module io
* @cdk.githash
*
* @author steinbeck
* @author Egon Willighagen
* @cdk.created 2000-10-02
* @cdk.keyword file format, MDL molfile
* @cdk.keyword file format, SDF
*
* @see org.openscience.cdk.io.MDLV2000Reader
*/
@TestClass("org.openscience.cdk.io.MDLReaderTest")
public class MDLReader extends DefaultChemObjectReader {
BufferedReader input = null;
private static ILoggingTool logger =
LoggingToolFactory.createLoggingTool(MDLReader.class);
private BooleanIOSetting forceReadAs3DCoords;
public MDLReader() {
this(new StringReader(""));
}
/**
* Constructs a new MDLReader that can read Molecule from a given InputStream.
*
*@param in The InputStream to read from
*/
public MDLReader(InputStream in) {
this(in, Mode.RELAXED);
}
public MDLReader(InputStream in, Mode mode) {
this(new InputStreamReader(in));
super.mode = mode;
}
/**
* Constructs a new MDLReader that can read Molecule from a given Reader.
*
* @param in The Reader to read from
*/
public MDLReader(Reader in) {
this(in, Mode.RELAXED);
}
public MDLReader(Reader in, Mode mode) {
super.mode = mode;
input = new BufferedReader(in);
initIOSettings();
}
@TestMethod("testGetFormat")
public IResourceFormat getFormat() {
return MDLFormat.getInstance();
}
@TestMethod("testSetReader_Reader")
public void setReader(Reader input) throws CDKException {
if (input instanceof BufferedReader) {
this.input = (BufferedReader)input;
} else {
this.input = new BufferedReader(input);
}
}
@TestMethod("testSetReader_InputStream")
public void setReader(InputStream input) throws CDKException {
setReader(new InputStreamReader(input));
}
@TestMethod("testAccepts")
public boolean accepts(Class classObject) {
Class[] interfaces = classObject.getInterfaces();
for (int i=0; i<interfaces.length; i++) {
if (IChemFile.class.equals(interfaces[i])) return true;
if (IChemModel.class.equals(interfaces[i])) return true;
if (IMolecule.class.equals(interfaces[i])) return true;
}
Class superClass = classObject.getSuperclass();
if (superClass != null) return this.accepts(superClass);
return false;
}
/**
* Takes an object which subclasses IChemObject, e.g. Molecule, and will read
* this (from file, database, internet etc). If the specific implementation
* does not support a specific IChemObject it will throw an Exception.
*
*@param object The object that subclasses
* IChemObject
*@return The IChemObject read
*@exception CDKException
*/
public IChemObject read(IChemObject object) throws CDKException {
if (object instanceof IChemFile) {
return readChemFile((IChemFile)object);
} else if (object instanceof IChemModel) {
return readChemModel((IChemModel)object);
} else if (object instanceof IMolecule) {
return readMolecule((IMolecule)object);
} else {
throw new CDKException("Only supported are ChemFile and Molecule.");
}
}
private IChemModel readChemModel(IChemModel chemModel) throws CDKException {
IMoleculeSet setOfMolecules = chemModel.getMoleculeSet();
if (setOfMolecules == null) {
setOfMolecules = chemModel.getBuilder().newMoleculeSet();
}
IMolecule m = readMolecule(chemModel.getBuilder().newMolecule());
if (m != null) {
setOfMolecules.addMolecule(m);
}
chemModel.setMoleculeSet(setOfMolecules);
return chemModel;
}
/**
* Read a ChemFile from a file in MDL SDF format.
*
* @return The ChemFile that was read from the MDL file.
*/
private IChemFile readChemFile(IChemFile chemFile) throws CDKException {
IChemSequence chemSequence = chemFile.getBuilder().newChemSequence();
IChemModel chemModel = chemFile.getBuilder().newChemModel();
IMoleculeSet setOfMolecules = chemFile.getBuilder().newMoleculeSet();
IMolecule m = readMolecule(chemFile.getBuilder().newMolecule());
if (m != null) {
setOfMolecules.addMolecule(m);
}
chemModel.setMoleculeSet(setOfMolecules);
chemSequence.addChemModel(chemModel);
setOfMolecules = chemFile.getBuilder().newMoleculeSet();
chemModel = chemFile.getBuilder().newChemModel();
String str;
try {
String line;
while ((line = input.readLine()) != null) {
logger.debug("line: ", line);
// apparently, this is a SDF file, continue with
// reading mol files
str = new String(line);
if (str.equals("$$$$")) {
m = readMolecule(chemFile.getBuilder().newMolecule());
if (m != null) {
setOfMolecules.addMolecule(m);
chemModel.setMoleculeSet(setOfMolecules);
chemSequence.addChemModel(chemModel);
setOfMolecules = chemFile.getBuilder().newMoleculeSet();
chemModel = chemFile.getBuilder().newChemModel();
}
} else {
// here the stuff between 'M END' and '$$$$'
if (m != null) {
// ok, the first lines should start with '>'
String fieldName = null;
if (str.startsWith("> ")) {
// ok, should extract the field name
str.substring(2); // String content =
int index = str.indexOf("<");
if (index != -1) {
int index2 = str.substring(index).indexOf(">");
if (index2 != -1) {
fieldName = str.substring(
index+1,
index+index2
);
}
}
// end skip all other lines
while ((line = input.readLine()) != null && line.startsWith(">")) {
logger.debug("data header line: ", line);
}
}
if (line == null) {
throw new CDKException("Expecting data line here, but found null!");
}
String data = line;
while ((line = input.readLine()) != null &&
line.trim().length() > 0) {
if (line.equals("$$$$")) {
logger.error("Expecting data line here, but found end of molecule: ", line);
break;
}
logger.debug("data line: ", line);
data += line;
// preserve newlines, unless the line is exactly 80 chars; in that case it
// is assumed to continue on the next line. See MDL documentation.
if (line.length() < 80) data += System.getProperty("line.separator");
}
if (fieldName != null) {
logger.info("fieldName, data: ", fieldName, ", ", data);
m.setProperty(fieldName, data);
}
}
}
}
} catch (CDKException cdkexc) {
throw cdkexc;
} catch (Exception exception) {
String error = "Error while parsing SDF";
logger.error(error);
logger.debug(exception);
throw new CDKException(error, exception);
}
try {
input.close();
} catch (Exception exc) {
String error = "Error while closing file: " + exc.getMessage();
logger.error(error);
throw new CDKException(error, exc);
}
chemFile.addChemSequence(chemSequence);
return chemFile;
}
/**
* Read a Molecule from a file in MDL sd format
*
*@return The Molecule that was read from the MDL file.
*/
private IMolecule readMolecule(IMolecule molecule) throws CDKException {
logger.debug("Reading new molecule");
int linecount = 0;
int atoms = 0;
int bonds = 0;
int atom1 = 0;
int atom2 = 0;
int order = 0;
IBond.Stereo stereo = (IBond.Stereo)CDKConstants.UNSET;
int RGroupCounter=1;
int Rnumber=0;
String [] rGroup=null;
double x = 0.0;
double y = 0.0;
double z = 0.0;
double totalX = 0.0;
double totalY = 0.0;
double totalZ = 0.0;
//int[][] conMat = new int[0][0];
//String help;
IAtom atom;
String line = "";
try {
IsotopeFactory isotopeFactory = IsotopeFactory.getInstance(molecule.getBuilder());
logger.info("Reading header");
line = input.readLine(); linecount++;
if (line == null) {
return null;
}
logger.debug("Line " + linecount + ": " + line);
if (line.startsWith("$$$$")) {
logger.debug("File is empty, returning empty molecule");
return molecule;
}
if (line.length() > 0) {
molecule.setProperty(CDKConstants.TITLE, line);
}
line = input.readLine(); linecount++;
logger.debug("Line " + linecount + ": " + line);
line = input.readLine(); linecount++;
logger.debug("Line " + linecount + ": " + line);
if (line.length() > 0) {
molecule.setProperty(CDKConstants.REMARK, line);
}
logger.info("Reading rest of file");
line = input.readLine(); linecount++;
logger.debug("Line " + linecount + ": " + line);
if (mode == Mode.STRICT) {
if (line.contains("V2000") || line.contains("v2000")) {
throw new CDKException("This file must be read with the MDLV2000Reader.");
}
if (line.contains("V3000") || line.contains("v3000")) {
throw new CDKException("This file must be read with the MDLV3000Reader.");
}
}
atoms = Integer.valueOf(line.substring(0,3).trim()).intValue();
logger.debug("Atomcount: " + atoms);
bonds = Integer.valueOf(line.substring(3,6).trim()).intValue();
logger.debug("Bondcount: " + bonds);
// read ATOM block
logger.info("Reading atom block");
for (int f = 0; f < atoms; f++) {
line = input.readLine(); linecount++;
x = new Double(line.substring( 0,10).trim()).doubleValue();
y = new Double(line.substring(10,20).trim()).doubleValue();
z = new Double(line.substring(20,30).trim()).doubleValue();
// *all* values should be zero, not just the sum
totalX += Math.abs(x);
totalY += Math.abs(y);
totalZ += Math.abs(z);
logger.debug("Coordinates: " + x + "; " + y + "; " + z);
String element = line.substring(31,34).trim();
logger.debug("Atom type: ", element);
if (isotopeFactory.isElement(element)) {
atom = isotopeFactory.configure(molecule.getBuilder().newAtom(element));
} else if ("A".equals(element)) {
atom = molecule.getBuilder().newPseudoAtom(element);
} else if ("Q".equals(element)) {
atom = molecule.getBuilder().newPseudoAtom(element);
} else if ("*".equals(element)) {
atom = molecule.getBuilder().newPseudoAtom(element);
} else if ("LP".equals(element)) {
atom = molecule.getBuilder().newPseudoAtom(element);
} else if ("L".equals(element)) {
atom = molecule.getBuilder().newPseudoAtom(element);
} else if (element.length() > 0 && element.charAt(0) == 'R'){
logger.debug("Atom ", element, " is not an regular element. Creating a PseudoAtom.");
//check if the element is R
rGroup=element.split("^R");
if (rGroup.length >1){
try{
Rnumber=Integer.parseInt(rGroup[(rGroup.length-1)]);
RGroupCounter=Rnumber;
}catch(Exception ex){
Rnumber=RGroupCounter;
RGroupCounter++;
}
element="R"+Rnumber;
}
atom = molecule.getBuilder().newPseudoAtom(element);
} else {
if (mode == ISimpleChemObjectReader.Mode.STRICT) {
throw new CDKException("Invalid element type. Must be an existing element, or one in: A, Q, L, LP, *.");
}
atom = molecule.getBuilder().newPseudoAtom(element);
}
// store as 3D for now, convert to 2D (if totalZ == 0.0) later
atom.setPoint3d(new Point3d(x, y, z));
// parse further fields
String massDiffString = line.substring(34,36).trim();
logger.debug("Mass difference: ", massDiffString);
if (!(atom instanceof IPseudoAtom)) {
try {
int massDiff = Integer.parseInt(massDiffString);
if (massDiff != 0) {
IIsotope major = IsotopeFactory.getInstance(molecule.getBuilder()).getMajorIsotope(element);
atom.setAtomicNumber(major.getAtomicNumber() + massDiff);
}
} catch (Exception exception) {
logger.error("Could not parse mass difference field");
}
} else {
logger.error("Cannot set mass difference for a non-element!");
}
String chargeCodeString = line.substring(36,39).trim();
logger.debug("Atom charge code: ", chargeCodeString);
int chargeCode = Integer.parseInt(chargeCodeString);
if (chargeCode == 0) {
// uncharged species
} else if (chargeCode == 1) {
atom.setFormalCharge(+3);
} else if (chargeCode == 2) {
atom.setFormalCharge(+2);
} else if (chargeCode == 3) {
atom.setFormalCharge(+1);
} else if (chargeCode == 4) {
} else if (chargeCode == 5) {
atom.setFormalCharge(-1);
} else if (chargeCode == 6) {
atom.setFormalCharge(-2);
} else if (chargeCode == 7) {
atom.setFormalCharge(-3);
}
try {
// read the mmm field as position 61-63
String reactionAtomIDString = line.substring(60,63).trim();
logger.debug("Parsing mapping id: ", reactionAtomIDString);
try {
int reactionAtomID = Integer.parseInt(reactionAtomIDString);
if (reactionAtomID != 0) {
atom.setID(reactionAtomIDString);
}
} catch (Exception exception) {
logger.error("Mapping number ", reactionAtomIDString, " is not an integer.");
logger.debug(exception);
}
} catch (Exception exception) {
// older mol files don't have all these fields...
logger.warn("A few fields are missing. Older MDL MOL file?");
}
//shk3: This reads shifts from after the molecule. I don't think this is an official format, but I saw it frequently 80=>78 for alk
if(line.length()>=78){
double shift=Double.parseDouble(line.substring(69,80).trim());
atom.setProperty("first shift",new Double(shift));
}
if(line.length()>=87){
double shift=Double.parseDouble(line.substring(79,87).trim());
atom.setProperty("second shift",new Double(shift));
}
molecule.addAtom(atom);
}
// convert to 2D, if totalZ == 0
if (totalX == 0.0 && totalY == 0.0 && totalZ == 0.0) {
logger.info("All coordinates are 0.0");
for (IAtom atomToUpdate : molecule.atoms()) {
atomToUpdate.setPoint3d(null);
}
} else if (totalZ == 0.0 && !forceReadAs3DCoords.isSet()) {
logger.info("Total 3D Z is 0.0, interpreting it as a 2D structure");
Iterator<IAtom> atomsToUpdate = molecule.atoms().iterator();
while (atomsToUpdate.hasNext()) {
IAtom atomToUpdate = (IAtom)atomsToUpdate.next();
Point3d p3d = atomToUpdate.getPoint3d();
atomToUpdate.setPoint2d(new Point2d(p3d.x, p3d.y));
atomToUpdate.setPoint3d(null);
}
}
// read BOND block
logger.info("Reading bond block");
for (int f = 0; f < bonds; f++) {
line = input.readLine(); linecount++;
atom1 = java.lang.Integer.valueOf(line.substring(0,3).trim()).intValue();
atom2 = java.lang.Integer.valueOf(line.substring(3,6).trim()).intValue();
order = java.lang.Integer.valueOf(line.substring(6,9).trim()).intValue();
if (line.length() > 12) {
int mdlStereo = Integer.valueOf(line.substring(9,12).trim());
if (mdlStereo == 1) {
// MDL up bond
stereo = IBond.Stereo.UP;
} else if (mdlStereo == 6) {
// MDL down bond
stereo = IBond.Stereo.DOWN;
} else if (mdlStereo == 0) {
// bond has no stereochemistry
stereo = IBond.Stereo.NONE;
} else if (mdlStereo == 4) {
//MDL bond undefined
stereo = (IBond.Stereo)CDKConstants.UNSET;
}
} else {
logger.warn("Missing expected stereo field at line: " + line);
}
if (logger.isDebugEnabled()) {
logger.debug("Bond: " + atom1 + " - " + atom2 + "; order " + order);
}
// interpret CTfile's special bond orders
IAtom a1 = molecule.getAtom(atom1 - 1);
IAtom a2 = molecule.getAtom(atom2 - 1);
IBond newBond = null;
if (order == 1) {
newBond = molecule.getBuilder().newBond(a1, a2, IBond.Order.SINGLE, stereo);
} else if (order == 2) {
newBond = molecule.getBuilder().newBond(a1, a2, IBond.Order.DOUBLE, stereo);
} else if (order == 3) {
newBond = molecule.getBuilder().newBond(a1, a2, IBond.Order.TRIPLE, stereo);
} else if (order == 4) {
// aromatic bond
newBond = molecule.getBuilder().newBond(a1, a2, IBond.Order.SINGLE, stereo);
// mark both atoms and the bond as aromatic
newBond.setFlag(CDKConstants.ISAROMATIC, true);
a1.setFlag(CDKConstants.ISAROMATIC, true);
a2.setFlag(CDKConstants.ISAROMATIC, true);
}
molecule.addBond(newBond);
}
} catch (Exception exception) {
exception.printStackTrace();
String error = "Error while parsing line " + linecount + ": " + line + " -> " + exception.getMessage();
logger.error(error);
logger.debug(exception);
throw new CDKException(error, exception);
}
return molecule;
}
@TestMethod("testClose")
public void close() throws IOException {
input.close();
}
private void initIOSettings() {
forceReadAs3DCoords = new BooleanIOSetting("ForceReadAs3DCoordinates", IOSetting.LOW,
"Should coordinates always be read as 3D?",
"false");
}
public void customizeJob() {
fireIOSettingQuestion(forceReadAs3DCoords);
}
public IOSetting[] getIOSettings() {
IOSetting[] settings = new IOSetting[1];
settings[0] = forceReadAs3DCoords;
return settings;
}
}