View Javadoc

1   package org.molwind.chemical.view;
2   
3   /*
4    * This file is part of Molwind.
5    *
6    * Molwind is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation, either version 3 of the License, or
9    * (at your option) any later version.
10   *
11   * Molwind is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with Molwind. If not, see <http://www.gnu.org/licenses/>.
18   */
19  
20  import java.awt.image.BufferedImage;
21  
22  import org.molwind.chemical.model.ChemicalEntity;
23  import org.openscience.cdk.exception.CDKException;
24  
25  /**
26   * MoleculeRenderer implementations create drawings of molecules.
27   *
28   * @author <a href="mailto:oliver.karch@molwind.org">Oliver Karch</a>
29   * @version 1.0
30   */
31  public interface MoleculeRenderer {
32  
33      /**
34       * Returns a graphical representation of a molecule.
35       *
36       * @param chemicalEntity
37       *      the chemical entity
38       * @return
39       *      a buffered image depicting the molecule
40       * @throws org.openscience.cdk.exception.CDKException
41       *      is thrown upon CDK error
42       */
43      BufferedImage getImage(ChemicalEntity chemicalEntity)
44      throws CDKException;
45  
46  }