1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2024.
6 //
7 // This file is part of Force Field X.
8 //
9 // Force Field X is free software; you can redistribute it and/or modify it
10 // under the terms of the GNU General Public License version 3 as published by
11 // the Free Software Foundation.
12 //
13 // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 // details.
17 //
18 // You should have received a copy of the GNU General Public License along with
19 // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20 // Place, Suite 330, Boston, MA 02111-1307 USA
21 //
22 // Linking this library statically or dynamically with other modules is making a
23 // combined work based on this library. Thus, the terms and conditions of the
24 // GNU General Public License cover the whole combination.
25 //
26 // As a special exception, the copyright holders of this library give you
27 // permission to link this library with independent modules to produce an
28 // executable, regardless of the license terms of these independent modules, and
29 // to copy and distribute the resulting executable under terms of your choice,
30 // provided that you also meet, for each linked independent module, the terms
31 // and conditions of the license of that module. An independent module is a
32 // module which is not derived from or based on this library. If you modify this
33 // library, you may extend this exception to your version of the library, but
34 // you are not obligated to do so. If you do not wish to do so, delete this
35 // exception statement from your version.
36 //
37 // ******************************************************************************
38 package ffx.potential.parsers;
39
40 import java.io.File;
41 import javax.swing.filechooser.FileFilter;
42
43 /**
44 * The CoordinateFileFilter class globally determines if a file is a valid coordinate file (PDB, XYZ,
45 * INT, or ARC formats).
46 *
47 * @author Michael J. Schnieders
48 * @author Jacob M. Litman
49 * @since 1.0
50 */
51 public final class CoordinateFileFilter extends FileFilter {
52
53 /** Public Constructor. */
54 public CoordinateFileFilter() {
55 }
56
57 /**
58 * {@inheritDoc}
59 *
60 * <p>This method returns <code>true</code> if the file is a valid coordinate file (xyz, pdb).
61 */
62 @Override
63 public boolean accept(File file) {
64 XYZFileFilter xyzFileFilter = new XYZFileFilter();
65 if (xyzFileFilter.accept(file)) {
66 return true;
67 }
68 PDBFileFilter pdbFileFilter = new PDBFileFilter();
69 if (pdbFileFilter.accept(file)) {
70 return true;
71 }
72 INTFileFilter intFileFilter = new INTFileFilter();
73 if (intFileFilter.accept(file)) {
74 return true;
75 }
76 ARCFileFilter arcFileFilter = new ARCFileFilter();
77 return arcFileFilter.accept(file);
78 }
79
80 /**
81 * acceptDeep
82 *
83 * @param file a {@link java.io.File} object.
84 * @return Whether a valid coordinate file.
85 */
86 public boolean acceptDeep(File file) {
87 XYZFileFilter xyzFileFilter = new XYZFileFilter();
88 if (xyzFileFilter.acceptDeep(file)) {
89 return true;
90 // ARC is concat of XYZ files, and so will also be handled.
91 }
92 PDBFileFilter pdbFileFilter = new PDBFileFilter();
93 if (pdbFileFilter.acceptDeep(file)) {
94 return true;
95 }
96 INTFileFilter intFileFilter = new INTFileFilter();
97 return intFileFilter.acceptDeep(file);
98 }
99
100 /**
101 * {@inheritDoc}
102 *
103 * <p>Provides a description of the CoordinateFileFilter.
104 */
105 @Override
106 public String getDescription() {
107 return "Protein Databank (*.PDB), TINKER Cartesian Coordinates (*.XYZ),"
108 + " TINKER Internal Coordinates (*.INT), or TINKER Archive (*.ARC)";
109 }
110 }