001    /**
002     * Copyright (C) 2007-2011, Jens Lehmann
003     *
004     * This file is part of DL-Learner.
005     *
006     * DL-Learner is free software; you can redistribute it and/or modify
007     * it under the terms of the GNU General Public License as published by
008     * the Free Software Foundation; either version 3 of the License, or
009     * (at your option) any later version.
010     *
011     * DL-Learner is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014     * GNU General Public License for more details.
015     *
016     * You should have received a copy of the GNU General Public License
017     * along with this program.  If not, see <http://www.gnu.org/licenses/>.
018     */
019    
020    package org.dllearner.core;
021    
022    /**
023     * Base interface of all components. See also http://dl-learner.org/wiki/Architecture.
024     * 
025     * @author Jens Lehmann
026     *
027     */
028    public interface Component {
029    
030            /**
031             * Method to be called after the component has been configured.
032             * Implementation of components can overwrite this method to
033             * perform setup and initialisation tasks for this component.
034             * 
035             * @throws ComponentInitException This exception is thrown if any
036             * exceptions occur within the initialisation process of this
037             * component. As component developer, you are encouraged to
038             * rethrow occuring exception as ComponentInitException and 
039             * giving an error message as well as the actualy exception by
040             * using the constructor {@link ComponentInitException#ComponentInitException(String, Throwable)}. 
041             */
042            public abstract void init() throws ComponentInitException;
043            
044    }