/*
 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.engine.stub;

import java.util.Map;

import com.jstatcom.engine.ConfigHolder;
import com.jstatcom.engine.ConfigKeys;
import com.jstatcom.engine.Engine;
import com.jstatcom.engine.EngineTypes;

/**
 * StubEngineType holds information about the
 * StubEngine It is a Singleton.
 * 
 * @author Markus Kraetzig 
 */
public final class StubEngineType extends EngineTypes {
    /**
     * To enforce the Singleton property of this class.
     */
    public static final StubEngineType INSTANCE = new StubEngineType("STUB");

    private StubEngine stubEngine = null;

    /**
     * Create a StubEngineType.
     * 
     * @param name
     *            the name of the type
     */
    private StubEngineType(String name) {
        super(name);
    }

    /*
     * @see com.jstatcom.engine.EngineTypes#checkSettings(com.jstatcom.engine.ConfigHolder)
     */
    public String checkSettings(ConfigHolder configHolder) {
        return null;
    }

    /*
     * @see com.jstatcom.engine.EngineTypes#getConfigKeys()
     */
    public Map getConfigKeys() {
        return null;
    }

    /*
     * @see com.jstatcom.engine.EngineTypes#getEngine()
     */
    public Engine getEngine() {
        if (stubEngine == null) {
            try {
                stubEngine = StubEngine.getInstance();
            } catch (Throwable ex) {
                throw new RuntimeException(
                        "The Stub engine could not be initialized\ndue to the following error:\n\n"
                                + ex.getMessage() + "\n");
            }
        }
        addLoadedEngine(stubEngine);

        return stubEngine;

    }

}