/*
!=======================================================================
!
!  PROGRAM  PHASE-Viewer  (PHASE-Viewer 2014.01 ver.3.3.0)
!
!  Created on 2006/01/19, 18:53
!  AUTHOR(S): KOGA, Junichiro
!  File : Importer.java
!  
!  Contact address :  Phase System Consortium
!                     E-mail: phase_system@nims.go.jp URL https://azuma.nims.go.jp
!
!
!   Since 2002, this program set had been intensively developed as a part of the following 
!  national projects supported by the Ministry of Education, Culture, Sports, Science and
!  Technology (MEXT) of Japan; "Frontier Simulation Software for Industrial Science
!  (FSIS)" from 2002 to 2005, "Revolutionary Simulation Software (RSS21)" from 2006 to
!  2008. "Research and Development of Innovative Simulation Software (RISS)" from 2008
!  to 2013. These projects is lead by the Center for Research on Innovative Simulation 
!  Software (CISS), the Institute of Industrial Science (IIS), the University of Tokyo.
!   Since 2013, this program set has been further developed centering on PHASE System
!  Consortium. 
!   The activity of development of this program set has been supervised by Takahisa Ohno.
!
!=======================================================================
 */

package ciss.phase_viewer.atomcoord.io;

import ciss.phase_viewer.atomcoord.AtomCoords;

/**
 * 原子配置をインポートするクラスが実装すべきインターフェース.
 * 
 * @author
 */
public interface Importer extends AtomCoordsIO {
    /**
     * 指定のファイルからAtomCoordsオブジェクトをインスタンス化する. AtomCoordsオブジェクトの単位はAngstrom,
     * coordinate systemはCartesianとすること.
     * 
     * @param fileName
     *            ファイル名
     * @return ファイルから作成されたAtomCoordsオブジェクト. 複数フレームの場合を考慮し配列にしている.
     *         失敗したときはnullを返すようにすること.
     */
    public AtomCoords[] getAtomCoordsFrom(String fileName);

    /**
     * ファイル名から, インポート可能か否かを判定; あくまでファイル名からの判定なのでうまく行かないことも考えられる. 基本的には return
     * getFileFilter().accept(new File(fileName)); でよいはずだが, F_DYNMなど厄介なケースもあるので.
     * 
     * @param fileName
     *            対象とするファイルの名前
     */
    public boolean isImportable(String fileName);
}
