edu.cmu.tetradapp.app.SessionNodeConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tetrad-gui Show documentation
The newest version!
///////////////////////////////////////////////////////////////////////////////
// For information as to what this class does, see the Javadoc, below.       //
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,       //
// 2007, 2008, 2009, 2010, 2014, 2015, 2022 by Peter Spirtes, Richard        //
// Scheines, Joseph Ramsey, and Clark Glymour.                               //
//                                                                           //
// This program is free software; you can redistribute it and/or modify      //
// it under the terms of the GNU General Public License as published by      //
// the Free Software Foundation; either version 2 of the License, or         //
// (at your option) any later version.                                       //
//                                                                           //
// This program 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 General Public License for more details.                              //
//                                                                           //
// You should have received a copy of the GNU General Public License         //
// along with this program; if not, write to the Free Software               //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA //
///////////////////////////////////////////////////////////////////////////////

package edu.cmu.tetradapp.app;

import edu.cmu.tetradapp.session.SessionNode;


/**
 * Represents the configuration details for a session node.
 *
 * @author Tyler Gibson
 * @version $Id: $Id
 */
public interface SessionNodeConfig {


    /**
     * getModelConfig.
     *
     * @param model a {@link java.lang.Class} object
     * @return the model config for the model with the given class or null if there isn't one.
     */
    SessionNodeModelConfig getModelConfig(Class model);


    /**
     * getModels.
     *
     * @return all the models for this node.
     */
    Class[] getModels();


    /**
     * getNodeSpecificMessage.
     *
     * @return text to use as a nodeSpecificMessage for the node.
     */
    String getNodeSpecificMessage();


    /**
     * getModelChooserInstance.
     *
     * @param sessionNode - The CessionNode for the getModel node.
     * @return a newly created ModelChooser that should be utilized to select a model. If no chooser was
     * specified then the default chooser will be returned.
     */
    ModelChooser getModelChooserInstance(SessionNode sessionNode);


    /**
     * getSessionDisplayCompInstance.
     *
     * @return a newly created SessionDisplayComp that is used to display the node on the session
     * workbench. If no display component class was specified then a default instance will be used.
     */
    SessionDisplayComp getSessionDisplayCompInstance();


}