/*
 This file is part of the software framework JStatCom, 
 a library for building applications for data based analysis.

 Copyright (C) 2000-2005  Markus Kraetzig

 This library 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.

 This library 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 library; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 USA
 */

package com.jstatcom.io;

import java.awt.Container;
import java.io.File;

import javax.swing.JInternalFrame;
import javax.swing.JPanel;

/**
 * Abstract panel for import data functionality. The implementation depends on
 * the type of dataset to read in.
 * 
 * @author Markus Kraetzig 
 */
public abstract class AbstractImportPanel extends JPanel {

    private Container parent = null;

    /**
     * Gets the parent JInternalFrame of this panel.
     * 
     * @return the parent frame or null if no parent frame could
     *         be found
     */
    protected Container getParentFrame() {
        if (parent != null)
            return parent;

        Container comp = this;
        while (comp.getParent() != null) {
            comp = comp.getParent();
            if (comp instanceof JInternalFrame)
                parent = comp;

        }
        return parent;
    }

    /**
     * Initiates data import. Must be implemented by concrete subclasses to
     * browse for a file and initiate parsing.
     * 
     * @return true if import was successful
     */
    public abstract boolean importData();

    /**
     * Invokes data import from the file given as argument.
     * 
     * @param importFile
     *            the file to read data from
     * @return true if import was successful
     */
    public abstract boolean importData(File importFile);
}