View Javadoc
1   // ******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2025.
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 org.apache.commons.io.FilenameUtils;
41  
42  import javax.swing.filechooser.FileFilter;
43  import java.io.BufferedReader;
44  import java.io.File;
45  import java.io.FileReader;
46  
47  import static java.lang.Integer.parseInt;
48  
49  /**
50   * The INTFileFilter class is used to choose TINKER Internal Coordinate (*.INT) files.
51   *
52   * @author Michael J. Schnieders
53   * @since 1.0
54   */
55  public final class INTFileFilter extends FileFilter {
56  
57    /** Default Constructor. */
58    public INTFileFilter() {
59    }
60  
61    /**
62     * This is a static version of the accept method.
63     *
64     * <p>This method return <code>true</code> if the file is a directory or matches the extension for
65     * TINKER internal coordinates (*.INT).
66     *
67     * @param file The File to examine.
68     * @return Returns true if this an INT file.
69     */
70    public static boolean isINT(File file) {
71      return new INTFileFilter().accept(file);
72    }
73  
74    /**
75     * {@inheritDoc}
76     *
77     * <p>This method return <code>true</code> if the file is a directory or matches the extension for
78     * TINKER internal coordinates (*.INT).
79     */
80    @Override
81    public boolean accept(File file) {
82      if (file.isDirectory()) {
83        return true;
84      }
85      String ext = FilenameUtils.getExtension(file.getName());
86      return ext.toUpperCase().startsWith("INT");
87    }
88  
89    /**
90     * acceptDeep
91     *
92     * @param parm a {@link java.io.File} object.
93     * @return a boolean.
94     */
95    public boolean acceptDeep(File parm) {
96      if (parm == null || parm.isDirectory() || !parm.canRead()) {
97        return false;
98      }
99  
100     try (BufferedReader br = new BufferedReader(new FileReader(parm))) {
101       if (!br.ready()) {
102         // Empty File?
103         return false;
104       }
105       // If the first token is not an integer this file is not
106       // an Internal Coordinates File.
107       String rawdata = br.readLine();
108       String[] header = rawdata.trim().split(" +");
109       if (header.length == 0) {
110         return false;
111       }
112       try {
113         parseInt(header[0]);
114       } catch (Exception e) {
115         return false;
116       }
117       // If the first Atom line does not begin with an integer and
118       // contain three tokens, it is not an internal coordinate file.
119       String firstAtom = br.readLine();
120       if (firstAtom == null) {
121         return false;
122       }
123       String[] data = firstAtom.trim().split(" +");
124       if (data.length != 3) {
125         return false;
126       }
127       try {
128         parseInt(data[0]);
129       } catch (Exception e) {
130         return false;
131       }
132       return true;
133     } catch (Exception e) {
134       return true;
135     }
136   }
137 
138   /**
139    * {@inheritDoc}
140    *
141    * <p>Provides a description of the INTFileFilter.
142    */
143   @Override
144   public String getDescription() {
145     return "TINKER Internal Coordinates (*.INT)";
146   }
147 }